From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/ecd/2020-09-30/api-docs.php | 80985 +++++++++++++------------------ 1 file changed, 34318 insertions(+), 46667 deletions(-) (limited to 'data/en_us/ecd/2020-09-30') diff --git a/data/en_us/ecd/2020-09-30/api-docs.php b/data/en_us/ecd/2020-09-30/api-docs.php index d789418..1e8dad4 100644 --- a/data/en_us/ecd/2020-09-30/api-docs.php +++ b/data/en_us/ecd/2020-09-30/api-docs.php @@ -1,679 +1,260 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ecd', - 'version' => '2020-09-30', - ], + 'info' => ['style' => 'RPC', 'product' => 'ecd', 'version' => '2020-09-30'], 'directories' => [ [ - 'id' => 394528, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - 'DescribeZones', - ], - ], - [ - 'id' => 394531, - 'title' => null, + 'children' => ['DescribeModificationPrice', 'DescribeRefundPrice'], 'type' => 'directory', - 'children' => [ - 'DescribePrice', - 'DescribeRenewalPrice', - 'DescribeModificationPrice', - 'DescribeRefundPrice', - ], + 'title' => 'Price inquiry', ], [ - 'id' => 394536, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 394537, - 'title' => null, + 'children' => ['ListOfficeSiteOverview', 'DescribeOfficeSites', 'ModifyOfficeSiteAttribute', 'DeleteOfficeSites', 'ModifyOfficeSiteDnsInfo', 'CreateOfficeSiteAccelerator', 'DeleteOfficeSiteAccelerator', 'ModifyOfficeSiteAccelerator'], 'type' => 'directory', - 'children' => [ - 'ListOfficeSiteOverview', - 'DescribeOfficeSites', - 'ModifyOfficeSiteAttribute', - 'ModifyOfficeSiteCrossDesktopAccess', - 'DeleteOfficeSites', - 'ModifyOfficeSiteDnsInfo', - ], + 'title' => 'General office network', ], [ - 'id' => 394544, - 'title' => null, + 'children' => ['CreateSimpleOfficeSite'], 'type' => 'directory', - 'children' => [ - 'CreateSimpleOfficeSite', - 'ActivateOfficeSite', - ], + 'title' => 'Convenience account-based office network', ], [ - 'id' => 394547, - 'title' => null, + 'children' => ['CreateADConnectorOfficeSite', 'ListOfficeSiteUsers', 'ModifyOfficeSiteMfaEnabled', 'ConfigADConnectorUser'], 'type' => 'directory', - 'children' => [ - 'CreateADConnectorOfficeSite', - 'ListUserAdOrganizationUnits', - 'ListOfficeSiteUsers', - 'ModifyADConnectorOfficeSite', - 'ModifyOfficeSiteMfaEnabled', - 'ConfigADConnectorTrust', - 'ConfigADConnectorUser', - ], + 'title' => 'Enterprise AD account-based office network', ], ], + 'type' => 'directory', + 'title' => 'Office network (formerly workspace)', ], [ - 'id' => 394555, - 'title' => null, + 'children' => ['ListDirectoryUsers'], 'type' => 'directory', - 'children' => [ - 'CreateADConnectorDirectory', - 'CreateRAMDirectory', - 'DescribeDirectories', - 'ListDirectoryUsers', - 'ModifyADConnectorDirectory', - 'DeleteDirectories', - ], + 'title' => 'Directory', ], [ - 'id' => 394562, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 394563, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'CreateDesktops', - 'CreateDiskEncryptionService', - 'DescribeKmsKeys', - 'DescribeDesktopInfo', - 'DescribeDesktops', - 'DescribeDesktopTypes', - 'DescribeCustomizedListHeaders', - 'ExportDesktopListInfo', - 'StartDesktops', - 'HibernateDesktops', - 'WakeupDesktops', - 'StopDesktops', - 'RebootDesktops', - 'RebuildDesktops', - 'SetDesktopMaintenance', - 'ModifyDesktopName', - 'ModifyDiskSpec', - 'ModifyDesktopChargeType', - 'ModifyDesktopSpec', - 'ModifyDesktopTimer', - 'ModifyDesktopHostName', - 'ModifyCustomizedListHeaders', - 'MigrateDesktops', - 'RenewDesktops', - 'DeleteDesktops', + 'CreateDesktops', 'DescribeKmsKeys', 'DescribeDesktopInfo', 'DescribeDesktops', 'DescribeDesktopTypes', 'DescribeCustomizedListHeaders', 'StartDesktops', 'HibernateDesktops', 'StopDesktops', 'RebootDesktops', 'RebuildDesktops', 'SetDesktopMaintenance', 'ModifyDesktopName', 'ModifyDesktopChargeType', 'ModifyDesktopSpec', 'ModifyDesktopTimer', 'ModifyDesktopHostName', 'MigrateDesktops', 'RenewDesktops', 'DeleteDesktops', 'DescribeDesktopMetadata', ], + 'type' => 'directory', + 'title' => 'Cloud desktop resources', ], [ - 'id' => 394590, - 'title' => null, + 'children' => ['ModifyUserEntitlement', 'BatchModifyEntitlement'], 'type' => 'directory', - 'children' => [ - 'DescribeUsersPassword', - 'GetConnectionTicket', - 'DescribeGuestApplications', - 'ModifyUserEntitlement', - 'ModifyEntitlement', - 'BatchModifyEntitlement', - ], + 'title' => 'Cloud desktop authorized users', ], ], + 'type' => 'directory', + 'title' => 'Cloud desktop', ], [ - 'id' => 394597, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 394598, - 'title' => null, + 'children' => ['CreateDesktopGroup', 'GetDesktopGroupDetail', 'DescribeDesktopGroups', 'ExportDesktopGroupInfo', 'DescribeDesktopsInGroup', 'DisableDesktopsInGroup', 'ModifyDesktopGroup', 'ResetDesktops', 'SetDesktopGroupScaleTimer', 'RenewDesktopGroup', 'DeleteDesktopGroup'], 'type' => 'directory', - 'children' => [ - 'CreateDesktopGroup', - 'GetDesktopGroupDetail', - 'DescribeDesktopGroups', - 'ExportDesktopGroupInfo', - 'DescribeDesktopsInGroup', - 'DisableDesktopsInGroup', - 'ModifyDesktopGroup', - 'ResetDesktops', - 'SetDesktopGroupScaleTimer', - 'SetDesktopGroupTimer', - 'SetDesktopGroupTimerStatus', - 'RenewDesktopGroup', - 'DeleteDesktopGroup', - ], - ], - [ - 'id' => 394612, - 'title' => null, + 'title' => 'Shared Cloud desktop resources', + ], + [ + 'children' => ['AddUserToDesktopGroup', 'DescribeUsersInGroup', 'DescribeUserConnectionRecords', 'RemoveUserFromDesktopGroup'], 'type' => 'directory', - 'children' => [ - 'AddUserToDesktopGroup', - 'DescribeUsersInGroup', - 'DescribeUserConnectionRecords', - 'ModifyUserToDesktopGroup', - 'RemoveUserFromDesktopGroup', - ], + 'title' => 'Shared Cloud desktop users', ], ], + 'type' => 'directory', + 'title' => 'Shared Cloud desktop', ], [ - 'id' => 394618, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateNetworkPackage', - 'DescribeNetworkPackages', - 'DescribeFlowMetric', - 'DescribeFlowStatistic', - 'DescribeAclEntries', - 'ModifyAclEntries', - 'AssociateNetworkPackage', - 'DissociateNetworkPackage', - 'RenewNetworkPackages', - 'ModifyNetworkPackageBandwidth', - 'ModifyNetworkPackageEnabled', - 'DeleteNetworkPackages', - ], - ], - [ - 'id' => 394631, - 'title' => null, + 'children' => ['CreateNetworkPackage', 'DescribeNetworkPackages', 'DescribeFlowMetric', 'DescribeAclEntries', 'ModifyAclEntries', 'RenewNetworkPackages', 'ModifyNetworkPackageBandwidth', 'ModifyNetworkPackageEnabled', 'DeleteNetworkPackages'], 'type' => 'directory', - 'children' => [ - 'DescribeCens', - 'VerifyCen', - 'SendVerifyCode', - 'AttachCen', - 'DetachCen', - ], + 'title' => 'Premium public bandwidth', ], [ - 'id' => 394637, - 'title' => null, + 'children' => ['DescribeCens', 'SendVerifyCode'], 'type' => 'directory', + 'title' => 'Cloud enterprise network', + ], + [ 'children' => [ 'CreateDrive', 'DeleteDrive', 'DescribeDrives', [ - 'id' => 394641, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 394642, - 'title' => null, + 'children' => ['CreateCloudDriveService'], 'type' => 'directory', - 'children' => [ - 'CreateCloudDriveService', - ], + 'title' => 'Cloud drive', ], [ - 'id' => 394644, - 'title' => null, + 'children' => ['DescribeCloudDiskGroupDrives', 'DescribeCloudDiskGroups', 'CreateCloudDriveGroup', 'DescribeCloudDriveGroups'], 'type' => 'directory', - 'children' => [ - 'DescribeCloudDiskGroupDrives', - 'DescribeCloudDiskGroups', - 'CreateCloudDriveGroup', - 'DescribeCloudDriveGroups', - 'ModifyCloudDriveGroups', - 'DeleteCloudDriveGroups', - ], + 'title' => 'Team shared drive', ], [ - 'id' => 394651, - 'title' => null, + 'children' => ['CreateCloudDriveUsers', 'DescribeCloudDriveUsers', 'ModifyCloudDriveUsers', 'DeleteCloudDriveUsers'], 'type' => 'directory', - 'children' => [ - 'CreateCloudDriveUsers', - 'DescribeCloudDriveUsers', - 'ModifyCloudDriveUsers', - 'DeleteCloudDriveUsers', - ], + 'title' => 'User personal drive', ], [ - 'id' => 394656, - 'title' => null, + 'children' => ['DescribeCloudDrivePermissions', 'ModifyCloudDrivePermission'], 'type' => 'directory', - 'children' => [ - 'DescribeCloudDrivePermissions', - 'ModifyCloudDrivePermission', - ], + 'title' => 'Permissions', ], [ - 'id' => 394659, - 'title' => null, + 'children' => ['CreateCdsFile', 'CompleteCdsFile', 'CopyCdsFile', 'ListCdsFiles', 'ModifyCdsFile', 'DownloadCdsFile', 'DeleteCdsFile'], 'type' => 'directory', - 'children' => [ - 'CreateCdsFile', - 'CompleteCdsFile', - 'CopyCdsFile', - 'ListCdsFiles', - 'GetAsyncTask', - 'ModifyCdsFile', - 'MoveCdsFile', - 'DownloadCdsFile', - 'DeleteCdsFile', - ], + 'title' => 'File management', ], [ - 'id' => 394669, - 'title' => null, + 'children' => ['CreateCdsFileShareLink', 'ModifyCdsFileShareLink', 'CancelCdsFileShareLink'], 'type' => 'directory', - 'children' => [ - 'CreateCdsFileShareLink', - 'DescribeCdsFileShareLinks', - 'ModifyCdsFileShareLink', - 'CancelCdsFileShareLink', - ], + 'title' => 'File sharing', ], [ - 'id' => 394674, - 'title' => null, + 'children' => ['AddFilePermission', 'ListFilePermission', 'RemoveFilePermission'], 'type' => 'directory', - 'children' => [ - 'AddFilePermission', - 'ListFilePermission', - 'RemoveFilePermission', - ], + 'title' => 'Folder sharing', ], ], + 'type' => 'directory', + 'title' => 'Enterprise cloud drive (formerly WUYING cloudDrive)', ], [ - 'id' => 394678, - 'title' => null, + 'children' => ['CreateAndBindNasFileSystem', 'ModifyNASDefaultMountTarget', 'ResetNASDefaultMountTarget', 'DeleteNASFileSystems'], 'type' => 'directory', - 'children' => [ - 'CreateAndBindNasFileSystem', - 'CreateNASFileSystem', - 'DescribeNASFileSystems', - 'ModifyNASDefaultMountTarget', - 'ResetNASDefaultMountTarget', - 'DeleteNASFileSystems', - ], + 'title' => 'Shared storage NAS', ], ], + 'type' => 'directory', + 'title' => 'Storage', ], [ - 'id' => 394685, - 'title' => null, + 'children' => ['ModifyTemplate', 'DeleteTemplates', 'ModifyTemplateBaseInfo'], 'type' => 'directory', - 'children' => [ - 'CreateTemplate', - 'DescribeTemplates', - 'ModifyTemplate', - 'DeleteTemplates', - 'ModifyTemplateBaseInfo', - ], + 'title' => 'Template (new version)', ], [ - 'id' => 394691, - 'title' => null, + 'children' => ['CreateBundle', 'DescribeBundles'], 'type' => 'directory', - 'children' => [ - 'CreateBundle', - 'DescribeBundles', - 'ModifyBundle', - 'DeleteBundles', - ], + 'title' => 'Template (legacy)', ], [ - 'id' => 394696, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateImage', - 'CopyImage', - 'UploadImage', - 'DescribeImages', - 'DescribeImageModifiedRecords', - 'DescribeImagePermission', - 'ModifyImageAttribute', - 'ModifyImagePermission', - 'MigrateImageProtocol', - 'DeleteImages', - 'CancelCopyImage', - ], - ], - [ - 'id' => 394708, - 'title' => null, + 'children' => ['DescribeImageModifiedRecords', 'MigrateImageProtocol'], 'type' => 'directory', + 'title' => 'Image', + ], + [ 'children' => [ [ - 'id' => 394709, - 'title' => null, + 'children' => ['ResetSnapshot'], 'type' => 'directory', - 'children' => [ - 'CreateSnapshot', - 'ResetSnapshot', - 'DescribeSnapshots', - 'DeleteSnapshot', - ], + 'title' => 'Snapshot management', ], [ - 'id' => 394714, - 'title' => null, + 'children' => ['DescribeAutoSnapshotPolicy'], 'type' => 'directory', - 'children' => [ - 'CreateAutoSnapshotPolicy', - 'DescribeAutoSnapshotPolicy', - 'ApplyAutoSnapshotPolicy', - 'ModifyAutoSnapshotPolicy', - 'CancelAutoSnapshotPolicy', - 'DeleteAutoSnapshotPolicy', - ], + 'title' => 'Automatic snapshot policy', ], ], + 'type' => 'directory', + 'title' => 'Snapshot', ], [ - 'id' => 394721, - 'title' => null, - 'type' => 'directory', 'children' => [ [ - 'id' => 394722, - 'title' => null, + 'children' => ['DeleteCenterPolicy', 'ModifyResourceCenterPolicy', 'ModifyCenterPolicy', 'DescribeResourceByCenterPolicyId', 'DescribeCenterPolicyList', 'CreateCenterPolicy', 'CloneCenterPolicy'], 'type' => 'directory', - 'children' => [ - 'DeleteCenterPolicy', - 'ModifyResourceCenterPolicy', - 'ModifyCenterPolicy', - 'DescribeResourceByCenterPolicyId', - 'DescribeCenterPolicyList', - 'CreateCenterPolicy', - 'CloneCenterPolicy', - ], + 'title' => 'Region-independent policy', ], - 'CreatePolicyGroup', 'DeletePolicyGroups', - 'ModifyPolicyGroup', - 'ModifyDesktopsPolicyGroup', 'DescribePolicyGroups', 'ClonePolicyGroup', ], - ], - [ - 'id' => 394736, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'CreateConfigGroup', - 'ModifyConfigGroup', - 'DeleteConfigGroup', - 'BindConfigGroup', - 'UnbindConfigGroup', - 'DescribeConfigGroup', - 'ModifyTimerGroup', - 'DescribeTimerGroup', - 'DescribeGlobalTimerBatches', - 'DescribeGlobalTimerRecords', - ], - ], - [ - 'id' => 394747, - 'title' => null, - 'type' => 'directory', - 'children' => [ - 'DeleteVirtualMFADevice', - 'DescribeVirtualMFADevices', - 'UnlockVirtualMFADevice', - 'LockVirtualMFADevice', - ], - ], - [ - 'id' => 394752, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'DescribeFotaTasks', - 'DescribeFotaPendingDesktops', - 'UpdateFotaTask', - 'ApproveFotaUpdate', - ], + 'title' => 'Policy', ], [ - 'id' => 394757, - 'title' => null, + 'children' => ['CreateConfigGroup', 'ModifyConfigGroup', 'DeleteConfigGroup', 'BindConfigGroup', 'UnbindConfigGroup', 'DescribeConfigGroup', 'ModifyTimerGroup', 'DescribeTimerGroup', 'DescribeGlobalTimerBatches', 'DescribeGlobalTimerRecords'], 'type' => 'directory', - 'children' => [ - 'SetOfficeSiteSsoStatus', - 'SetIdpMetadata', - 'SetDirectorySsoStatus', - 'GetOfficeSiteSsoStatus', - 'GetSpMetadata', - ], + 'title' => 'Configuration group', ], [ - 'id' => 394763, - 'title' => null, + 'children' => ['DeleteVirtualMFADevice', 'DescribeVirtualMFADevices', 'UnlockVirtualMFADevice'], 'type' => 'directory', - 'children' => [ - 'StopInvocation', - 'DescribeInvocations', - 'RunCommand', - ], + 'title' => 'MFA', ], [ - 'id' => 394767, - 'title' => null, + 'children' => ['DescribeFotaPendingDesktops', 'UpdateFotaTask'], 'type' => 'directory', - 'children' => [ - 'ListTagResources', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Image upgrade OTA', ], [ - 'id' => 394771, - 'title' => null, + 'children' => ['SetDirectorySsoStatus', 'GetSpMetadata'], 'type' => 'directory', - 'children' => [ - 'DescribeClientEvents', - 'ExportClientEvents', - 'DescribeRecordings', - 'DescribeRecordFile', - 'DescribeGlobalDesktopRecords', - ], + 'title' => 'SSO settings', ], [ - 'id' => 394777, - 'title' => null, + 'children' => ['DescribeClientEvents', 'DescribeRecordFile', 'DescribeGlobalDesktopRecords'], 'type' => 'directory', - 'children' => [ - 'AddDevices', - 'DeleteDevices', - 'AttachEndUser', - 'DetachEndUser', - 'DescribeDevices', - ], + 'title' => 'Audit', ], [ - 'id' => 394783, - 'title' => null, + 'children' => ['DescribeDesktopSessions', 'DescribeDesktopGroupSessions', 'DescribeSessionStatistic', 'ApplyCoordinationForMonitoring', 'GetCoordinateTicket'], 'type' => 'directory', - 'children' => [ - 'DescribeDesktopSessions', - 'DescribeDesktopGroupSessions', - 'DescribeSessionStatistic', - 'DisconnectDesktopSessions', - 'ApplyCoordinationForMonitoring', - 'GetCoordinateTicket', - 'CancelCoordinationForMonitoring', - 'ApplyCoordinatePrivilege', - 'RevokeCoordinatePrivilege', - ], + 'title' => 'Monitoring and O&M', ], [ - 'id' => 394793, - 'title' => null, + 'children' => ['ListTransferFileDownloadUrl', 'ListTransferFiles', 'TransferTaskApprovalCallback'], 'type' => 'directory', - 'children' => [ - 'CreateBandwidthResourcePackages', - ], + 'title' => 'File transfer', ], [ - 'id' => 394795, - 'title' => null, + 'children' => ['ListInstalledApps'], 'type' => 'directory', - 'children' => [ - 'ListTransferFileDownloadUrl', - 'ListTransferFiles', - 'TransferTaskApprovalCallback', - ], + 'title' => 'Application', ], [ - 'id' => 394799, - 'title' => null, + 'children' => ['DescribeEcdReportTasks', 'CreateEcdReportTask'], 'type' => 'directory', - 'children' => [ - 'ListInstalledApps', - ], + 'title' => 'Report', ], [ - 'id' => 394801, - 'title' => null, - 'type' => 'directory', 'children' => [ - 'DescribeEcdReportTasks', - 'CreateEcdReportTask', + 'CreateQosRule', 'DeleteQosRules', 'ModifyQosEntries', 'ModifyQosRule', 'DescribeOnlineUserCount', 'QueryHistoryActiveUserCount', 'QueryHistoryAvgMetricList', 'QueryHistoryMetricDistribution', 'QueryHistoryUsageDurationRank', 'ActivateOfficeSite', 'AddDevices', 'ApplyAutoSnapshotPolicy', 'ApplyCoordinatePrivilege', 'ApproveFotaUpdate', 'AssociateNetworkPackage', 'AttachCen', 'AttachEndUser', 'CancelAutoSnapshotPolicy', 'CancelCoordinationForMonitoring', 'CancelCopyImage', + 'ConfigADConnectorTrust', 'CopyImage', 'CreateADConnectorDirectory', 'CreateAutoSnapshotPolicy', 'CreateBandwidthResourcePackages', 'CreateDiskEncryptionService', 'CreateImage', 'CreateNASFileSystem', 'CreatePolicyGroup', 'CreateRAMDirectory', 'CreateSnapshot', 'CreateTemplate', 'DeleteAutoSnapshotPolicy', 'DeleteBundles', 'DeleteCloudDriveGroups', 'DeleteDevices', 'DeleteDirectories', 'DeleteImages', 'DeleteSnapshot', 'DescribeCdsFileShareLinks', + 'DescribeDevices', 'DescribeDirectories', 'DescribeFotaTasks', 'DescribeGuestApplications', 'DescribeImagePermission', 'DescribeImages', 'DescribeInvocations', 'DescribeNASFileSystems', 'DescribePrice', 'DescribeQosRules', 'DescribeRecordings', 'DescribeRegions', 'DescribeRenewalPrice', 'DescribeSnapshots', 'DescribeTemplates', 'DescribeUsersPassword', 'DescribeZones', 'DetachCen', 'DetachEndUser', 'DisconnectDesktopSessions', + 'DissociateNetworkPackage', 'ExportClientEvents', 'ExportDesktopListInfo', 'GetAsyncTask', 'GetConnectionTicket', 'GetOfficeSiteSsoStatus', 'ListTagResources', 'ListUserAdOrganizationUnits', 'LockVirtualMFADevice', 'ModifyADConnectorDirectory', 'ModifyADConnectorOfficeSite', 'ModifyAutoSnapshotPolicy', 'ModifyBundle', 'ModifyCloudDriveGroups', 'ModifyCustomizedListHeaders', 'ModifyDesktopsPolicyGroup', 'ModifyDiskSpec', 'ModifyEntitlement', 'ModifyImageAttribute', 'ModifyImagePermission', + 'ModifyOfficeSiteCrossDesktopAccess', 'ModifyPolicyGroup', 'ModifyUserToDesktopGroup', 'MoveCdsFile', 'RevokeCoordinatePrivilege', 'RunCommand', 'SetDesktopGroupTimer', 'SetDesktopGroupTimerStatus', 'SetIdpMetadata', 'SetOfficeSiteSsoStatus', 'StopInvocation', 'TagResources', 'UntagResources', 'UploadImage', 'VerifyCen', 'WakeupDesktops', ], - ], - [ - 'id' => 394804, - 'title' => null, 'type' => 'directory', - 'children' => [ - 'CreateQosRule', - 'DeleteQosRules', - 'DescribeQosRules', - 'ModifyQosEntries', - 'ModifyQosRule', - ], + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'CdsFileShareLinkModel' => [ - 'title' => '', + 'title' => '文件分享链接数据实体', 'description' => 'The data entity of the file sharing link.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => '', - 'description' => 'The description.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'newDescription', - 'backendName' => 'description', - ], - 'SaveLimit' => [ - 'title' => '', - 'description' => 'The maximum number of times that the shared file can be saved.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'saveLimit', - ], - 'DownloadCount' => [ - 'title' => '', - 'description' => 'The number of times that the shared file can be downloaded.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'downloadCount', - ], - 'Creator' => [ - 'title' => '', - 'description' => 'The user that creates the file sharing task.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'user01', - 'backendName' => 'creator', - ], - 'SaveCount' => [ - 'title' => '', - 'description' => 'The number of times that the shared files can be dumped.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'saveCount', - ], - 'DisableSave' => [ - 'title' => '', - 'description' => 'The shared file is forbidden from being dumped.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'disableSave', - ], - 'SharePwd' => [ - 'title' => '', - 'description' => 'The access code. It must contain up to 64 characters in length. 0 characters indicates that there is no access code.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '12345678', - 'backendName' => 'sharePwd', - ], - 'DisablePreview' => [ - 'title' => '', - 'description' => 'The shared file is forbidden from being previewed.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'disablePreview', - ], - 'AccessCount' => [ - 'title' => '', - 'description' => 'The number of times to access the shared file.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - 'backendName' => 'accessCount', - ], - 'ShareId' => [ - 'title' => '', - 'description' => 'The file sharing task ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '7JQX1Fs****', - 'backendName' => 'shareId', - ], - 'DownloadLimit' => [ - 'title' => '', - 'description' => 'The maximum number of times that the shared file can be downloaded.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'downloadLimit', - ], + 'Description' => ['title' => '描述', 'description' => 'The description.'."\n", 'type' => 'string', 'example' => '文件分享链接。', 'visibility' => 'Public', 'backendName' => 'description'], + 'SaveLimit' => ['title' => '分享转存次数限制', 'description' => 'The maximum number of times that the shared file can be saved.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'saveLimit'], + 'DownloadCount' => ['title' => '下载次数', 'description' => 'The number of times that the shared file can be downloaded.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'downloadCount'], + 'Creator' => ['title' => '创建者', 'description' => 'The user that creates the file sharing task.'."\n", 'type' => 'string', 'example' => 'user01', 'visibility' => 'Public', 'backendName' => 'creator'], + 'SaveCount' => ['title' => '转存次数', 'description' => 'The number of times that the shared files can be dumped.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'saveCount'], + 'DisableSave' => ['title' => '禁止转存分享中的文件', 'description' => 'The shared file is forbidden from being dumped.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'disableSave'], + 'SharePwd' => ['title' => '提取码，0-64个字符。长度0表示没有提取码。', 'description' => 'The access code. It must contain up to 64 characters in length. 0 characters indicates that there is no access code.'."\n", 'type' => 'string', 'example' => '12345678', 'visibility' => 'Public', 'backendName' => 'sharePwd'], + 'DisablePreview' => ['title' => '禁止预览分享中的文件', 'description' => 'The shared file is forbidden from being previewed.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'disablePreview'], + 'AccessCount' => ['title' => '访问次数', 'description' => 'The number of times to access the shared file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'visibility' => 'Public', 'backendName' => 'accessCount'], + 'ShareId' => ['title' => '分享id', 'description' => 'The file sharing task ID.'."\n", 'type' => 'string', 'example' => '7JQX1Fs****', 'visibility' => 'Public', 'backendName' => 'shareId'], + 'DownloadLimit' => ['title' => '分享下载次数限制', 'description' => 'The maximum number of times that the shared file can be downloaded.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'downloadLimit'], 'Status' => [ - 'title' => '', + 'title' => '状态。 枚举值如下： forbidden（被禁用） forbidden_disabled（被禁用后取消） disabled（已取消） enabled（有效）', 'description' => 'The status of the file sharing link.'."\n" ."\n" .'Valid values:'."\n" @@ -729,137 +310,38 @@ .' The file sharing link is valid.'."\n" ."\n" .' '."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - ' forbidden_disabled' => '', - 'forbidden' => '', - ' disabled' => '', - 'enabled' => '', - ], + 'enumValueTitles' => [' forbidden_disabled' => '被禁用后取消', 'forbidden' => '被禁用', ' disabled' => '已取消', 'enabled' => '有效'], 'example' => 'disabled', + 'visibility' => 'Public', 'backendName' => 'status', ], - 'DriveId' => [ - 'title' => '', - 'description' => 'The team space ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dri-g0877jp3hu1ox****', - 'backendName' => 'driveId', - ], - 'ModifiyTime' => [ - 'title' => '', - 'description' => 'The modification time.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2021-09-04T04:30:36Z', - 'backendName' => 'modifiyTime', - ], - 'DisableDownload' => [ - 'title' => '', - 'description' => 'The shared file is forbidden from being downloaded.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'disableDownload', - ], - 'Expiration' => [ - 'title' => '', - 'description' => 'The time when the file sharing link expires.'."\n" - ."\n" - .'> The value must be in the FC3339 format. Example: 2020-06-28T11:33:00.000+08:00. If the parameter is left empty, the file sharing link is permanently valid.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2020-06-28T11:33:00.000+08:00', - 'backendName' => 'expiration', - ], - 'Expired' => [ - 'title' => '', - 'description' => 'Specifies whether the file sharing link expires.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'False', - 'backendName' => 'expired', - ], - 'PreviewCount' => [ - 'title' => '', - 'description' => 'The number of times that the shared file is previewed.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'previewCount', - ], - 'PreviewLimit' => [ - 'title' => '', - 'description' => 'The maximum number of times that the shared file can be previewed.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'previewLimit', - ], - 'VideoPreviewCount' => [ - 'title' => '', - 'description' => 'The number of times that the audio and video file is played.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'videoPreviewCount', - ], - 'ReportCount' => [ - 'title' => '', - 'description' => 'The number of times that the shared file is reported due to content violation.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'reportCount', - ], - 'FileIds' => [ - 'title' => '', - 'description' => 'The file sharing task IDs.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '[\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\"]', - 'backendName' => 'fileIds', - ], - 'ShareName' => [ - 'title' => '', - 'description' => 'The shared file name. By default, the name of the first shared file is used.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'view.txt', - 'backendName' => 'shareName', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '2021-09-04T03:30:36Z', - 'backendName' => 'createTime', - ], - 'ShareLink' => [ - 'title' => '', - 'description' => 'The file sharing link.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****', - 'backendName' => 'shareLink', - ], - ], + 'DriveId' => ['title' => '空间id', 'description' => 'The team space ID.'."\n", 'type' => 'string', 'example' => 'dri-g0877jp3hu1ox****', 'visibility' => 'Public', 'backendName' => 'driveId'], + 'ModifiyTime' => ['title' => '修改时间', 'description' => 'The modification time.'."\n", 'type' => 'string', 'example' => '2021-09-04T04:30:36Z', 'visibility' => 'Public', 'backendName' => 'modifiyTime'], + 'DisableDownload' => ['title' => '禁止下载分享中的文件', 'description' => 'The shared file is forbidden from being downloaded.'."\n", 'type' => 'boolean', 'example' => 'false', 'visibility' => 'Public', 'backendName' => 'disableDownload'], + 'Expiration' => ['title' => '失效时间点。 RFC3339格式，比如："2020-06-28T11:33:00.000+08:00"。 永久有效：""', 'description' => 'The time when the file sharing link expires.'."\n" + ."\n" + .'> The value must be in the FC3339 format. Example: 2020-06-28T11:33:00.000+08:00. If the parameter is left empty, the file sharing link is permanently valid.'."\n", 'type' => 'string', 'example' => '2020-06-28T11:33:00.000+08:00', 'visibility' => 'Public', 'backendName' => 'expiration'], + 'Expired' => ['title' => '是否过期', 'description' => 'Specifies whether the file sharing link expires.'."\n", 'type' => 'boolean', 'example' => 'False', 'visibility' => 'Public', 'backendName' => 'expired'], + 'PreviewCount' => ['title' => '预览次数', 'description' => 'The number of times that the shared file is previewed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'previewCount'], + 'PreviewLimit' => ['title' => '分享预览次数限制', 'description' => 'The maximum number of times that the shared file can be previewed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'visibility' => 'Public', 'backendName' => 'previewLimit'], + 'VideoPreviewCount' => ['title' => '音视频播放次数', 'description' => 'The number of times that the audio and video file is played.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'videoPreviewCount'], + 'ReportCount' => ['title' => '被举报次数', 'description' => 'The number of times that the shared file is reported due to content violation.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'visibility' => 'Public', 'backendName' => 'reportCount'], + 'FileIds' => ['title' => '分享父路径文件id列表', 'description' => 'The file sharing task IDs.'."\n", 'type' => 'string', 'example' => '[\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\"]', 'visibility' => 'Public', 'backendName' => 'fileIds'], + 'ShareName' => ['title' => '分享名，默认使用第一个文件名', 'description' => 'The shared file name. By default, the name of the first shared file is used.'."\n", 'type' => 'string', 'example' => 'view.txt', 'visibility' => 'Public', 'backendName' => 'shareName'], + 'CreateTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'type' => 'string', 'example' => '2021-09-04T03:30:36Z', 'visibility' => 'Public', 'backendName' => 'createTime'], + 'ShareLink' => ['title' => '分享链接', 'description' => 'The file sharing link.'."\n", 'type' => 'string', 'example' => 'https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****', 'visibility' => 'Public', 'backendName' => 'shareLink'], + ], + 'visibility' => 'Public', + 'example' => '', ], 'FilePermissionMember' => [ - 'title' => '', + 'title' => '文件授权对象', 'description' => 'The object that you want to grant permissions.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'RoleId' => [ - 'title' => '', + 'title' => '角色ID', 'description' => 'The role.'."\n" ."\n" .'Valid values:'."\n" @@ -877,567 +359,525 @@ .'* SystemFileUploader: The role that can upload files.'."\n" .'* SystemFileUploaderAndDownloader: The role that can upload and download files.'."\n" .'* SystemFileMetaViewer: The role that can view file list.', - 'visibility' => 'public', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ - 'SystemFileEditorWithoutShareLink' => '', - 'SystemFileUploaderAndDownloaderWithShareLink' => '', - 'SystemFileDownloader' => '', - 'SystemFileEditorWithoutDelete' => '', - 'SystemFileOwner' => '', - 'SystemFileDownloaderWithShareLink' => '', - 'SystemFileUploaderAndViewer' => '', - 'SystemFileViewer' => '', - 'SystemFileEditor' => '', - 'SystemFileUploaderWithShareLink' => '', - 'SystemFileUploader' => '', - 'SystemFileUploaderAndDownloader' => '', - 'SystemFileMetaViewer' => '', + 'SystemFileEditorWithoutShareLink' => '无分享编辑者', 'SystemFileUploaderAndDownloaderWithShareLink' => '上传/下载/分享者', 'SystemFileDownloader' => '下载者', 'SystemFileEditorWithoutDelete' => '无删除编辑者', 'SystemFileOwner' => '文件协同', 'SystemFileDownloaderWithShareLink' => '下载/分享者', 'SystemFileUploaderAndViewer' => '预览/上传者', 'SystemFileViewer' => '预览者', 'SystemFileEditor' => '编辑者', 'SystemFileUploaderWithShareLink' => '上传/分享者', + 'SystemFileUploader' => '上传者', 'SystemFileUploaderAndDownloader' => '上传/下载者', 'SystemFileMetaViewer' => '可见列表', ], 'example' => 'SystemFileEditor', + 'visibility' => 'Public', 'backendName' => 'roleId', ], - 'ExpireTime' => [ - 'title' => '', - 'description' => 'The expiration time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1633598866642', - 'backendName' => 'expireTime', - ], - 'DisinheritSubGroup' => [ - 'title' => '', - 'description' => 'Indicates whether to disable the permission from users in the subgroup.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'disinheritSubGroup', - ], + 'ExpireTime' => ['title' => '过期时间', 'description' => 'The expiration time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1633598866642', 'visibility' => 'Public', 'backendName' => 'expireTime'], + 'DisinheritSubGroup' => ['title' => '子用户组是否继承', 'description' => 'Indicates whether to disable the permission from users in the subgroup.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'disinheritSubGroup'], 'CdsIdentity' => [ - 'title' => '', + 'title' => '用户对象', 'description' => 'The object that you want to grant permissions. The object can be a user or a group.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The user ID or a team ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'required' => true, - 'example' => '16435bdf934248b788b7b3771ee9****', - 'backendName' => 'id', - ], + 'Id' => ['title' => '用户ID', 'description' => 'The user ID or a team ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '16435bdf934248b788b7b3771ee9****', 'visibility' => 'Public', 'backendName' => 'id'], 'Type' => [ - 'title' => '', + 'title' => '用户类型', 'description' => 'The object type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'* IT_Group: team'."\n" .'* IT_User: user', - 'visibility' => 'public', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'IT_Group' => '', - 'IT_User' => '', - ], + 'enumValueTitles' => ['IT_Group' => '团队', 'IT_User' => '用户'], 'example' => 'IT_User', + 'visibility' => 'Public', 'backendName' => 'type', ], ], 'required' => true, + 'visibility' => 'Public', 'backendName' => 'cdsIdentity', + 'example' => '', ], ], + 'visibility' => 'Public', + 'example' => '', ], ], ], 'apis' => [ - 'DescribeRegions' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ActivateOfficeSite' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AcceptLanguage', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The display name of the region, which varies based on the current language.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the convenience office network that is locked.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-803704****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Regions' => [ - 'description' => 'The information about regions.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RegionEndpoint' => [ - 'description' => 'The endpoint of the region.', - 'type' => 'string', - 'example' => 'ecd.cn-hangzhou.aliyuncs.com', - ], - 'RegionId' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LocalName' => [ - 'description' => 'The display name of the region, which varies based on the current language.', - 'type' => 'string', - 'example' => 'China (Hangzhou)', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRegions', - 'summary' => 'Queries the Alibaba Cloud regions that are available for Elastic Desktop Service (EDS).', - ], - 'DescribeZones' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\r\\n","errorExample":""}]', + 'title' => 'ActivateOfficeSite', + 'summary' => 'Unlocks a convenience office network that is automatically locked due to a long idle period of time.', + 'description' => 'If you do not create any cloud computer in a convenience office network within 15 days, the office network is automatically locked and virtual private cloud (VPC) resources are released. If you want to resume the office network, you can call this operation to unlock the office network.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ActivateOfficeSite'], + ], ], + 'ramActions' => [], + ], + 'AddDevices' => [ + 'summary' => 'Adds trusted devices.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DeviceIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the devices. You can specify up to 200 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The serial number (SN) of the hardware client or the UUID of the software client.'."\n", 'type' => 'string', 'required' => false, 'example' => '5F52817BE267A43C608D245070D2****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ZoneType', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the zone. Default value: `AvailabilityZone`. This value indicates Alibaba Cloud zones.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AvailabilityZone', + 'description' => 'The type of the client.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: hardware client.'."\n" + .'* 2: software client.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [1 => '', ''], + 'example' => '2', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Zones' => [ - 'description' => 'Details of zones.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07****'], + 'Code' => ['description' => 'The execution result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The returned error message. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'The parameter is not specified.', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'AddDevices', + 'description' => 'Each device can be registered in only one Alibaba Cloud account. If you register a device that has been registered in another Alibaba Cloud account, an error is reported.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddDevices'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87DBB05-653A-5E4B-B72B-5F4A1E07****\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The parameter is not specified.\\"\\n}","type":"json"}]', + ], + 'AddFilePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who uses the network disk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise drive.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-352282****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', 'title' => ''], + ], + [ + 'name' => 'MemberList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'json', + 'schema' => [ + 'description' => 'The users that you want to authorize to use the cloud disk.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The user that you want to authorize.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleId' => [ + 'title' => '', + 'description' => 'You can set permissions by specifying roles or by customizing operation permissions. This field is used to set permissions by specifying roles. This field is mutually exclusive with `ActionList`.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SystemFileEditorWithoutShareLink: The role that can edit but cannot share files.'."\n" + .'* SystemFileUploaderAndDownloaderWithShareLink: The role that can upload, download, and share files.'."\n" + .'* SystemFileDownloader: The role that can download files.'."\n" + .'* SystemFileEditorWithoutDelete: The role that can edit but cannot edit files.'."\n" + .'* SystemFileOwner: The role that can collaborate with others on files.'."\n" + .'* SystemFileDownloaderWithShareLink: The role that can download and share files.'."\n" + .'* SystemFileUploaderAndViewer: The role that can preview and upload files.'."\n" + .'* SystemFileViewer: The role that can preview files.'."\n" + .'* SystemFileEditor: The role that can edit files.'."\n" + .'* SystemFileUploaderWithShareLink: The role that can upload and share files.'."\n" + .'* SystemFileUploader: The role that can upload files.'."\n" + .'* SystemFileUploaderAndDownloader: The role that can upload and download files.'."\n" + .'* SystemFileMetaViewer: The role that can view file list.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SystemFileEditorWithoutShareLink' => '', 'SystemFileUploaderAndDownloaderWithShareLink' => '', 'SystemFileDownloader' => '', 'SystemFileEditorWithoutDelete' => '', 'SystemFileOwner' => '', 'SystemFileDownloaderWithShareLink' => '', 'SystemFileUploaderAndViewer' => '', 'SystemFileViewer' => '', 'SystemFileEditor' => '', 'SystemFileUploaderWithShareLink' => '', + 'SystemFileUploader' => '', 'SystemFileUploaderAndDownloader' => '', 'SystemFileMetaViewer' => '', + ], + 'example' => 'SystemFileUploaderAndDownloader', + ], + 'ExpireTime' => ['title' => '', 'description' => 'The time when the authorization expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The value never expires. You can specify a value that is predefined by the system for this parameter. Example: 4775500800000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4775500800000'], + 'DisinheritSubGroup' => ['title' => '', 'description' => 'Specifies whether the users of the child group can inherit the folder permissions.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], + 'CdsIdentity' => [ + 'title' => '', + 'description' => 'The user of the cloud disk.'."\n", 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'description' => 'The zone ID.'."\n", + 'Id' => ['title' => '', 'description' => 'The ID of the convenience user.'."\n", 'type' => 'string', 'required' => true, 'example' => 'alice'], + 'Type' => [ + 'title' => '', + 'description' => 'The user type.'."\n" + ."\n" + .'Set the value to TENANT_ADMIN.'."\n" + ."\n" + .'* IT_Group: group.'."\n" + .'* IT_User: user.'."\n", 'type' => 'string', - 'example' => 'cn-hangzhou-h', + 'required' => true, + 'enumValueTitles' => ['IT_Group' => '', 'IT_User' => ''], + 'example' => 'IT_User', + 'default' => 'IT_User', + 'enum' => ['IT_User', 'IT_Group'], ], ], + 'required' => true, + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'docRequired' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the team space.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5BEFE642-A383-4A18-8939-FB7DE4526F65\\n \\n cn-hangzhou-h\\n \\n","errorExample":""}]', - 'title' => 'DescribeZones', - 'summary' => 'Queries the zones in a region in which Elastic Desktop Service is supported.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribePrice' => [ - 'summary' => 'Queries the prices of Elastic Desktop Service (EDS) resources.', - 'methods' => [ - 'post', - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'AddFilePermission', + 'summary' => 'Adds a shared folder to the network disk.', + 'description' => 'You can call this operation to share a specific folder with other users. You can also configure the folder permissions.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddFilePermission'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'AddUserToDesktopGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52841', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by EDS.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to obtain a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DesktopMonthPackage: monthly subscription cloud computers that use hourly limit plans.'."\n" - .'* Desktop (default): pay-as-you-go cloud computers/monthly subscription cloud computers that use unlimited plans.'."\n" - .'* Bandwidth: premium bandwidth plans.'."\n" - .'* DesktopGroup: cloud computer shares.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DesktopMonthPackage' => '', - 'Desktop' => '', - 'Bandwidth' => '', - 'DesktopGroup' => '', - ], - 'example' => 'Desktop', - ], + 'schema' => ['description' => 'The ID of the shared cloud desktop to which to add an authorized user.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The specifications of the resource.'."\n" - ."\n" - .'* This parameter is required if you set `ResourceType` to `Desktop`. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) to query the available cloud computer types that correspond to the value of `DesktopTypeId`.'."\n" - .'* If you set `ResourceType` to `DesktopGroup`, set the value of this parameter to `large`.'."\n" - .'* If you set `ResourceType` to `Bandwidth`, you can leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eds.general.2c2g', - ], + 'schema' => ['description' => 'A client token that ensures the idempotence of a request. Generate a unique value for this parameter from your client. The token can contain only ASCII characters and must be no more than 64 characters long. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], ], [ - 'name' => 'RootDiskSizeGib', + 'name' => 'EndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The size of the system disk. Unit: GiB. If you set `ResourceType` to `Desktop`, you must specify this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'A list of users to authorize.', + 'type' => 'array', + 'items' => ['description' => 'The user to authorize.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'maximum' => '32768', - 'minimum' => '0', - 'example' => '80', + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserDiskSizeGib', + 'name' => 'DesktopGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The size of the data disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'A list of shared cloud desktop group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a shared cloud desktop group.', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'maximum' => '65536', - 'minimum' => '0', - 'example' => '100', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OsType', + 'name' => 'UserOuPath', 'in' => 'query', - 'schema' => [ - 'description' => 'The OS type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - .'* Windows (default)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => '', - ], - 'example' => 'Windows', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'UserGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing cycle.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n" - .'* Hour (default)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - 'Hour' => '', - ], - 'example' => 'Hour', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Period', + 'name' => 'SimpleUserGroupId', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The subscription duration. The valid values of this parameter vary based on the value of `PeriodUnit`.'."\n" - ."\n" - .'* If you set `PeriodUnit` to `Hour`, set the value of this parameter to 1.'."\n" - .'* If you set `PeriodUnit` to `Month`, set the value of this parameter to 1, 2, 3, or 6.'."\n" - .'* If you set `PeriodUnit` to `Year`, set the value of this parameter to 1, 2, or 3.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'A collection of information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'AddUserToDesktopGroup', + 'summary' => 'Adds authorized users to a shared cloud desktop group, automatically assigning cloud desktops within the group to these users based on rules defined by an administrator.', + 'changeSet' => [ + ['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddUserToDesktopGroup'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ApplyAutoSnapshotPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Amount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of resources. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'PromotionId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The promotion ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InternetChargeType', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metering method for network traffic.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayByTraffic: You are charged for the actually consumed traffic.'."\n" - .'* PayByBandwidth: You are charged by a fixed bandwidth.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PayByTraffic' => '', - 'PayByBandwidth' => '', - ], - 'example' => 'PayByTraffic', - ], + 'schema' => ['description' => 'The ID of the automatic snapshot policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sp-ejtum8j5tfcw7****', 'title' => ''], ], [ - 'name' => 'Bandwidth', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum public bandwidth. Unit: Mbit/s.'."\n" - ."\n" - .'* Valid values if you set InternetChargeType to PayByBandwidth: 10 to 1000.'."\n" - .'* Valid values if you set InternetChargeType to InternetChargeType: 10 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '3072', - 'minimum' => '1', - 'example' => '10', + 'description' => 'The IDs of the cloud computers. You can specify 1 to 20 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-2h7u3ymhm33qy****', 'title' => ''], + 'required' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RootDiskPerformanceLevel', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\"\\n}","type":"json"}]', + 'title' => 'ApplyAutoSnapshotPolicy', + 'summary' => 'Apply an automatic snapshot policy to cloud computers. After the automatic snapshot policy is applied to the cloud computers, Elastic Desktop Service automatically creates snapshots for the cloud computers based on the time specified in the automatic snapshot policy.', + 'changeSet' => [ + ['createdAt' => '2025-01-15T02:17:22.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'], + ], + ], + 'ramActions' => [], + 'description' => 'You can also associate an automatic snapshot policy with a cloud desktop in the Elastic Desktop Service (EDS) console. To do so, perform the following steps: 1. Log on to the EDS console. 2. Choose Desktops and Groups > Desktops in the left-side navigation pane. 3. Find the cloud desktop that you want to manage on the Cloud Desktops page and choose More > Change Automatic Snapshot Policy in the Actions column. 4. Configure a policy for the cloud desktop as prompted in the Change Automatic Snapshot Policy panel.'."\n" + ."\n" + .'After you associate an automatic snapshot policy with the cloud desktop, the system creates snapshots for the cloud desktop based on the policy.'."\n", + ], + 'ApplyCoordinatePrivilege' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UserDiskPerformanceLevel', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'GroupDesktopCount', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of cloud computer shares. Default value: 1.'."\n" - ."\n" - .'> This parameter takes effect only if you set `ResourceType` to `DesktopGroup`.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Duration', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of hourly plan if you use the Monthly Subscription billing method. If you set `ResourceType` to `DesktopMonthPackage`, you must specify this parameter.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 120: the 120-hour computing plan.'."\n" - .'* 250: the 250-hour computing plan.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 120 => '', - 250 => '', - ], - 'example' => '120', - ], + 'schema' => ['description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => '3E14A18BD4D088504B9F8A8751AB****', 'title' => ''], ], [ - 'name' => 'RootDiskCategory', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the system disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: the ultra disk'."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the Enterprise SSD (ESSD). Take note that only specific cloud computer types support ESSDs.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_auto' => '', - 'cloud_essd' => '', - ], - 'example' => '40', - ], + 'schema' => ['description' => 'The ID of the end user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'UserDiskCategory', + 'name' => 'CoId', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the data disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: the ultra disk'."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the ESSD. Take note that only specific cloud computer types support ESSDs.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_auto' => '', - 'cloud_essd' => '', - ], - 'example' => '80', - ], + 'schema' => ['description' => 'The ID of the application for the coordinate permissions.'."\n", 'type' => 'string', 'required' => true, 'example' => 'co-fqsm6e8ee75w6****', 'title' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'UserType', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'description' => 'The type of user who requires the coordinate permissions.'."\n" + ."\n" + .'Valid value: TENANT_ADMIN.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TENANT_ADMIN', + 'enumValueTitles' => ['TENANT_ADMIN' => '租户管理员'], + 'title' => '', ], ], ], @@ -1446,2656 +886,1811 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B1175630-3C44-4389-A3C1-15639FFC8EBC', - ], - 'PriceInfo' => [ - 'description' => 'The price details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rules' => [ - 'description' => 'The details of the promotion rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'example' => 'Receive a 15% discount on a one-year subscription.'."\n", - ], - 'RuleId' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '587', - ], - ], - ], - ], - 'Price' => [ - 'description' => 'The price.'."\n", - 'type' => 'object', - 'properties' => [ - 'OriginalPrice' => [ - 'description' => 'The original price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2.796', - ], - 'DiscountPrice' => [ - 'description' => 'The discounted amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0', - ], - 'Currency' => [ - 'description' => 'The unit of currency (USD).'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'TradePrice' => [ - 'description' => 'The actual price. The original price minus the discounted amount equals the actual price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2.796', - ], - 'Promotions' => [ - 'description' => 'The promotions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The promotion.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromotionDesc' => [ - 'description' => 'The description of the promotion.'."\n", - 'type' => 'string', - 'example' => 'Get started with new services with a discount.'."\n", - ], - 'OptionCode' => [ - 'description' => 'The description of the promotion rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Selected' => [ - 'description' => 'Indicates whether an item is selected.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'PromotionId' => [ - 'description' => 'The promotion ID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'PromotionName' => [ - 'description' => 'The promotion name.'."\n", - 'type' => 'string', - 'example' => 'Special Offer'."\n", - ], - ], - ], - ], - 'OrderLines' => [ - 'description' => 'The orders.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The order.'."\n", - 'example' => '5376483****', - ], - ], - 'SpPrice' => [ - 'description' => 'The price under an effective savings plan.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50.00', - ], - ], - ], - 'FreeCdsQuota' => [ - 'description' => 'Indicates whether a free enterprise drive is available.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FreeCdsSize' => [ - 'description' => 'The free capacity provided by the enterprise drive. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C43EEAC3-84F8-5C1E-A067-4751C3D1422E', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B1175630-3C44-4389-A3C1-15639FFC8EBC\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 587\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY/USD\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"123456\\",\\n \\"PromotionName\\": \\"精选特惠\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n },\\n \\"SpPrice\\": 50\\n },\\n \\"FreeCdsQuota\\": true,\\n \\"FreeCdsSize\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B1175630-3C44-4389-A3C1-15639FFC8EBC\\n \\n \\n 2.796\\n 0\\n CNY\\n 2.796\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribePrice', - 'description' => '## Usage notes'."\n" - ."\n" - .'The request parameters vary based on the type of desktop resources whose price you want to query. Take note of the following items:'."\n" - ."\n" - .'* If you set ResourceType to OfficeSite, you must specify InstanceType.'."\n" - .'* If you set ResourceType to Bandwidth, the pay-by-data-transfer metering method is used for network billing.'."\n" - .'* If you set ResourceType to Desktop, you must specify InstanceType, RootDiskSizeGib, and UserDiskSizeGib. You can specify OsType, PeriodUnit, Period, and Amount based on your business requirements.'."\n" - ."\n" - .'> Before you call this operation to query the prices of cloud desktops by setting ResourceType to Desktop, you must know the desktop types and disk sizes that EDS provides. The disk sizes vary based on the desktop types. For more information, see [Cloud desktop types](~~188609~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeRenewalPrice' => [ - 'summary' => 'Queries the renewal price of an Alibaba Cloud Workspace service.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ApplyCoordinatePrivilege', + 'summary' => 'Applies for the coordinate permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinatePrivilege'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C43EEAC3-84F8-5C1E-A067-4751C3D1422E\\"\\n}","type":"json"}]', + ], + 'ApplyCoordinationForMonitoring' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '75405', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](https://next.api.aliyun.com/document/ecd/2020-09-30/DescribeRegions) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID. The value you specify depends on the resource type (ResourceType) you\'re querying the renewal price for.'."\n" - ."\n" - .'* When `ResourceType` is set to `Desktop`, you must provide the cloud computer ID as the value of `InstanceId`.'."\n" - .'* When `ResourceType` is set to `DesktopGroup`, you must provide the share ID as the value of `InstanceId`.'."\n" - .'* When `ResourceType` is set to `Bandwidth`, you must provide the ID of the premium bandwidth plan as the value of `InstanceId`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ecd-6ldllk9zxcpfhs****', - ], + 'schema' => ['description' => 'The universally unique identifier (UUID) of the device.', 'type' => 'string', 'required' => true, 'example' => '3E14A18BD4D088504B9F8A8751AB****', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'InitiatorType', 'in' => 'query', 'schema' => [ - 'description' => 'The resource type.'."\n" + 'description' => 'The type of the initiator.'."\n" ."\n" - .'Valid values:'."\n" + .'Set the value to ADMIN\\_INITIATE.'."\n" ."\n" - .'* Desktop (default): cloud computers.'."\n" - .'* Bandwidth: premium bandwidth plans.'."\n" - .'* DesktopGroup: cloud computer shares.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Desktop' => '', - 'Bandwidth' => '', - 'DesktopGroup' => '', - ], - 'example' => 'Desktop', - ], - ], - [ - 'name' => 'PeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the renewal duration specified by `Period`.'."\n" + .'- The value ADMIN\\_INITIATE specifies that the administrator initiates the coordination request.'."\n" ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* Month (default)'."\n" - .'* Year'."\n", + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['ADMIN_INITIATE' => ''], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', + 'example' => 'ADMIN_INITIATE', + 'title' => '', ], ], [ - 'name' => 'Period', + 'name' => 'CoordinatePolicyType', 'in' => 'query', 'schema' => [ - 'description' => 'The renewal duration. The valid values for this parameter depend on the value of `PeriodUnit`.'."\n" + 'description' => 'The coordination policy.'."\n" ."\n" - .'* If you set `PeriodUnit` to `Month`, set the value of this parameter to 1, 2, 3, or 6.'."\n" - .'* If you set `PeriodUnit` to `Year`, set the value of this parameter to 1, 2, or 3.'."\n" + .'Set the value to FULL\\_CONTROL.'."\n" ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + .'- The value FULL\\_CONTROL specifies that the cloud desktop is shared and remote access to the cloud desktop is allowed.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['FULL_CONTROL' => ''], + 'type' => 'string', + 'required' => true, + 'example' => 'FULL_CONTROL', + 'title' => '', ], ], [ - 'name' => 'InstanceIds', + 'name' => 'ResourceCandidates', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instance IDs. The value you specify depends on the resource type (ResourceType) you\'re querying the renewal price for.'."\n", + 'description' => 'The list of cloud desktops that run the collaboration task at the same time.', 'type' => 'array', 'items' => [ - 'description' => 'The instance ID. This parameter has the same effect as `InstanceId`.'."\n", - 'type' => 'string', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Set the value to CLOUD\\_DESKTOP.'."\n" + ."\n" + .'- The value CLOUD\\_DESKTOP specifies that the resource is a cloud desktop.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['CLOUD_DESKTOP' => ''], + 'type' => 'string', + 'required' => true, + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + 'ResourceRegionId' => ['description' => 'The region where the resource resides.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + 'ResourceProperties' => ['description' => 'The properties of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'TestProperty', 'title' => ''], + 'OwnerEndUserId' => ['description' => 'The ID of the current end user.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => true, 'example' => 'ecd-08zhejm3h7ilr****', 'title' => ''], + 'ResourceName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'required' => true, 'example' => 'DemoComputer', 'title' => ''], + 'OwnerAliUid' => ['description' => 'The ID of the Alibaba Cloud account to which the current cloud desktop belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '130247021517****', 'title' => ''], + ], 'required' => false, - 'example' => 'ecd-6ldllk9zxcpfhs****', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'required' => true, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PromotionId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'ResellerOwnerUid', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the end user who initiates the stream collaboration. If the initiator is the administrator, do not specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The information that is returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****', - ], - 'PriceInfo' => [ - 'description' => 'The price details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Rules' => [ - 'description' => 'The promotion rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The promotion rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RuleId' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '29644', - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'CoordinateFlowModels' => [ + 'description' => 'The list of stream collaboration models.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CoordinateStatus' => [ + 'description' => 'The current status of the collaboration task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- COORDINATING: The collaboration task is being executed.'."\n" + ."\n" + .'- TERMINATING: The collaboration task is being terminated.'."\n" + ."\n" + .'- TERMINATED: The collaboration task is terminated.'."\n" + ."\n" + .'- PENDING: The collaboration task is pending to be executed.', + 'enumValueTitles' => ['COORDINATING ' => '', 'TERMINATING ' => '', 'TERMINATED ' => '', 'PENDING ' => ''], + 'type' => 'string', + 'example' => 'PENDING', + 'title' => '', ], - ], - 'Price' => [ - 'description' => 'The price.'."\n", - 'type' => 'object', - 'properties' => [ - 'OriginalPrice' => [ - 'description' => 'The original price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '79.0', - ], - 'DiscountPrice' => [ - 'description' => 'The discounted amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '15.8', - ], - 'Currency' => [ - 'description' => 'The unit of currency (USD).'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'TradePrice' => [ - 'description' => 'The actual price. The actual price is the original price minus the discount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '63.2', - ], - 'Promotions' => [ - 'description' => 'The promotions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The promotion.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromotionDesc' => [ - 'description' => 'The promotion description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'OptionCode' => [ - 'description' => 'The description of the promotion rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Selected' => [ - 'description' => 'Indicates whether an item is selected.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'PromotionId' => [ - 'description' => 'The promotion ID.'."\n", - 'type' => 'string', - 'example' => 'promo_option', - ], - 'PromotionName' => [ - 'description' => 'The promotion name.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'OrderLines' => [ - 'description' => 'The orders.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The order.'."\n", - 'example' => '5376483****', - ], - ], + 'InitiatorType' => [ + 'description' => 'The type of the initiator.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ADMIN\\_INITIATE\\_FORCE: The administrator forcibly initiates the collaboration request.'."\n" + ."\n" + .'- ADMIN\\_INITIATE: The administrator initiates the collaboration request.'."\n" + ."\n" + .'- COORDINATOR\\_INITIATE\\_FORCE: The coordinator forcibly initiates the collaboration request.', + 'enumValueTitles' => ['ADMIN_INITIATE_FORCE' => '', 'ADMIN_INITIATE' => '', 'COORDINATOR_INITIATE_FORCE' => ''], + 'type' => 'string', + 'example' => 'COORDINATOR_INITIATE_FORCE', + 'title' => '', ], + 'OwnerUserId' => ['description' => 'The ID of the Alibaba Cloud account of the end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'CoordinateTicket' => ['description' => 'The ticket that is used to establish the Adaptive Streaming Protocol (ASP)-based connection.', 'type' => 'string', 'example' => '1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****', 'title' => ''], + 'CoId' => ['description' => 'The ID of the stream collaboration.', 'type' => 'string', 'example' => 'co-0sot77uale3****', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-96vi03f9emqnl****', 'title' => ''], + 'ResourceName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', + 'title' => 'ApplyCoordinationForMonitoring', + 'summary' => 'Applies for coordination monitoring. This operation is mainly used in administrator assistance scenarios and education scenarios.', + 'changeSet' => [ + ['createdAt' => '2022-07-07T03:54:26.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinationForMonitoring'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ApplyCoordinationForMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 29644\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"promo_option\\",\\n \\"PromotionName\\": \\"精选特惠\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]', - 'title' => 'DescribeRenewalPrice', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CoordinateFlowModels\\": [\\n {\\n \\"CoordinateStatus\\": \\"PENDING\\",\\n \\"InitiatorType\\": \\"COORDINATOR_INITIATE_FORCE\\",\\n \\"OwnerUserId\\": \\"alice\\",\\n \\"CoordinateTicket\\": \\"1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****\\",\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"ResourceId\\": \\"ecd-96vi03f9emqnl****\\",\\n \\"ResourceName\\": \\"DemoComputer\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'DescribeModificationPrice' => [ - 'summary' => 'Queries the price for changing the specifications of a monthly subscription cloud computer with unlimited hours or a premium bandwidth plan.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApproveFotaUpdate' => [ + 'summary' => 'Allows you to upgrade images.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of either the monthly subscription cloud computer with unlimited hours or the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ecd-0gfv2z3sf95zvt****', - ], + 'schema' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ecd-138dsptkrt00u****', 'title' => ''], ], [ - 'name' => 'InstanceType', + 'name' => 'AppVersion', 'in' => 'query', + 'schema' => ['description' => 'Mirror version.', 'type' => 'string', 'required' => true, 'example' => '0.0.1-D-20220513.143129', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The specifications.'."\n" - ."\n" - .'* Valid values when you set `ResourceType` to `Desktop`:'."\n" - ."\n" - .' * ecd.basic.small'."\n" - .' * ecd.basic.large'."\n" - .' * ecd.advanced.large'."\n" - .' * ecd.advanced.xlarge'."\n" - .' * ecd.performance.2xlarge'."\n" - .' * ecd.graphics.xlarge'."\n" - .' * ecd.graphics.2xlarge'."\n" - .' * ecd.advanced.xlarge_s8d2'."\n" - .' * ecd.advanced.xlarge_s8d7'."\n" - .' * ecd.graphics.1g72c'."\n" - .' * eds.general.2c2g'."\n" - .' * eds.general.2c4g'."\n" - .' * eds.general.2c8g'."\n" - .' * eds.general.4c8g'."\n" - .' * eds.general.4c16g'."\n" - .' * eds.general.8c16g'."\n" - .' * eds.general.8c32g'."\n" - .' * eds.general.16c32g'."\n" - ."\n" - .'* You can skip this parameter if `ResourceType` is set to `NetworkPackage`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'eds.enterprise_office.8c16g', + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ApproveFotaUpdate', + 'description' => 'The cloud computers for which you want to allow image updates must be in the Running state.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'], + ], + ], + 'ramActions' => [], + ], + 'AssociateNetworkPackage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RootDiskSizeGib', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the system disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '32768', - 'minimum' => '0', - 'example' => '80', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'UserDiskSizeGib', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the data disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '32768', - 'minimum' => '0', - 'example' => '50', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RootDiskPerformanceLevel', + 'name' => 'NetworkPackageId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the premium bandwidth plan.'."\n", 'type' => 'string', 'required' => true, 'example' => 'np-e0iodl3yzb62q****', 'title' => ''], ], [ - 'name' => 'UserDiskPerformanceLevel', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'schema' => ['description' => 'The ID of the office network. You can call the [DescribeNetworkPackages](~~216079~~) to obtain the ID of the office network to which a premium bandwidth plan is bound.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-*********', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'AssociateNetworkPackage', + 'summary' => 'Binds a premium bandwidth plan to an office network. A premium bandwidth plan is used together with only one office network.', + 'changeSet' => [ + ['createdAt' => '2022-05-30T01:26:35.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateNetworkPackage'], + ], + ], + 'ramActions' => [], + ], + 'AttachCen' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceType', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CenId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the CEN instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], + ], + [ + 'name' => 'CenOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account to which the CEN instance belongs.'."\n" + ."\n" + .'* If you own the CEN instance, you can skip this parameter.'."\n" + .'* If you do not own the CEN instance, you must specify the ID of the account that owns the CEN instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****', 'title' => ''], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => ['description' => 'The verification code. If you do not own the CEN instance, you must call the [SendVerifyCode](~~436847~~) operation to obtain a verification code.'."\n", 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The resource type. The required parameters depend on the resource type.'."\n" - ."\n" - .'* When `ResourceType` is set to `Desktop`, the required parameters are `InstanceType`, `RootDiskSizeGib`, and `UserDiskSizeGib`.'."\n" - .'* When `ResourceType` is set to `NetworkPackage`, the required parameter is `Bandwidth`.'."\n" + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', + 'title' => 'AttachCen', + 'summary' => 'Binds an advanced office network to a Cloud Enterprise Network (CEN) instance.', + 'description' => 'Prerequisites'."\n" + ."\n" + .'* A CEN instance is created.'."\n" + .'* The office network is an advanced office network, and the account system type is convenient account.'."\n" + ."\n" + .'> The office network is added to the CEN instance when you create the instance. An office network can be added to only one CEN instance.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachCen'], + ], + ], + 'ramActions' => [], + ], + 'AttachEndUser' => [ + 'summary' => 'Binds a hardware client to a user.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The serial number (SN) of the hardware client.'."\n", 'type' => 'string', 'required' => true, 'example' => '12OERSLDO7M3****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user that you want to bind to the hardware client.'."\n", 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the convenient office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => ['description' => 'The address of the Active Directory (AD) office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****', 'title' => ''], + ], + [ + 'name' => 'UserType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account type of the user.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Desktop (default): cloud computers.'."\n" - .'* NetworkPackage: premium bandwidth plans.'."\n", + .'* AD: enterprise AD account.'."\n" + .'* SIMPLE: convenience account'."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Desktop' => '', - 'NetworkPackage' => '', - ], - 'example' => 'Desktop', + 'enumValueTitles' => ['AD' => '', 'SIMPLE' => ''], + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'Bandwidth', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum public bandwidth. Unit: Mbit/s.'."\n" + 'description' => 'The type of the client.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'> Valid values when PayByTraffic is set to PayByBandwidth: 10 to 1000.'."\n", + .'* 1: hardware client.'."\n", 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'maximum' => '3072', - 'minimum' => '2', - 'example' => '20', + 'required' => true, + 'enumValueTitles' => [1 => ''], + 'example' => '1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + ], + 'example' => '', ], ], + ], + 'title' => 'AttachEndUser', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachEndUser'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'BatchModifyEntitlement' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ - 'name' => 'PromotionId', + 'name' => 'MaxUserPerDesktop', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of users assigned to each cloud computer.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '500', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxDesktopPerUser', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The number of cloud computers allocated to each user.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '500', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Strategy', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ + 'description' => 'The disproportional assignment policy. Valid values:'."\n" + ."\n" + .'AVERAGE: The system preferentially guarantees that each user is assigned with at least a cloud computer. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned a cloud computer.'."\n" + ."\n" + .'CENTRAL: The system preferentially assigns the designated number of cloud computers to each user. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned the specified number of cloud computers.', + 'enumValueTitles' => ['AVERAGE' => 'Average', 'CENTRAL' => 'Central'], 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'AVERAGE', + 'title' => '', ], ], [ - 'name' => 'ResourceSpecs', + 'name' => 'DesktopId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ + 'description' => 'The IDs of the cloud computers for which you want to modify end users.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesktopId' => [ - 'type' => 'string', - ], - 'RootDiskSizeGib' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'UserDiskSizeGib' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'maxItems' => 20, + 'items' => ['description' => 'The ID of a cloud computer for which you want to modify end users.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'."\n", 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of the users.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the user.', 'type' => 'string', 'required' => false, 'example' => 'Alice'."\n", 'title' => ''], 'required' => false, + 'docRequired' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Preview', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Whether to preview the assign results instead of actually assigning cloud computers.', 'type' => 'boolean', 'docRequired' => true, 'required' => true, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****', - ], - 'PriceInfo' => [ - 'description' => 'The price details.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'Entitlements' => [ + 'description' => 'The results.', 'type' => 'object', 'properties' => [ - 'Rules' => [ - 'description' => 'The promotion rules.'."\n", + 'Status' => [ + 'description' => 'The result.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- FAILED'."\n" + ."\n" + .'- NOT\\_STARTED'."\n" + ."\n" + .'- STARTED'."\n" + ."\n" + .'- PROCESSING'."\n" + ."\n" + .'- FINISHED', + 'enumValueTitles' => ['FAILED' => 'FAILED', 'NOT_STARTED' => 'NOT\\_STARTED', 'STARTED' => 'STARTED', 'PROCESSING' => 'PROCESSING', 'FINISHED' => 'FINISHED'], + 'type' => 'string', + 'example' => 'FINISHED', + 'title' => '', + ], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'B2F4F018-0EDF-159C-B285-117B5F1C****', 'title' => ''], + 'AssignModels' => [ + 'description' => 'The assignment results.', 'type' => 'array', 'items' => [ - 'description' => 'The promotion rule.'."\n", 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The rule description.'."\n", + 'DesktopId' => ['description' => 'The cloud computer ID.', 'type' => 'string', 'example' => 'ecd-e94kzikmpljjx99pl', 'title' => ''], + 'InnerStatus' => [ + 'description' => 'The assign result for each cloud computer.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- FAILED'."\n" + ."\n" + .'- NOT\\_STARTED'."\n" + ."\n" + .'- STARTED'."\n" + ."\n" + .'- PROCESSING'."\n" + ."\n" + .'- FINISHED', + 'enumValueTitles' => ['FAILED' => 'FAILED', 'NOT_STARTED' => 'NOT\\_STARTED', 'STARTED' => 'STARTED', 'PROCESSING' => 'PROCESSING', 'FINISHED' => 'FINISHED'], 'type' => 'string', - 'example' => '', - ], - 'RuleId' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14806', - ], - ], - ], - ], - 'Price' => [ - 'description' => 'The price information.'."\n", - 'type' => 'object', - 'properties' => [ - 'OriginalPrice' => [ - 'description' => 'The original price.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '79.0', - ], - 'DiscountPrice' => [ - 'description' => 'The discounted amount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '15.8', - ], - 'Currency' => [ - 'description' => 'The unit of currency (USD).'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'TradePrice' => [ - 'description' => 'The actual price. The actual price is the original price minus the discount.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '63.2', - ], - 'Promotions' => [ - 'description' => 'The promotion activities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The promotion activity.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromotionDesc' => [ - 'description' => 'The promotion description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'OptionCode' => [ - 'description' => 'The description of the promotion rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Selected' => [ - 'description' => 'Indicates whether an item is selected.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'PromotionId' => [ - 'description' => 'The ID of the promotion activity.'."\n", - 'type' => 'string', - 'example' => 'promo_option', - ], - 'PromotionName' => [ - 'description' => 'The name of the promotion activity.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], + 'example' => 'FINISHED', + 'title' => '', ], - ], - 'OrderLines' => [ - 'description' => 'The orders.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The order.'."\n", - 'example' => '5376483****', + 'EndUserIds' => [ + 'description' => 'The authorized user IDs for the cloud computer.', + 'type' => 'array', + 'items' => ['description' => 'The authorized user ID for the cloud computer.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48174475-5EB2-5F99-A9E9-6F892D645****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 14806\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"promo_option\\",\\n \\"PromotionName\\": \\"精选特惠\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]', - 'title' => 'DescribeModificationPrice', - ], - 'DescribeRefundPrice' => [ - 'summary' => 'Queries the refund amount for unsubscribing from a cloud computer.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Entitlements\\": {\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskId\\": \\"B2F4F018-0EDF-159C-B285-117B5F1C****\\",\\n \\"AssignModels\\": [\\n {\\n \\"DesktopId\\": \\"ecd-e94kzikmpljjx99pl\\",\\n \\"InnerStatus\\": \\"FINISHED\\",\\n \\"EndUserIds\\": [\\n \\"Alice\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'BatchModifyEntitlement', + 'summary' => 'Assigns multiple cloud computers to users in a batch.', + 'description' => '- The target cloud computers must be in the Running state.'."\n" + ."\n" + .'- This is an asynchronous API. To check the assignment status, call [](t2167745.xdita#)and refer to the `ManagementFlags` parameter. A value of `ASSIGNING` means it is in progress; otherwise, it is complete.'."\n" + ."\n" + .'- Recommended polling interval: 2–5 seconds (max duration: 50s). The process usually takes 1–5 seconds.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchModifyEntitlement'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:BatchModifyEntitlement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BindConfigGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-shanghai`.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'RefundType', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unsubscription type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RemainRefund: refunds the remaining balance and releases resources.'."\n" - .'* RenewRefund: refunds only the renewal fee and adjusts the expiration date accordingly.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'RemainRefund' => '', - 'RenewRefund' => '', - ], - 'example' => 'RemainRefund', - ], + 'schema' => ['description' => 'The ID of the configuration group.', 'type' => 'string', 'required' => true, 'example' => 'ccg-0chlk9b65lj8z****', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'ResourceInfos', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'ID of cloud computer N. Valid values of N: 1 to 20.'."\n", + 'description' => 'The resources to which you want to bind the configuration group.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', + 'description' => 'The resource to which you want to bind the configuration group.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The ID of the resource.', 'type' => 'string', 'required' => false, 'example' => 'ecd-1bo4xotjvwyon****', 'title' => ''], + 'ResourceRegionId' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RESOURCE\\_GROUP: the resource group'."\n" + ."\n" + .'- CLOUD\\_DESKTOP: the cloud computer service.', + 'enumValueTitles' => ['RESOURCE_GROUP' => '', 'CLOUD_DESKTOP' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + 'ProductType' => [ + 'description' => 'The service type of the resource.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'- CLOUD\\_DESKTOP: the cloud computer service.', + 'enumValueTitles' => ['CLOUD_DESKTOP' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + ], 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 20, - ], - ], - [ - 'name' => 'ResellerOwnerUid', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'maxItems' => 500, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'PriceInfo' => [ - 'description' => 'The price details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Currency' => [ - 'description' => 'The unit of currency (USD).'."\n", - 'type' => 'string', - 'example' => 'CNY', - ], - 'RefundFee' => [ - 'description' => 'The amount of the refund.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '3990.75', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******'], + 'GroupId' => ['description' => 'The ID of the configuration group.', 'type' => 'string', 'example' => 'ccg-0chlk9b65lj****', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"RefundFee\\": 3990.75\\n }\\n}","type":"json"}]', - 'title' => 'DescribeRefundPrice', - ], - 'ListOfficeSiteOverview' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'BindConfigGroup', + 'summary' => 'Binds a configuration group to resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:BindConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"GroupId\\": \\"ccg-0chlk9b65lj****\\"\\n}","type":"json"}]', + ], + 'CancelAutoSnapshotPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ForceRefresh', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to refresh the cache.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the automatic snapshot policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sp-78lhzpe7kjfnd****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Valid values: 1 to 100'."\n" - .'* Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'exclusiveMinimum' => true, - 'example' => '10', + 'description' => 'The IDs of the cloud computers. You can specify 1 to 50 IDs. The IDs cannot be an empty string. The IDs can be up to 64 characters in length and cannot contain `http://` or `https://`. The IDs cannot start with `acs:` or `aliyun`.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-itcmrhqt01tdl****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this is your first query or no next query is to be sent, skip this parameter. If a next query is to be sent, set the parameter to the value of NextToken that is returned from the last call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', + 'title' => 'CancelAutoSnapshotPolicy', + 'summary' => 'Cancels an automatic snapshot policy for cloud computers.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'], + ], + ], + ], + 'CancelCdsFileShareLink' => [ + 'summary' => 'Cancels a file sharing task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OfficeSiteId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CdsId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The office network IDs. You can specify IDs of 1 to 100 office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the cloud disk.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****', 'title' => ''], ], [ - 'name' => 'QueryRange', + 'name' => 'ShareId', 'in' => 'query', - 'schema' => [ - 'description' => 'The query scope. Cloud computers in a cloud computer pool are pooled cloud computers.'."\n" - ."\n" - .'Default values:'."\n" - ."\n" - .'* 1 (default): queries non-pooled cloud computers in the office network.'."\n" - .'* 2: queries pooled cloud computers in the office network.'."\n" - .'* 3: queries all cloud computers in the office network.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the file sharing task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7JQX1Fsw****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OfficeSiteOverviewResults' => [ - 'description' => 'The office network information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details about the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfficeSiteStatus' => [ - 'description' => 'The office network status.'."\n" - ."\n" - .'Default values:'."\n" - ."\n" - .'* CONFIGUSERFAILED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGISTERING'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGISTERED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGTRUST'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGUSERING'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTFAILED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ERROR'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTING'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGUSER'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CONFIGUSERFAILED' => '', - 'REGISTERING' => '', - 'REGISTERED' => '', - 'NEEDCONFIGTRUST' => '', - 'CONFIGUSERING' => '', - 'CONFIGTRUSTFAILED' => '', - 'ERROR' => '', - 'CONFIGTRUSTING' => '', - 'NEEDCONFIGUSER' => '', - ], - 'example' => 'REGISTERED', - ], - 'TotalEdsCount' => [ - 'description' => 'The total number of cloud computers in the office network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalEdsCountForGroup' => [ - 'description' => 'The total number of cloud computers in the cloud computer pool.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WillExpiredEdsCount' => [ - 'description' => 'The number of cloud computers that are about to expire in the office network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WillExpiredEdsCountForGroup' => [ - 'description' => 'The number of cloud computers that are about to expire in the cloud computer pool.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'RunningEdsCount' => [ - 'description' => 'The number of cloud computers that are running in the office network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RunningEdsCountForGroup' => [ - 'description' => 'The number of running cloud computers in the cloud computer pool.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OfficeSiteName' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'VpcType' => [ - 'description' => 'The office network type and its suitable VPC type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard (default): standard, exclusive VPC'."\n" - .'* customized: custom, user VPC'."\n" - .'* basic: basic, shared VPC', - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - 'customized' => '', - 'basic' => '', - ], - 'example' => 'standard', - ], - 'HasExpiredEdsCount' => [ - 'description' => 'The number of expired cloud computers in the office network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'HasExpiredEdsCountForGroup' => [ - 'description' => 'The number of expired cloud computers in the cloud computer pool.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the office network resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], + 'Code' => ['description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the request failed. This parameter is not returned if the value of Code is `success`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The data information.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteOverviewResults\\": [\\n {\\n \\"OfficeSiteStatus\\": \\"REGISTERED\\",\\n \\"TotalEdsCount\\": 1,\\n \\"TotalEdsCountForGroup\\": 1,\\n \\"WillExpiredEdsCount\\": 0,\\n \\"WillExpiredEdsCountForGroup\\": 0,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"RunningEdsCount\\": 1,\\n \\"RunningEdsCountForGroup\\": 1,\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"VpcType\\": \\"standard\\",\\n \\"HasExpiredEdsCount\\": 0,\\n \\"HasExpiredEdsCountForGroup\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n EC330A26-1940-4A26-A4C8-E99AE907E25B\\n \\n cn-hangzhou+dir-363353****\\n 0\\n 1\\n 0\\n 1\\n test\\n cn-hangzhou\\n REGISTERED\\n \\n","errorExample":""}]', - 'title' => 'ListOfficeSiteOverview', - 'summary' => 'Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeOfficeSites' => [ - 'summary' => 'Queries office network properties, including office network ID, name, status, and creation time.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CancelCdsFileShareLink', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCdsFileShareLink'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CancelCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CancelCoordinationForMonitoring' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52838', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~436773~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CoIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The IDs of stream collaboration tasks.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IDs of the stream collaboration task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'co-fojvd9sg7whrk****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OfficeSiteType', + 'name' => 'UserType', 'in' => 'query', 'schema' => [ - 'description' => 'The account type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience account'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* AD_CONNECTOR: enterprise Active Directory (AD) account'."\n" - ."\n" - .' '."\n" + 'description' => 'The type of the user.'."\n" ."\n" - .' '."\n" + .'Valid value:'."\n" ."\n" - .' '."\n", + .'* TENANT_ADMIN: administrator.', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'SIMPLE', + 'enumValueTitles' => ['TENANT_ADMIN' => ''], + 'example' => 'TENANT_ADMIN', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'EndUserId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the end user that initiates stream collaboration. If the initiator is the administrator, skip this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', + 'description' => 'The response parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'CancelCoordinationForMonitoring', + 'summary' => 'Cancels a remote assistance request to the end user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCoordinationForMonitoring'], + ], + ], + 'ramActions' => [], + ], + 'CancelCopyImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'NextToken', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region to which the image is copied.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ImageId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the new image in the destination region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The token that determines the start point of the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CancelCopyImage', + 'summary' => 'Cancels the operation of copying an image to another region.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCopyImage'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEFE642-A383-4A18-8939-FB7DE452****\\"\\n}","type":"json"}]', + ], + 'CloneCenterPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'OfficeSiteId', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The office network IDs. You can specify the IDs of 1 to 100 office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - 'maxItems' => 100, + 'description' => 'The region ID. Set the value to cn-shanghai.', + 'enumValueTitles' => ['cn-shanghai' => ''], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'Status', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network status.'."\n" + 'description' => 'The resource type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* REGISTERING: The office network is being registered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DEREGISTERING: The office network is being deregistered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGISTERED: The office network is registered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGTRUST: A trust relationship is required for the office network.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTFAILED: A trust relationship fails to be configured for the office network.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DEREGISTERED: The office network is deregistered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ERROR: One or more configurations of the office network are invalid.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTING: A trust relationship is being configured for the office network.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGUSER: Users are required for the office network.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" + .'- app: cloud applications.'."\n" ."\n" - .' '."\n", + .'- desktop: cloud computers.', + 'enumValueTitles' => ['app' => '', 'desktop' => ''], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'REGISTERING' => '', - 'DEREGISTERING' => '', - 'REGISTERED' => '', - 'NEEDCONFIGTRUST' => '', - 'CONFIGTRUSTFAILED' => '', - 'DEREGISTERED' => '', - 'ERROR' => '', - 'CONFIGTRUSTING' => '', - 'NEEDCONFIGUSER' => '', - ], - 'example' => 'REGISTERED', + 'required' => true, + 'docRequired' => false, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'SecurityProtection', + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => 'The security protection setting of the office network.'."\n" + 'description' => 'The business type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* SASE: SASE is configured.'."\n" - .'* OFF: No security protection setting is configured.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SASE' => 'SASE', - 'OFF' => '', - ], - 'example' => 'SASE', + .'- 1: public cloud'."\n" + ."\n" + .'- 8: commercial edition.', + 'enumValueTitles' => [1 => '', 8 => ''], + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'VpcId', + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer policy that you want to clone.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + ], + [ + 'name' => 'Name', 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer policy that you want to clone.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'testPolicyGroupName', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'example' => 'vpc-uf6bpyqivwl5f3pvoxxu0', + 'type' => 'object', + 'properties' => [ + 'PolicyGroupId' => ['description' => 'The ID of the duplicated cloud computer policy.', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CloneCenterPolicy', + 'summary' => 'Clones a policy based on an existing global policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'AccountType', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CloneCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ClonePolicyGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination cloud computer policy that you want to clone.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer policy that you want to create.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testPolicyGroupName', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'PolicyGroupId' => ['description' => 'The ID of the new cloud computer policy.', 'type' => 'string', 'example' => 'pg-7jcaznnx6go6n****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidPolicyGroup.Status', 'errorMessage' => 'The target policy group is being created. Please try again later.', 'description' => ''], + ], + ], + 'title' => 'ClonePolicyGroup', + 'summary' => 'Clones an existing policy to quickly create a policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ClonePolicyGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ClonePolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-7jcaznnx6go6n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'CompleteCdsFile' => [ + 'summary' => 'After you create an object upload task, call this operation to upload the object.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The username. You must specify at least one of `EndUserId` and `GroupId`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test0', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise drive.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai+cds-465878****', 'title' => ''], + ], + [ + 'name' => 'UploadId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file upload task. Callable interface [CreateCdsFile](~~2247619~~).'."\n", 'type' => 'string', 'required' => true, 'example' => '6C48B55A1FAC4E1A9E0579059514****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The file ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '635a316c94f40f35f5354da29b2aee88c9d1****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the team space. You must specify at least one of `EndUserId` and `GroupId`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'OfficeSites' => [ - 'description' => 'The office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The office network.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The office network status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* REGISTERING: The office network is being registered.'."\n" - .'* DEREGISTERING: The office network is being deregistered.'."\n" - .'* REGISTERED: The office network is registered.'."\n" - .'* NEEDCONFIGTRUST: A trust relationship is required for the office network.'."\n" - .'* CONFIGTRUSTFAILED: A trust relationship fails to be configured for the office network.'."\n" - .'* DEREGISTERED: The office network is deregistered.'."\n" - .'* ERROR: One or more configurations of the office network are invalid.'."\n" - .'* CONFIGTRUSTING: A trust relationship is being configured for the office network.'."\n" - .'* NEEDCONFIGUSER: Users are required for the office network.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'REGISTERING' => '', - 'DEREGISTERING' => '', - 'REGISTERED' => '', - 'NEEDCONFIGTRUST' => '', - 'CONFIGTRUSTFAILED' => '', - 'DEREGISTERED' => '', - 'ERROR' => '', - 'CONFIGTRUSTING' => '', - 'NEEDCONFIGUSER' => '', - ], - 'example' => 'REGISTERED', - ], - 'CreationTime' => [ - 'description' => 'The time when the office network was created.'."\n", - 'type' => 'string', - 'example' => '2021-05-06T05:58Z', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6tz5k67puge5jn8****', - ], - 'VpcType' => [ - 'description' => 'The VPC type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Basic'."\n" - .'* Customized'."\n" - .'* Standard'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Basic' => '', - 'Customized' => '', - 'Standard' => '', - ], - 'example' => 'Basic', - ], - 'EnableAdminAccess' => [ - 'description' => 'Indicates whether the local administrator permissions are granted to users that are authorized to use cloud computers in the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'EnableCrossDesktopAccess' => [ - 'description' => 'Indicates whether the connection between cloud computers in the office network is enabled. After you enable the connection between cloud computers in the office network, cloud computers in the office network can access each other.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DesktopVpcEndpoint' => [ - 'description' => 'The endpoint that is used to connect to cloud computers in the directory over a VPC.'."\n", - 'type' => 'string', - 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'DesktopAccessType' => [ - 'description' => 'The method that is used to connect cloud computers that reside in the office network from Alibaba Cloud Workspace clients.'."\n" - ."\n" - .'> The VPC connection depends on Alibaba Cloud PrivateLink. You can use Alibaba Cloud PrivateLink for free. When you set this parameter to `VPC` or `Any`, PrivateLink is automatically activated.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INTERNET (default): Cloud computers are connected from Alibaba Cloud Workspace clients over the Internet.'."\n" - .'* VPC: Cloud computers are connected from Alibaba Cloud Workspace clients over the VPC.'."\n" - .'* ANY: Cloud computers are connected from Alibaba Cloud Workspace clients over the Internet or the VPC. When end users connect to cloud computers from Alibaba Cloud Workspace clients, you can choose a connection method based on your business requirements.', - 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - 'ANY' => '', - ], - 'example' => 'INTERNET', - ], - 'SsoEnabled' => [ - 'description' => 'Indicates whether single sign-on (SSO) is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CidrBlock' => [ - 'description' => 'The IPv4 CIDR block of the VPC that the office network uses.'."\n", - 'type' => 'string', - 'example' => '172.16.0.0/16', - ], - 'Bandwidth' => [ - 'description' => 'The maximum public bandwidth value. Valid values: 0 to 1000.\\'."\n" - .'If you leave this parameter empty or set this parameter to 0, Internet access is not enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TrustPassword' => [ - 'description' => '> This parameter is unavailable.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Name' => [ - 'description' => 'The name of the office network. The name is unique in a region.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'EnableInternetAccess' => [ - 'description' => 'Indicates whether Internet access is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DomainPassword' => [ - 'description' => 'The password of the domain administrator.'."\n", - 'type' => 'string', - 'example' => 'testPassword', - ], - 'CustomSecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-bp1ce64o4g9mdf5u****', - ], - 'OuName' => [ - 'description' => 'The organizational unit (OU) in the AD domain to which the office network is connected.'."\n", - 'type' => 'string', - 'example' => 'example.com/Domain Controllers', - ], - 'DomainUserName' => [ - 'description' => 'The username of the domain administrator.'."\n", - 'type' => 'string', - 'example' => 'Administrator', - ], - 'SubDomainName' => [ - 'description' => 'The username of enterprise AD subdomain.'."\n", - 'type' => 'string', - 'example' => 'testSubDnsUserName', - ], - 'OfficeSiteId' => [ - 'description' => 'The IDs of the office networks.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'CenId' => [ - 'description' => 'The CEN instance ID.'."\n", - 'type' => 'string', - 'example' => 'cen-3gwy16dojz1m65****', - ], - 'CenAttachStatus' => [ - 'description' => 'The CEN instance status.'."\n", - 'type' => 'string', - 'example' => 'attached', - ], - 'MfaEnabled' => [ - 'description' => 'Indicates whether multi-factor authentication (MFA) is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'NetworkPackageId' => [ - 'description' => 'The premium bandwidth plan ID.'."\n", - 'type' => 'string', - 'example' => 'np-amtp8e8q1o9e4****', - ], - 'DnsUserName' => [ - 'description' => 'The username of a Domain Name System (DNS) user.'."\n", - 'type' => 'string', - 'example' => 'testDnsUserName ', - ], - 'OfficeSiteType' => [ - 'description' => 'The account type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: the convenience account'."\n" - .'* AD_CONNECTOR: the enterprise AD account'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'AD_CONNECTOR', - ], - 'ADConnectors' => [ - 'description' => 'Details of AD connectors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The AD connector.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConnectorStatus' => [ - 'description' => 'The status of the AD connector.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CONNECT_ERROR'."\n" - .'* RUNNING'."\n" - .'* CONNECTING (You must configure the AD domain in which the AD connector is used.)'."\n" - .'* EXPIRED'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CONNECT_ERROR' => '', - 'RUNNING' => '', - 'CONNECTING' => '', - 'EXPIRED' => '', - 'CREATING' => '', - ], - 'example' => 'RUNNING', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch that resides in the network of the AD connector.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp19ocz3erfx15uon****', - ], - 'ADConnectorAddress' => [ - 'description' => 'The connection address of the AD connector.'."\n", - 'type' => 'string', - 'example' => '172.24.*.*', - ], - 'TrustKey' => [ - 'description' => 'The trust password that is specified when you configure the AD trust relationship.'."\n", - 'type' => 'string', - 'example' => 'password123***', - ], - 'NetworkInterfaceId' => [ - 'description' => 'The ID of an elastic network interface (ENI) to which the AD connector is mounted.'."\n", - 'type' => 'string', - 'example' => 'eni-bp1i4wx78lgosrj6****', - ], - 'Specification' => [ - 'description' => 'The AD connector type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: General'."\n" - .'* 2: Advanced'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - ], - ], - ], - 'Logs' => [ - 'description' => 'Details about registration logs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The registration log.'."\n", - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'The step in the log entry.'."\n", - 'type' => 'string', - 'example' => 'CREATE_CONNECTOR', - ], - 'Message' => [ - 'description' => 'Details of the log entry.'."\n", - 'type' => 'string', - 'example' => 'code:success | message:Create Connector complete', - ], - 'TimeStamp' => [ - 'description' => 'The time when the log entry was printed.'."\n", - 'type' => 'string', - 'example' => '2021-05-12T09:42Z', - ], - 'Level' => [ - 'description' => 'The log severity.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ERROR'."\n" - .'* INFO'."\n" - .'* WARN'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'ERROR' => '', - 'INFO' => '', - 'WARN' => '', - ], - 'example' => 'INFO', - ], - ], - ], - ], - 'VSwitchIds' => [ - 'description' => 'An array of VSwitch IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp19ocz3erfx15uon****', - ], - ], - 'FileSystemIds' => [ - 'description' => 'An array of File Storage NAS (NAS) file system IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'The NAS file system ID.'."\n", - 'type' => 'string', - 'example' => '["05b534****"]', - ], - ], - 'SubDnsAddress' => [ - 'description' => 'The DNS addresses for the AD subdomains.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address for the AD subdomain.'."\n", - 'type' => 'string', - 'example' => ' ["172.24.*.*"]', - ], - ], - 'DnsAddress' => [ - 'description' => 'The DNS addresses for the AD domains.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address for the AD domain.'."\n", - 'type' => 'string', - 'example' => ' ["172.24.*.*"]', - ], - ], - 'CustomDnsAddress' => [ - 'description' => 'The custom DNS addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom DNS address.'."\n", - 'type' => 'string', - 'example' => ' ["172.24.XX.XX"]', - ], - ], - 'NeedVerifyLoginRisk' => [ - 'description' => 'Indicates whether two-factor verification is enabled when an end user logs on to an Alibaba Cloud Workspace client. This parameter is required only for convenience office networks. If two-factor verification is enabled, the system checks whether security risks exist within the logon account when a convenience user logs on to the client. If risks are detected, the system sends a verification code to the email address that is associated with the account. Then, the convenience user can log on to the client only after the user enters the correct verification code.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DesktopCount' => [ - 'description' => 'The number of cloud computers that are created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TotalEdsCount' => [ - 'description' => 'The total number of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TotalEdsCountForGroup' => [ - 'description' => 'The number of cloud computers in the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NeedVerifyZeroDevice' => [ - 'description' => 'Indicates whether the trusted device verification is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'CloudBoxOfficeSite' => [ - 'description' => 'Indicates whether the CloudBox-based office network is created.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'SsoType' => [ - 'description' => 'The SSO type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SAML.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SAML' => 'SAML', - ], - 'example' => 'null', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX'."\n" - .'* ASP'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'AdHostname' => [ - 'description' => 'The hostname of the domain controller. The hostname must comply with the hostname naming convention of Windows.'."\n", - 'type' => 'string', - 'example' => 'beijing-ad01', - ], - 'RdsLicenseStatus' => [ - 'description' => 'The remote desktop service (RDS) license status.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'RdsLicenseAddress' => [ - 'description' => 'The IP address of the RDS license.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX', - ], - 'RdsLicenseDomainName' => [ - 'description' => 'The domain name of the RDS license.'."\n", - 'type' => 'string', - 'example' => 'test.com', - ], - 'BackupDns' => [ - 'description' => 'The DNS address of the secondary domain controller.'."\n", - 'type' => 'string', - 'example' => '172.24.XX.XX', - ], - 'BackupDCHostname' => [ - 'description' => 'The hostname of the secondary domain controller.'."\n", - 'type' => 'string', - 'example' => 'beijing-ad02', - ], - 'EnableServiceRoute' => [ - 'description' => 'Indicates whether route access control is enabled for cloud services.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SubnetMode' => [ - 'description' => 'The subnet mode of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: disabled.'."\n" - .'* 1: enabled.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'SecurityProtection' => [ - 'description' => 'The security protection setting of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SASE: SASE is configured.'."\n" - .'* OFF: No security protection setting is configured.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SASE' => 'SASE', - 'OFF' => '', - ], - 'example' => 'SASE', - ], - 'CustomAccessPoint' => [ - 'description' => 'The custom endpoint of the access gateway.'."\n", - 'type' => 'string', - 'example' => 'gw-****.com', - ], - 'ResourceAmounts' => [ - 'description' => 'The number of resources.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'resourceType' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* desktop: the cloud computer.'."\n" - .'* DesktopGroup: the cloud computer share.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'desktop' => 'desktop', - 'desktopGroup' => 'desktopGroup', - ], - 'example' => 'desktop', - ], - 'amount' => [ - 'description' => 'The number of resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'description' => '', - ], - ], - 'TotalResourceAmount' => [ - 'description' => 'The number of network interface controllers (NICs).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NmVersion' => [ - 'description' => 'The network version. The new version supports App Streaming.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DEFAULT: the old version.'."\n" - .'* NM: the new version.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DEFAULT' => 'DEFAULT', - 'NM' => 'NM', - ], - 'example' => 'NM', - ], - 'AcceleratorId' => [ - 'description' => 'The ID of the GA instance.'."\n", - 'type' => 'string', - 'example' => 'ga-bp1astu3yrplkzoo2****', - ], - 'LdapUrl' => [ - 'type' => 'string', - ], - 'IsLdap' => [ - 'type' => 'boolean', - ], - 'DomainName' => [ - 'description' => 'The domain name of the enterprise AD.'."\n", - 'type' => 'string', - 'example' => 'example.com ', - ], - 'AccountType' => [ - 'type' => 'string', - ], - 'AuthorityHost' => [ - 'type' => 'string', - ], - 'TenantId' => [ - 'type' => 'string', - ], - 'ClientId' => [ - 'type' => 'string', - ], - 'EnvType' => [ - 'type' => 'string', - ], - 'VplVersion' => [ - 'type' => 'string', - ], - 'ClientSecret' => [ - 'type' => 'string', - ], - 'Eid' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"OfficeSites\\": [\\n {\\n \\"Status\\": \\"REGISTERED\\",\\n \\"CreationTime\\": \\"2021-05-06T05:58Z\\",\\n \\"VpcId\\": \\"vpc-uf6tz5k67puge5jn8****\\",\\n \\"VpcType\\": \\"Basic\\",\\n \\"EnableAdminAccess\\": true,\\n \\"EnableCrossDesktopAccess\\": false,\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"SsoEnabled\\": false,\\n \\"CidrBlock\\": \\"47.100.XX.XX\\",\\n \\"Bandwidth\\": 10,\\n \\"TrustPassword\\": \\"To be hidden.\\",\\n \\"Name\\": \\"test\\",\\n \\"EnableInternetAccess\\": false,\\n \\"DomainPassword\\": \\"testPassword\\",\\n \\"CustomSecurityGroupId\\": \\"sg-bp1ce64o4g9mdf5u****\\",\\n \\"OuName\\": \\"example.com/Domain Controllers\\",\\n \\"DomainUserName\\": \\"Administrator\\",\\n \\"SubDomainName\\": \\"testSubDnsUserName\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"CenId\\": \\"cen-3gwy16dojz1m65****\\",\\n \\"CenAttachStatus\\": \\"attached\\",\\n \\"MfaEnabled\\": false,\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"DnsUserName\\": \\"testDnsUserName\\\\t\\",\\n \\"OfficeSiteType\\": \\"AD_CONNECTOR\\",\\n \\"ADConnectors\\": [\\n {\\n \\"ConnectorStatus\\": \\"RUNNING\\",\\n \\"VSwitchId\\": \\"vsw-bp19ocz3erfx15uon****\\",\\n \\"ADConnectorAddress\\": \\"172.24.*.*\\",\\n \\"TrustKey\\": \\"password123***\\",\\n \\"NetworkInterfaceId\\": \\"eni-bp1i4wx78lgosrj6****\\",\\n \\"Specification\\": \\"1\\"\\n }\\n ],\\n \\"Logs\\": [\\n {\\n \\"Step\\": \\"CREATE_CONNECTOR\\",\\n \\"Message\\": \\"code:success | message:Create Connector complete\\",\\n \\"TimeStamp\\": \\"2021-05-12T09:42Z\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp19ocz3erfx15uon****\\"\\n ],\\n \\"FileSystemIds\\": [\\n \\"[\\\\\\"05b534****\\\\\\"]\\"\\n ],\\n \\"SubDnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"DnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"CustomDnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"NeedVerifyLoginRisk\\": false,\\n \\"DesktopCount\\": 1,\\n \\"TotalEdsCount\\": 0,\\n \\"TotalEdsCountForGroup\\": 0,\\n \\"NeedVerifyZeroDevice\\": true,\\n \\"CloudBoxOfficeSite\\": true,\\n \\"SsoType\\": \\"SAML\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"AdHostname\\": \\"beijing-ad01\\",\\n \\"RdsLicenseStatus\\": \\"2\\",\\n \\"RdsLicenseAddress\\": \\"47.100.XX.XX\\",\\n \\"RdsLicenseDomainName\\": \\"example.com\\",\\n \\"BackupDns\\": \\"172.24.XX.XX\\",\\n \\"BackupDCHostname\\": \\"beijing-ad02\\",\\n \\"EnableServiceRoute\\": false,\\n \\"SubnetMode\\": \\"0\\",\\n \\"SecurityProtection\\": \\"SASE\\",\\n \\"CustomAccessPoint\\": \\"gw-****.com\\",\\n \\"ResourceAmounts\\": [\\n {\\n \\"resourceType\\": \\"desktop\\",\\n \\"amount\\": 1\\n }\\n ],\\n \\"TotalResourceAmount\\": 1,\\n \\"NmVersion\\": \\"NM\\",\\n \\"AcceleratorId\\": \\"ga-bp1astu3yrplkzoo2****\\",\\n \\"LdapUrl\\": \\"\\",\\n \\"IsLdap\\": true,\\n \\"DomainName\\": \\"example.com\\",\\n \\"AccountType\\": \\"\\",\\n \\"AuthorityHost\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"ClientId\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"VplVersion\\": \\"\\",\\n \\"ClientSecret\\": \\"\\",\\n \\"Eid\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n F369A091-002F-49C8-AD55-02A776297C7B\\n \\n REGISTERED\\n 2021-05-06T05:58Z\\n vpc-uf6tz5k67puge5jn8****\\n Basic\\n true\\n false\\n http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\n INTERNET\\n example.com\\t\\n false\\n 172.16.0.0/16\\n 10\\n 82Tg****\\n test\\n false\\n testPassword\\n sg-bp1ce64o4g9mdf5u****\\n example.com/Domain Controllers\\n Administrator\\n testSubDnsUserName\\n cn-hangzhou+dir-363353****\\n cen-3gwy16dojz1m65****\\n false\\n np-amtp8e8q1o9e4****\\n testDnsUserName\\t\\n AD_CONNECTOR\\n \\n RUNNING\\n vsw-bp19ocz3erfx15uon****\\n 172.24.*.*\\n password123***\\n eni-bp1i4wx78lgosrj6****\\n 1\\n \\n \\n CREATE_CONNECTOR\\n code:success | message:Create Connector complete\\n 2021-05-12T09:42Z\\n INFO\\n \\n vsw-bp19ocz3erfx15uon****\\n [\\"05b534****\\"]\\n [\\"172.24.*.*\\"]\\n [\\"172.24.*.*\\"]\\n false\\n 1\\n true\\n true\\n SAML\\n HDX\\n beijing-ad01\\n \\n","errorExample":""}]', - 'title' => 'DescribeOfficeSites', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyOfficeSiteAttribute' => [ - 'summary' => 'Modifies the basic properties of an office network, including the name and local administrator permission settings.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\"\\n}","type":"json"}]', + 'title' => 'CompleteCdsFile', + 'changeSet' => [ + ['createdAt' => '2023-09-25T12:03:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteCdsFile'], + ], ], + 'ramActions' => [], + ], + 'ConfigADConnectorTrust' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-882398****', - ], - ], - [ - 'name' => 'DesktopAccessType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method to connect to cloud computers from Alibaba Cloud Workspace clients.'."\n" - ."\n" - .'> VPC connection relies on the Alibaba Cloud PrivateLink service. You can use PrivateLink for free. When you set this parameter to `VPC` or `Any`, the system automatically activates PrivateLink.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INTERNET (default): allows end users to connect to cloud computers over the Internet.'."\n" - .'* VPC: allows end users to connect to cloud computers over VPCs.'."\n" - .'* ANY: allows end users to connect to cloud computers over the Internet and VPCs. When end users connect to cloud computers from Elastic Desktop Service, you can choose a connection method based on your business requirements.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - 'Any' => '', - ], - 'example' => 'INTERNET', - ], + 'schema' => ['description' => 'The ID of the enterprise AD office network.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-778418****', 'title' => ''], ], [ - 'name' => 'OfficeSiteName', + 'name' => 'TrustKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.\\'."\n" - .'This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The trust password. You can specify the password when you configure a trust relationship between the AD domain and the ecd.acs domain.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password123***', 'title' => ''], ], [ - 'name' => 'NeedVerifyLoginRisk', + 'name' => 'RdsLicenseDomain', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable two-factor verification when an end user logs on to an Alibaba Cloud Workspace client. This parameter is required only for convenience office networks. If two-factor verification is enabled, the system checks whether security risks exist within the logon account when the end user uses a convenience user to log on to the client. If risks are detected, the system sends a verification code to the email address that is associated with the account of the convenience user. Then, the end user can log on to the client only when the verification code is correct.', + 'description' => 'Specifies whether to configure a trust password for the Remote Desktop Services (RDS) License Domain of the enterprise AD office network.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: configures a trust password for the RDS License Domain of the AD office network.'."\n" + ."\n" + .'* false: configures a trust password for a regular enterprise AD office network.', 'type' => 'boolean', 'required' => false, - 'example' => 'false', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', ], ], - [ - 'name' => 'NeedVerifyZeroDevice', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable device verification. This parameter is required only for convenience office networks. This parameter is left empty for enterprise Active Directory (AD) office networks.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ConfigADConnectorTrust', + 'summary' => 'Configures a conditional forwarder and trust relationship for a high-definition experience (HDX)-based office network (formerly workspace). You can call the operation to configure a trust relationship for an enterprise Active Directory (AD) office network.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorTrust'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n ECFA4A91-136C-5A58-9C77-858A84D60032\\r\\n","errorExample":""}]', + ], + 'ConfigADConnectorUser' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableAdminAccess', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'AuthorityHost', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'docRequired' => true, 'example' => 'cn-hangzhou', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the AD workspace.'."\n", 'example' => 'cn-hangzhou+dir-778418****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DomainName', + 'name' => 'OUName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the OU in the AD domain. You can call the [ListUserAdOrganizationUnits](~~311259~~) to obtain the OU name.'."\n", 'docRequired' => true, 'example' => 'example.com/Domain Controllers', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'DomainUserName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The username of the AD user that has the permissions to join computers to domains.'."\n" + ."\n" + .'After the username is configured, the cloud desktops in the same AD workspace are joined to the specified OU.'."\n", 'docRequired' => true, 'example' => 'Administrator', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ClientSecret', + 'name' => 'DomainPassword', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The password of the AD user that has the permissions to join computers to domains.'."\n", 'docRequired' => true, 'example' => 'testPassword', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object that is returned.'."\n", - 'type' => 'object', + 'description' => 'A collection of returned information.', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nDE6C3EE0-0061-499F-A30C-6E43BB3EF931\\r\\n","errorExample":""}]', - 'title' => 'ModifyOfficeSiteAttribute', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'Configure the organizational unit (OU) and administrator for the AD office network', + 'summary' => 'Specify an organizational unit (OU) and administrator for the Active Directory (AD) office network (formerly known as workspace).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ModifyOfficeSiteCrossDesktopAccess' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorUser'], + ], ], + 'ramActions' => [], + ], + 'CopyCdsFile' => [ + 'summary' => 'Create a copy of a file or folder in the cloud drive.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The file ID. You can call the CreateCdsFile operation to query the file ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '640985a0ca2f71f489d2497682ca0bf468de****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID that you want to use to access the cloud disk.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user01', 'title' => ''], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent folder of the folder to which you want to copy the file. If you want to copy the file to the root directory, set this parameter to root.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'root', 'title' => ''], + ], + [ + 'name' => 'AutoRename', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, + 'description' => 'Specifies whether to automatically rename the file if a file that has the same name exists in the folder to which you want to copy the file. Default value: false.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => false, 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'FileReceiverId', + 'in' => 'query', + 'schema' => ['description' => '目标复制文件所在的个人空间 ID（即 UserId，您可以在 DescribeCloudDriveUsers 接口返回的报文中获取。）或者目标复制文件所在的团队空间 ID（即 GroupId，您可以在 DescribeCloudDriveGroups 接口返回的报文中获取。）'."\n" + ."\n" + .'> FileReceiverId 和 FileReceiverType 都为空时，默认复制到文件所在的个人空间。', 'type' => 'string', 'required' => false, 'example' => 'user02', 'title' => ''], + ], + [ + 'name' => 'FileReceiverType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", + 'description' => '文件所属的空间类型。', + 'enumValueTitles' => ['user' => '个人空间', 'group' => '团队空间'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-068266****', + 'required' => false, + 'example' => 'user', + 'title' => '', ], ], [ - 'name' => 'EnableCrossDesktopAccess', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the communication between cloud computers in an office network. If you enable the communication between cloud computers in an office network, the cloud computers can access each other.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The team Space ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-hs3i1w39o68ma****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '93AD30C1-16B8-5C54-AD23-A51FF53F****', 'title' => ''], + 'Code' => ['description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'example' => 'true', + 'title' => '', + ], + 'CopyCdsFileModel' => [ + 'description' => 'The details about the file copying.', + 'type' => 'object', + 'properties' => [ + 'AsyncTaskId' => ['description' => 'The ID of the asynchronous task. This parameter is not returned if you copy a file. This parameter is returned if you copy a folder in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and details of an asynchronous task.', 'type' => 'string', 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d31****', 'title' => ''], + 'FileId' => ['description' => 'The ID of the copied file or folder.', 'type' => 'string', 'example' => '6400727cb878821bcb414615a609b4072463****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyOfficeSiteCrossDesktopAccess', - 'summary' => 'Enables or disables the communication between cloud computers in an office network (formerly workspace). If you enable the communication between cloud computers in an office network, the cloud computers can access each other.', - ], - 'DeleteOfficeSites' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Copy a file or folder', + 'changeSet' => [ + ['createdAt' => '2023-09-25T12:03:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-16T10:59:10.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyCdsFile'], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], + 'ramActions' => [ [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the office networks. You can specify 1 to 100 office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'required' => true, - 'example' => 'cn-hangzhou+dir-363353****', - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CopyCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteOfficeSites', - 'summary' => 'Deletes office networks (formerly workspaces).', - 'description' => 'Before you delete an office network, make sure that the following operations are complete:'."\n" - ."\n" - .'* All cloud computers in the office network are released.'."\n" - .'* The data that you want to retain is backed up.'."\n" - ."\n" - .'> Resources and data on cloud computers in an office network cannot be restored after you delete it. Proceed with caution.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93AD30C1-16B8-5C54-AD23-A51FF53F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"CopyCdsFileModel\\": {\\n \\"AsyncTaskId\\": \\"4221bf6e6ab43a255edc4463bffa6f5f5d31****\\",\\n \\"FileId\\": \\"6400727cb878821bcb414615a609b4072463****\\"\\n }\\n}","type":"json"}]', ], - 'ModifyOfficeSiteDnsInfo' => [ - 'summary' => 'Modifies the DNS information of an office network.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CopyImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-778418****', - ], + 'schema' => ['description' => 'The ID of the image that is copied to the destination region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], ], [ - 'name' => 'DnsAddress', + 'name' => 'DestinationImageName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IP addresses of the custom DNS servers. Up to 2 IP addresses can be specified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the custom DNS server.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.0.0.47', - ], - 'required' => false, - 'docRequired' => false, - 'maxItems' => 2, - ], + 'schema' => ['description' => 'The name of the new image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Office_Shanghai', 'title' => ''], + ], + [ + 'name' => 'DestinationDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the new image in the destination region. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'This is a test.', 'title' => ''], + ], + [ + 'name' => 'DestinationRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination region. The ID must be different from the current region ID of the image. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', - ], + 'ImageId' => ['description' => 'The ID of the image that is being copied.'."\n", 'type' => 'string', 'example' => 'm-2g65ljy3ynrdq****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '28A40F12-F340-442B-A35F-46EF6A03****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', - 'title' => 'ModifyOfficeSiteDnsInfo', - ], - 'CreateSimpleOfficeSite' => [ - 'summary' => 'Creates an office network of the convenience account type. Elastic Desktop Service supports the following types of accounts: convenience accounts and enterprise AD accounts.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-2g65ljy3ynrdq****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03****\\"\\n}","type":"json"}]', + 'title' => 'CopyImage', + 'summary' => 'Copy an image to another region. If you want to share an image across regions, you can call this operation to copy the image to the destination region and then share the image.', + 'changeSet' => [ + ['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyImage'], + ], ], + 'ramActions' => [], + ], + 'CreateADConnectorDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'CidrBlock', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IPv4 CIDR block that you want the office network to use in the virtual private cloud (VPC) of the office network. The system automatically creates a VPC for the office network based on the IPv4 CIDR block. We recommend that you set this parameter to one of the following CIDR blocks and their subnets:'."\n" - ."\n" - .'* `10.0.0.0/12` (subnet mask range: 12 to 14 bits)'."\n" - .'* `172.16.0.0/12` (subnet mask range: 12 to 24 bits)'."\n" - .'* `192.168.0.0/16` (subnet mask range: 16 to 24 bits)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '172.16.0.0/12', - ], - ], - [ - 'name' => 'CenId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Cloud Enterprise Network (CEN) instance ID.'."\n" - ."\n" - .'> If you want end users to connect to cloud computers from Alibaba Cloud Workspace clients over VPCs, you can attach the office network to a CEN instance. The CEN instance is the one that connects to your on-premises network over VPN Gateway or Express Connect.', - 'type' => 'string', - 'required' => false, - 'example' => 'cen-3gwy16dojz1m65****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CenOwnerId', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the Cloud Enterprise Network (CEN) instance belongs.'."\n" - ."\n" - .'- If you do not specify the CenId parameter, or the CEN instance that is specified by the CenId parameter belongs to the current Alibaba Cloud account, skip this parameter.'."\n" - .'- If you specify the CenId parameter and the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, enter the ID of the Alibaba Cloud account.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '118272523431****', - ], + 'schema' => ['description' => 'The fully qualified domain name (FQDN) of the enterprise AD system. The value must contain the hostname and the domain name. You can register each FQDN only once.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'corp.example.com', 'title' => ''], ], [ - 'name' => 'VerifyCode', + 'name' => 'DomainUserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code. If the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, you must call the [SendVerifyCode](~~335132~~) operation to obtain the verification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], + 'schema' => ['description' => 'The username of the domain administrator. The username can be up to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sAMAccountName', 'title' => ''], ], [ - 'name' => 'Bandwidth', + 'name' => 'DomainPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum public bandwidth. Value range: 10 to 200. Unit: Mbit/s. This parameter is available if you set `EnableInternetAccess` to `true`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The password of the domain administrator. The password can be up to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testPassword', 'title' => ''], ], [ - 'name' => 'OfficeSiteName', + 'name' => 'DirectoryName', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network name. The name must be 2 to 255 characters in length. It can contain digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestOfficeSite_Simple', - ], + 'schema' => ['description' => 'The directory name. The name must be 2 to 255 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDirectoryName', 'title' => ''], ], [ - 'name' => 'EnableInternetAccess', + 'name' => 'EnableAdminAccess', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable Internet access.'."\n" + 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" + .'* '."\n" ."\n" - .' '."\n" + .' true'."\n" ."\n" .' '."\n" ."\n" + .' (default)'."\n" + ."\n" .' '."\n" ."\n" - .'* false (default)'."\n" + .'* '."\n" ."\n" - .' '."\n" + .' false'."\n" ."\n" .' '."\n" ."\n" .' '."\n", 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'enumValueTitles' => ['true' => 'To grant the local administrator permission [Default]', 'false' => 'Not to grant the local administrator permission'], + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'EnableAdminAccess', + 'name' => 'DesktopAccessType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" + 'description' => 'The method in which the cloud computer is connected.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true (default)'."\n" - .'* false', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - [ - 'name' => 'DesktopAccessType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method to connect to cloud computers from Alibaba Cloud Workspace clients.'."\n" + .'* VPC'."\n" + ."\n" + .' '."\n" ."\n" - .'> The VPC connection depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. When you set this parameter to VPC or Any, PrivateLink is automatically activated.````', + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Internet (default)'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Any'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'VPC' => '', - 'Internet' => '', - 'Any' => '', - ], + 'enumValueTitles' => ['VPC' => 'Only connect through VPC', 'Internet' => 'Only connect through the Internet [Default]', 'Any' => 'Both VPC and Internet are supported'], 'example' => 'Internet', + 'title' => '', ], ], [ - 'name' => 'NeedVerifyZeroDevice', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable trusted device verification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - [ - 'name' => 'VSwitchId', + 'name' => 'SubDomainName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the vSwitches that you want to specify in VPCs. This parameter is required only when you create CloudBox-based office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the vSwitch that you want to specify in a VPC. This parameter is required only when you create a CloudBox-based office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp12mw1f8k3jgy****', - ], - 'required' => false, - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The FQDN of the enterprise AD subdomain. The value must contain the hostname and the subdomain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'child.example.com', 'title' => ''], ], [ - 'name' => 'CloudBoxOfficeSite', + 'name' => 'MfaEnabled', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to create a CloudBox-based office network.'."\n" + 'description' => 'Specifies whether to enable Multi-Factor Authentication (MFA). After you enable MFA, all AD users in the directory must enter a dynamic verification code generated by the virtual MFA device in addition to a correct password when they log on to a cloud computer.'."\n" + ."\n" + .'> When end users log on to a cloud computer for the first time, they must bind an MFA device.'."\n" ."\n" .'Valid values:'."\n" ."\n" @@ -4107,88 +2702,78 @@ ."\n" .' '."\n" ."\n" - .'* false'."\n" + .'* '."\n" ."\n" - .' '."\n" + .' false (default)'."\n" ."\n" .' '."\n" ."\n" .' '."\n", 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], + 'enumValueTitles' => ['true' => 'To enable MFA', 'false' => 'To disable MFA [Default]'], 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'VpcType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The network type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard: advanced'."\n" - .'* basic: basic', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'standard' => '', - 'basic' => '', - ], - 'example' => 'standard', - ], - ], - [ - 'name' => 'AccountType', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'AuthorityHost', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - [ - 'name' => 'DomainName', + 'name' => 'DnsAddress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The IP address of the DNS server corresponding to the enterprise AD. You can specify only one IP address. Make sure that the specified IP address is accessible in the network of the selected vSwitch.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], + 'required' => true, + 'example' => '127.0.**.**', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'ClientId', + 'name' => 'VSwitchId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'Details of the vSwitch IDs. You can specify only one vSwitch ID.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp19ocz3erfx15uon****', 'title' => ''], + 'required' => true, + 'example' => 'vsw-bp19ocz3erfx15uon****', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'ClientSecret', + 'name' => 'SubDomainDnsAddress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The DNS address of the existing AD subdomain.\\'."\n" + .'If you specify the `SubDomainName` parameter but you do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the existing AD subdomain.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], + 'required' => false, + 'example' => '127.0.**.**', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'Eid', + 'name' => 'Specification', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The type of the AD connector.'."\n" + ."\n" + .'Valid values:'."\n" + .'- 1 (General)'."\n" + .'- 2 (Advanced)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [1 => 'General', 'Advanced'], + 'example' => '1', + 'title' => '', ], ], ], @@ -4198,341 +2783,177 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', + 'TrustPassword' => ['description' => 'The AD trust password.'."\n", 'type' => 'string', 'example' => '82Tg****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF', 'title' => ''], + 'DirectoryId' => ['description' => 'The ID of the AD directory.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'AdConnectors' => [ + 'description' => 'The details of AD connectors.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'AD Connector.', + 'type' => 'object', + 'properties' => [ + 'Address' => ['description' => 'The connection address.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NetworkSpace.VpcInfoExist', - 'errorMessage' => 'vpc info already exist.', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OfficeSiteId\\": \\"cn-hangzhou+os-c5cy7q578s8jc****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n cn-hangzhou+os-c5cy7q578s8jc****\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]', - 'title' => 'CreateSimpleOfficeSite', + 'title' => 'CreateADConnectorDirectory', + 'summary' => 'Creates a directory of the Active Directory (AD) type.', + 'description' => 'An AD directory is used to connect to an enterprise\'s existing Active Directory and is suitable for large-scale cloud computer deployment. You are charged directory fees when you connect your AD to cloud computers. For more information, see [Billing overview](~~188395~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ActivateOfficeSite' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the convenience office network that is locked.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-803704****', - ], - ], + 'changeSet' => [ + ['createdAt' => '2022-11-14T06:21:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Request parameters changed'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorDirectory'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\r\\n","errorExample":""}]', - 'title' => 'ActivateOfficeSite', - 'summary' => 'Unlocks a convenience office network that is automatically locked due to a long idle period of time.', - 'description' => 'If you do not create any cloud computer in a convenience office network within 15 days, the office network is automatically locked and virtual private cloud (VPC) resources are released. If you want to resume the office network, you can call this operation to unlock the office network.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"RequestId\\": \\"3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"AdConnectors\\": [\\n {\\n \\"Address\\": \\"127.0.XX.XX\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\n \\n
127.0.**.**
\\n \\n","errorExample":""}]', ], 'CreateADConnectorOfficeSite' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'create', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'CidrBlock', 'in' => 'query', - 'schema' => [ - 'description' => 'The IPv4 CIDR block of the virtual private cloud (VPC) that your office network uses. The system creates a VPC for your office network based on the IPv4 CIDR block. We recommend that you set this parameter to one of the following CIDR blocks and their subnets:'."\n" - ."\n" - .'* `10.0.0.0/12` (subnet mask range: 12 to 24 bits)'."\n" - .'* `172.16.0.0/12` (subnet mask range: 12 to 24 bits)'."\n" - .'* `192.168.0.0/16` (subnet mask range: 16 to 24 bits)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX', - ], + 'schema' => ['description' => 'The IPv4 CIDR block for the office site\'s VPC. The system uses this IPv4 CIDR block to automatically create a VPC. We recommend that you use one of the following CIDR blocks or their subnets:'."\n" + ."\n" + .'- `10.0.0.0/12` (The subnet mask length must be 12 to 24 bits.)'."\n" + ."\n" + .'- `172.16.0.0/12` (The subnet mask length must be 12 to 24 bits.)'."\n" + ."\n" + .'- `192.168.0.0/16` (The subnet mask length must be 16 to 24 bits.)', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX', 'title' => ''], ], [ 'name' => 'CenOwnerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account that creates the Cloud Enterprise Network (CEN) instance.'."\n" - ."\n" - .'* If you do not specify the CenId parameter, or the CEN instance that is specified by the CenId parameter belongs to the current Alibaba Cloud account, skip this parameter.'."\n" - .'* If you specify the CenId parameter and the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, enter the ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '102681951715****', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that owns the Cloud Enterprise Network (CEN) instance.'."\n" + ."\n" + .'- If you do not specify `CenId`, or the specified CEN instance belongs to your Alibaba Cloud account, you do not need to specify this parameter.'."\n" + ."\n" + .'- If the specified CEN instance belongs to another Alibaba Cloud account, you must specify that account\'s ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****', 'title' => ''], ], [ 'name' => 'CenId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the CEN instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cen-3gwy16dojz1m65****', - ], + 'schema' => ['description' => 'The ID of the CEN instance.', 'type' => 'string', 'required' => false, 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], ], [ 'name' => 'VerifyCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code. If the CEN instance that you specify for the CenId parameter belongs to another Alibaba Cloud account, you must call the [SendVerifyCode](~~436847~~) operation to obtain the verification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => 'The verification code. If the `CenId` that you specify belongs to another Alibaba Cloud account, you must first call the [SendVerifyCode](~~436847~~) operation to obtain the verification code.', 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''], ], [ 'name' => 'Bandwidth', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum public bandwidth of the Internet access package. Valid values: 0 to 200.\\'."\n" - .'If you do not specify this parameter or you set this parameter to 0, Internet access is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The peak public bandwidth, specified in Mbit/s. The value can range from 0 to 200.
'."\n" + .'If you omit this parameter or set it to 0, internet access is disabled.
', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the enterprise AD system. You can register each domain name only once.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The domain name for the enterprise AD. Each domain name must be unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com', 'title' => ''], ], [ 'name' => 'DomainUserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the domain administrator. The username can be up to 64 characters in length.'."\n" - ."\n" - .'> Specify the username by using sAMAccountName instead of userPrincipalName.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Administrator', - ], + 'schema' => ['description' => 'The domain administrator\'s username. The username cannot exceed 64 characters in length.'."\n" + ."\n" + .'> Use the sAMAccountName, not the userPrincipalName.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Administrator', 'title' => ''], ], [ 'name' => 'DomainPassword', 'in' => 'query', + 'schema' => ['description' => 'The domain administrator\'s password. The password cannot exceed 64 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testPassword', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the office site. The name must be 2 to 255 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).
'."\n" + .'This parameter is empty by default.
', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'EnableAdminAccess', + 'in' => 'query', 'schema' => [ - 'description' => 'The password of the domain administrator. The password can be up to 64 characters in length.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to grant local administrator permissions to cloud desktop users. Default: true.', + 'enumValueTitles' => ['true' => 'Grants local administrator permissions.', 'false' => 'Does not grant local administrator permissions.'], + 'type' => 'boolean', 'required' => false, - 'docRequired' => false, - 'example' => 'testPassword', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteName', + 'name' => 'DesktopAccessType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.\\'."\n" - .'This parameter is empty by default.'."\n", + 'description' => 'The method for connecting to cloud desktops.'."\n" + ."\n" + .'> VPC connections are established using Alibaba Cloud PrivateLink, which is a free service. If you set this parameter to `VPC` or `Any`, PrivateLink is automatically enabled.', + 'enumValueTitles' => ['VPC' => 'Connections are allowed only from within a VPC.', 'Internet' => 'Connections are allowed only over the internet. (Default)', 'Any' => 'Connections are allowed from a VPC or over the internet. You can choose the connection method.'], 'type' => 'string', 'required' => false, - 'example' => 'test', + 'example' => 'Internet', + 'title' => '', ], ], [ - 'name' => 'EnableAdminAccess', + 'name' => 'EnableInternetAccess', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* '."\n" - ."\n" - .' true'."\n" - ."\n" - .' '."\n" - ."\n" - .' (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - [ - 'name' => 'DesktopAccessType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method to connect to cloud computers from Alibaba Cloud Workspace clients.'."\n" - ."\n" - .'> The VPC connection depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. When you set this parameter to `VPC` or `Any`, PrivateLink is automatically activated.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- Internet: connects clients to cloud desktops only over the Internet. [Default]'."\n" - .'- VPC: connects clients to cloud desktops only over a VPC.'."\n" - .'- Any: connects clients to cloud desktops over the Internet or a VPC. You can select a connection method based on your business requirements when you connect to your cloud desktop from a client.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'VPC' => '', - 'Internet' => '', - 'Any' => '', - ], - 'example' => 'Internet', - ], - ], - [ - 'name' => 'EnableInternetAccess', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Internet access.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'This parameter is deprecated. Use the `Bandwidth` parameter to manage internet access.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SubDomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the enterprise AD subdomain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'child.example.com', - ], + 'schema' => ['description' => 'The domain name of the enterprise AD child domain.', 'type' => 'string', 'required' => false, 'example' => 'child.example.com', 'title' => ''], ], [ 'name' => 'MfaEnabled', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable multi-factor authentication (MFA).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to enable multi-factor authentication (MFA).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'DnsAddress', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IP address of the DNS server of the enterprise AD system. You can specify only one IP address.'."\n", + 'description' => 'An array that contains the IP address of the DNS server for the enterprise AD. You can specify only one IP address.', 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the DNS server of the enterprise AD system. You can specify only one IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'items' => ['description' => 'The IP address of the DNS server.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], 'required' => true, 'example' => '192.168.XX.XX', 'maxItems' => 1, + 'title' => '', ], ], [ @@ -4540,5820 +2961,4531 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The DNS address of the enterprise AD subdomain. If you specify `SubDomainName` but do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", + 'description' => 'The DNS address of the enterprise AD child domain. If you specify `SubDomainName` but not this parameter, the DNS address of the child domain is considered the same as that of the parent domain.', 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address of the enterprise AD subdomain. If you specify `SubDomainName` but do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '192.168.XX.XX', - ], + 'items' => ['description' => 'The DNS address of the enterprise AD child domain. If you specify `SubDomainName` but not this parameter, the DNS address of the child domain is considered the same as that of the parent domain.', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX', 'title' => ''], 'required' => false, 'example' => '192.168.XX.XX', 'maxItems' => 1, + 'title' => '', ], ], [ 'name' => 'Specification', 'in' => 'query', 'schema' => [ - 'description' => 'The AD connector type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: General'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2: Advanced'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The AD Connector type.', + 'enumValueTitles' => [1 => 'General Purpose', 'Advanced'], 'type' => 'integer', 'format' => 'int64', 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], 'example' => '1', + 'title' => '', ], ], [ 'name' => 'AdHostname', 'in' => 'query', - 'schema' => [ - 'description' => 'The hostname of the domain controller. The hostname must comply with the naming conventions for Windows hosts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'beijing-ad01', - ], + 'schema' => ['description' => 'The domain controller hostname.'."\n" + .'The hostname must comply with Windows hostname naming conventions.', 'type' => 'string', 'required' => false, 'example' => 'beijing-ad01', 'title' => ''], ], [ 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Adaptive Streaming Protocol (ASP)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The protocol type.', + 'enumValueTitles' => ['ASP' => 'The ASP protocol.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASP' => '', - ], 'example' => 'ASP', + 'title' => '', ], ], [ 'name' => 'BackupDns', 'in' => 'query', - 'schema' => [ - 'description' => 'The DNS address of the backup domain controller.', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.2.100', - ], + 'schema' => ['description' => 'The DNS address of the backup domain controller.', 'type' => 'string', 'required' => false, 'example' => '192.168.2.100', 'title' => ''], ], [ 'name' => 'BackupDCHostname', 'in' => 'query', - 'schema' => [ - 'description' => 'The hostname of the backup domain controller.', - 'type' => 'string', - 'required' => false, - 'example' => 'dc002', - ], + 'schema' => ['description' => 'The hostname of the backup domain controller.', 'type' => 'string', 'required' => false, 'example' => 'dc002', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The array of the vSwitch IDs.', + 'description' => 'The list of vSwitch IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The vSwitch ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf68bgq7rjwbqpg0****', - ], + 'items' => ['description' => 'A vSwitch ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf68bgq7rjwbqpg0****', 'title' => ''], 'required' => false, 'maxItems' => 2, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AccessAttribute', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NetworkSpace.VpcInfoExist', - 'errorMessage' => 'vpc info already exist.', - ], + ['errorCode' => 'NetworkSpace.VpcInfoExist', 'errorMessage' => 'vpc info already exist.', 'description' => 'Office network already exists for the corresponding VPC'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]', 'title' => 'CreateADConnectorOfficeSite', - 'summary' => 'Creates an enterprise Active Directory (AD) office network (formerly workspace). Elastic Desktop Service supports the following types of accounts: convenience accounts and enterprise AD accounts.', - 'description' => 'When you create an enterprise AD office network, the system automatically creates an AD connector to connect to an enterprise AD. You are charged for the AD connector. For more information, see [Billing overview](~~188395~~).'."\n" + 'summary' => 'WUYING Workspace supports two account types: convenience accounts and Enterprise AD accounts. This operation creates an office network (formerly known as a workspace) for Enterprise AD accounts.', + 'description' => 'When you create an AD office network, an AD Connector is automatically created to connect to your enterprise AD. You are charged for the AD Connector. For more information, see [billing overview](~~188395~~).'."\n" ."\n" - .'After you call this operation to create an AD office network, you must perform the following steps to complete AD domain setting:'."\n" + .'After creating an AD office network, you must also configure the AD domain. Follow these steps:'."\n" ."\n" - .'1. Configure a conditional forwarder in a Domain Name System (DNS) server.'."\n" + .'1. Configure a conditional forwarder on your DNS server.'."\n" ."\n" - .'2. Configure a trust relationship in an AD domain controller and call the [ConfigADConnectorTrust](~~311258~~) operation to configure the trust relationship with the AD office network.'."\n" + .'2. Establish a trust relationship on your domain controller, and then call [ConfigADConnectorTrust](~~311258~~) to configure this trust for the AD office network.'."\n" ."\n" - .'3. Call the [ListUserAdOrganizationUnits](~~311259~~) operation to query a list of organizational units (OUs) of the AD domain, and call the [ConfigADConnectorUser](~~311262~~) operation to specify an OU and administrator for the AD office network.'."\n" + .'3. Call [ListUserAdOrganizationUnits](~~311259~~) to list the organizational units (OUs) in your AD domain. Then, call [ConfigADConnectorUser](~~311262~~) to specify the OUs and an administrator for the AD office network.'."\n" ."\n" - .' > When you create the AD office network, take note of the DomainUserName and DomainPassword parameters. If you specify the parameters, you need to only configure a conditional forwarder. If you do not specify the parameters, you must configure a conditional forwarder, trust relationship, and OU as prompted.'."\n" + .' > If you provide domain administrator credentials (DomainUserName and DomainPassword) when you create the AD office network, you only need to configure a conditional forwarder. If you do not provide these credentials, you must configure a conditional forwarder, establish a trust relationship, and specify the organizational units (OUs).'."\n" ."\n" - .'For more information, see [Create and manage enterprise AD office networks](~~214469~~).', + .'For more information, see [Create and manage office networks for enterprise AD accounts](~~214469~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListUserAdOrganizationUnits' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-10-23T08:47:39.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2024-06-26T07:31:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorOfficeSite'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateADConnectorOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]', + ], + 'CreateAndBindNasFileSystem' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~DescribeRegions~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'FileSystemName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the NAS file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'szy-asp-upm-test', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the NAS file system.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'newDescription', 'title' => ''], + ], + [ + 'name' => 'StorageType', 'in' => 'query', 'schema' => [ - 'description' => 'The enterprise AD office network ID.'."\n", + 'description' => 'The storage specification type of the NAS file system.', + 'enumValueTitles' => ['Capacity' => 'Capacity [default value]', 'Performance' => 'Performance.'], 'type' => 'string', 'required' => true, - 'example' => 'cn-hangzhou+dir-485361****', + 'docRequired' => true, + 'example' => 'Capacity', + 'title' => '', ], ], [ - 'name' => 'Filter', + 'name' => 'EncryptType', 'in' => 'query', 'schema' => [ - 'description' => 'The string that you enter for fuzzy search.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether the file system uses a KMS-managed key to encrypt data at rest. Encrypted data does not need to be decrypted during read and write operations.'."\n" + ."\n" + .'> NAS-managed keys are supported when `FileSystemType` is set to `standard` or `extreme`. User-managed keys are supported when `FileSystemType` is set to `extreme`.', + 'enumValueTitles' => ['not encrypted [default value]', 'NAS-managed key.', 'user-managed key.'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'develop', + 'docRequired' => false, + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request or if no next request exists. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CAAAAA==', - ], + 'schema' => ['description' => 'The ID of the office network.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing+dir-15657*****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DesktopGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the shared cloud computer.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-fh0vdzyh6rdc*****', 'title' => ''], + ], + [ + 'name' => 'EndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'maximum' => '500', - 'example' => '100', + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OUNames' => [ - 'description' => 'The OUs of the AD domain.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the OU in the AD domain.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfficeSiteId' => [ - 'description' => 'The enterprise AD office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-485361****', - ], - 'OUName' => [ - 'description' => 'The canonical name (CNAME) of the OU in the AD domain controller.'."\n", - 'type' => 'string', - 'example' => 'example.com/wuying_computers', - ], - 'DisplayOUName' => [ - 'description' => 'The name of the OU.'."\n", - 'type' => 'string', - 'example' => 'wuying_computers', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'A pagination token.'."\n", - 'type' => 'string', - 'example' => 'CAAAAA==', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OUNames\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-485361****\\",\\n \\"OUName\\": \\"example.com/wuying_computers\\",\\n \\"DisplayOUName\\": \\"wuying_computers\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n example.com/Domain Controllers\\n cn-hangzhou+dir-485361****\\n \\n 28978806-3938-5774-B107-0DAEC97C5BD1\\n","errorExample":""}]', - 'title' => 'ListUserAdOrganizationUnits', - 'summary' => 'Obtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace).', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListOfficeSiteUsers' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Create and bind a NAS file system', + 'summary' => 'Creates a NAS file system and binds it to the office network of a shared cloud computer.', + 'changeSet' => [ + ['createdAt' => '2022-09-05T12:56:12.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAndBindNasFileSystem'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateAndBindNasFileSystem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateAutoSnapshotPolicy' => [ + 'summary' => 'Creates an automatic snapshot policy that schedules snapshots for WUYING Workspace based on a cron expression.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. For more information, see [DescribeRegions](~~196646~~) to get a list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'PolicyName', 'in' => 'query', - 'schema' => [ - 'description' => 'The query string for fuzzy query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*jin*', - ], + 'schema' => ['description' => 'The name of the automatic snapshot policy. It can contain 2 to 128 English or Chinese characters. It must start with a letter or a Chinese character, and cannot start with `http://` or `https://`. It can contain digits, colons (:), underscores (\\_), or hyphens (-). Default value: empty.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 2, 'example' => 'test_auto_policy', 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'RetentionDays', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID. The office network must be of the enterprise AD account type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'schema' => ['description' => 'The retention period of the automatic snapshot, in days. Valid values: 1 to 180.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'CronExpression', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request or if no next query exists. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The cron expression for the recurring schedule.', 'type' => 'string', 'required' => true, 'example' => '0 0 2 ? * 1-7', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DiskType', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Valid values: 1 to 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'type' => 'object', + 'properties' => [ + 'PolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'example' => 'sp-3hpa78d0qyt99****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CreateAutoSnapshotPolicy', + 'changeSet' => [ + ['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-12T07:12:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-04T08:50:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-02T02:41:20.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyId\\": \\"sp-3hpa78d0qyt99****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', + ], + 'CreateBandwidthResourcePackages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'OUPath', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The organizational unit (OU) of the specified AD domain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'example.com/Domain Controllers', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AssignedInfo', + 'name' => 'PackageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The size of the data transfer plan. Valid values: 10 to 1000. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '12000', 'minimum' => '10', 'example' => '100', 'title' => ''], ], [ - 'name' => 'SortType', + 'name' => 'Amount', + 'in' => 'query', + 'schema' => ['description' => 'The number of the data transfer plans that you want to create at the same time. Valid values: 1 to 20. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration. The valid values of this parameter vary based on the value of `PeriodUnit`.'."\n" + ."\n" + .'* If `PeriodUnit` is set to `Month`, the valid values of Period are 1, 3, and 6.'."\n" + .'* If `PeriodUnit` is set to `Year`, the valid value of Period is 1.'."\n" + ."\n" + .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ + 'description' => 'The unit of the subscription duration.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Month (default)'."\n" + .'* Year'."\n", 'type' => 'string', 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['Month' => '', 'Year' => ''], + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'IncludeAssignedUser', + 'name' => 'AutoPay', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to enable the auto-payment feature.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the promotional activity.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', - ], - 'Users' => [ - 'description' => 'The usernames of the AD accounts.\\'."\n" - .'If the only Administrator and Guest users exist in the enterprise AD directory, an empty User array is returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username of the AD account.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUser' => [ - 'description' => 'The username of the AD account.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DisplayName' => [ - 'description' => 'The display name of the AD account.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'AssignedDesktopNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Email' => [ - 'type' => 'string', - ], - 'Phone' => [ - 'type' => 'string', - ], - 'UserPrincipalName' => [ - 'type' => 'string', - ], - 'DisplayNameNew' => [ - 'type' => 'string', - ], - ], - ], - ], + 'OrderId' => ['description' => 'The ID of the order.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24251717783****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of a request.'."\n", 'type' => 'string', 'example' => 'AE7B699F-625C-587E-BC5F-1395CA969681', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"aduser\\",\\n \\"DisplayName\\": \\"aduser\\",\\n \\"AssignedDesktopNumber\\": 0,\\n \\"Email\\": \\"\\",\\n \\"Phone\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\n \\n Alice\\n \\n","errorExample":""}]', - 'title' => 'ListOfficeSiteUsers', - 'summary' => 'Queries information about Active Directory (AD) accounts after an enterprise AD office network (formerly workspace) interconnects to an AD domain.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyADConnectorOfficeSite' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA969681\\"\\n}","type":"json"}]', + 'title' => 'CreateBandwidthResourcePackages', + 'summary' => 'Creates data transfer plans.', + 'changeSet' => [ + ['createdAt' => '2021-12-10T09:24:41.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBandwidthResourcePackages'], + ], ], + 'ramActions' => [], + ], + 'CreateBundle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], ], [ - 'name' => 'DomainName', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the enterprise AD system. You can register each domain name only once.', - 'type' => 'string', - 'required' => false, - 'example' => 'example.com', - ], + 'schema' => ['description' => 'The instance type of the cloud computers. You can call the [DescribeBundles](~~436974~~) operation to query cloud computer templates and obtain the instance types supported by the cloud computers from the `DesktopType` response parameter.'."\n" + ."\n" + .'> If you want the template to use a non-GPU-accelerated image, you can only select a non-GPU-accelerated instance type. If you want the template to use a GPU-accelerated image, you can only select a GPU-accelerated instance type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eds.enterprise_office.2c4g', 'title' => ''], ], [ - 'name' => 'DomainUserName', + 'name' => 'RootDiskSizeGib', 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the domain administrator. The username can be up to 64 characters in length.'."\n" - ."\n" - .'> Specify the value of the sAMAccountName parameter instead of the value of the userPrincipalName parameter as the username.', - 'type' => 'string', - 'required' => false, - 'example' => 'Administrator', - ], + 'schema' => ['description' => 'The size of the system disk. Unit: GiB. The value of this parameter must be consistent with the system disk size supported by the cloud computer instance type. For more information, see [Overview](~~188609~~).', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '80', 'title' => ''], ], [ - 'name' => 'DomainPassword', + 'name' => 'BundleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer template.', 'type' => 'string', 'required' => false, 'example' => 'testBundleName', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the cloud computer template.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'description' => 'The password of the domain administrator. The username can be up to 64 characters in length.', + 'description' => 'The OS language. This parameter is available only for system images. Valid values:'."\n" + ."\n" + .'- zh-CN: Simplified Chinese'."\n" + ."\n" + .'- zh-HK: Traditional Chinese (Hong Kong)'."\n" + ."\n" + .'- en-US: American English'."\n" + ."\n" + .'- ja-JP: Japanese', + 'enumValueTitles' => ['en-US' => '', 'zh-HK' => '', 'zh-CN' => '', 'ja-JP' => ''], 'type' => 'string', 'required' => false, - 'example' => 'testPassword', + 'example' => 'zh-CN', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteName', + 'name' => 'UserDiskSizeGib', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => 'The data disk sizes. You can configure only one data disk.', + 'type' => 'array', + 'items' => ['description' => 'The data disk size. You can configure only one data disk. Unit: GiB. The value of this parameter must be consistent with the data disk size supported by the cloud computer instance type. For more information, see [Overview](~~188609~~).'."\n" + ."\n" + .'> The value of the UserDiskSizeGib parameter in the template must be greater than the value of the DataDiskSize parameter in the image.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], + 'required' => true, + 'example' => '70', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'SubDomainName', + 'name' => 'RootDiskPerformanceLevel', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the subdomain in the enterprise AD domain.'."\n", + 'description' => 'The performance level (PL) of the system disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see [Enhanced SSDs](~~122389~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- PL1'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- PL0'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- PL3'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- PL2'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], 'type' => 'string', 'required' => false, - 'example' => 'childexample.com', + 'example' => 'PL1', + 'title' => '', ], ], [ - 'name' => 'MfaEnabled', + 'name' => 'UserDiskPerformanceLevel', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable multi-factor authentication (MFA).'."\n" + 'description' => 'The PL of the data disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see [Enhanced SSDs](~~122389~~).'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" + .'- PL1'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .'* false'."\n" + .'- PL0'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n", - 'type' => 'boolean', + .' '."\n" + ."\n" + .'- PL3'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- PL2'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'PL1', + 'title' => '', ], ], - [ - 'name' => 'DnsAddress', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IP addresses of the DNS servers corresponding to the enterprise ADs. You can specify only one DNS IP address.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.*.*', + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'BundleId' => ['description' => 'The ID of the cloud computer template.', 'type' => 'string', 'example' => 'b-cezrnfgecbich****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'required' => false, - 'example' => '127.0.*.*', - 'maxItems' => 1, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SubDomainDnsAddress', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IP addresses of the DNS servers corresponding to the enterprise AD subdomains. You can specify only one DNS IP address. If you specify `SubDomainName` and leave this parameter empty, the value is the same as that of the enterprise AD domain.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD subdomain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.*.*', + ], + 'title' => 'CreateBundle', + 'summary' => 'Creates a custom cloud computer template.', + 'description' => 'Cloud computer templates include system templates and custom templates. A system template is the default template provided by Alibaba Cloud. You can call this operation to create a custom template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBundle'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateBundle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'example' => '127.0.*.*', - 'maxItems' => 1, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"BundleId\\": \\"b-cezrnfgecbich****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'CreateCdsFile' => [ + 'summary' => 'Create a folder or initiate a file upload task in the cloud disk.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AdHostname', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.', - 'type' => 'string', - 'required' => false, - 'example' => 'beijing-ad01', - ], + 'schema' => ['description' => 'Region ID. Call [DescribeRegions](~~196646~~) to list regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OUName', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the organizational unit (OU) in the AD domain. You can call the [ListUserAdOrganizationUnits](~~311259~~) operation to obtain OUs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oldad.com/Domain Controllers', - ], + 'schema' => ['description' => 'User ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test1', 'title' => ''], ], [ - 'name' => 'BackupDns', + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'Enterprise cloud disk ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-82414*****', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'File name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 256, 'minLength' => 1, 'example' => 'testFile.txt', 'title' => ''], + ], + [ + 'name' => 'FileType', 'in' => 'query', 'schema' => [ - 'description' => 'The IP address of the DNS server corresponding to the secondary domain controller.'."\n", + 'description' => 'File type.', + 'enumValueTitles' => ['file' => 'File', 'folder' => 'Folder'], 'type' => 'string', - 'required' => false, - 'example' => '192.168.2.100', + 'required' => true, + 'docRequired' => true, + 'example' => 'file', + 'title' => '', ], ], [ - 'name' => 'BackupDCHostname', + 'name' => 'ParentFileId', + 'in' => 'query', + 'schema' => ['description' => 'Parent file ID. Get this from the `FileId` parameter returned by the [ListCdsFiles](~~2247622~~) API.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '637c9163b453b1a384874264ba79f3f9eab9****', 'title' => ''], + ], + [ + 'name' => 'FileLength', + 'in' => 'query', + 'schema' => ['description' => 'File size. Unit: Byte.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1048576', 'title' => ''], + ], + [ + 'name' => 'FileHash', + 'in' => 'query', + 'schema' => ['description' => 'SHA-1 hash value of the file.', 'type' => 'string', 'required' => false, 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8****', 'title' => ''], + ], + [ + 'name' => 'ConflictPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The hostname of the secondary domain controller.'."\n", + 'description' => 'How to handle files with the same name.', + 'enumValueTitles' => ['refuse' => 'Reject the request if a file with the same name exists. Return details of the existing file. \\[Default]', 'auto_rename' => 'Rename the new file automatically. By default, append the current timestamp to the original name. Example: xxx20240102\\_150405', 'ignore' => 'Allow duplicate names.', 'over_write' => 'Overwrite the existing file.'], 'type' => 'string', 'required' => false, - 'example' => 'dc002', + 'example' => 'ignore', + 'title' => '', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'Team space ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2BAFE05D-FFB9-5938-96D0-08017DB9****', 'title' => ''], + 'FileModel' => [ + 'description' => 'File upload response object.', + 'type' => 'object', + 'properties' => [ + 'UploadUrl' => ['description' => 'File upload URL. Valid for 15 minutes by default.', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E26977****', 'title' => ''], + 'FileId' => ['description' => 'File ID.', 'type' => 'string', 'example' => '646ec2f662b1e08f7a2b4d648982f906****', 'title' => ''], + 'UploadId' => ['description' => 'File upload task ID.', 'type' => 'string', 'example' => '20BE155AC20943BE9D405B0997A9****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]', - 'title' => 'ModifyADConnectorOfficeSite', - 'summary' => 'Modifies the basic properties of an enterprise Active Directory (AD) office network, such as the office network name and domain names of the enterprise AD subdomains.', - 'description' => 'You can modify parameters of domain names and Domain Name System (DNS) for enterprise AD office networks that are in the `ERROR` or `REGISTERED` state. The parameters include `DomainName`, `SubDomainName`, `DnsAddress.N`, and `SubDomainDnsAddress.N`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyOfficeSiteMfaEnabled' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Create a Folder or Create a File Upload Job', + 'description' => 'Call this API to create a folder directly in the enterprise cloud disk. To upload a file, call this API to obtain an upload URL. Then use that URL with the [CompleteCdsFile](~~2247620~~) API to complete the upload.', + 'changeSet' => [ + ['createdAt' => '2025-11-03T09:38:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-03T08:19:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-25T11:13:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-26T07:14:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-10T12:50:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-03T07:00:37.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFile'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BAFE05D-FFB9-5938-96D0-08017DB9****\\",\\n \\"FileModel\\": {\\n \\"UploadUrl\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E26977****\\",\\n \\"FileId\\": \\"646ec2f662b1e08f7a2b4d648982f906****\\",\\n \\"UploadId\\": \\"20BE155AC20943BE9D405B0997A9****\\"\\n }\\n}","type":"json"}]', + ], + 'CreateCdsFileShareLink' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****', 'title' => ''], + ], + [ + 'name' => 'SharePwd', + 'in' => 'query', + 'schema' => ['description' => 'The length of the access code. Valid values: 6 to 8. Unit: bytes. If you leave this parameter empty or set it to null, no access code is required. If you use a token to share files, you do not need to configure this parameter. The access code can contain only visible ASCII characters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 8, 'minLength' => 0, 'example' => '12345678', 'title' => ''], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => ['description' => 'The time when the file sharing link expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If this parameter is set to "", the file sharing link never expires.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2020-06-28T11:33:00.000+08:00', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the file sharing task. The description must be 0 to 1,024 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 1024, 'minLength' => 0, 'example' => 'SharedFile', 'title' => ''], + ], + [ + 'name' => 'ShareName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the file sharing task. If you leave this parameter empty, the file name that corresponds to the first ID in the file ID list is used. The name must be 0 to 128 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 128, 'minLength' => 0, 'example' => 'view.txt', 'title' => ''], + ], + [ + 'name' => 'DisablePreview', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'Specifies whether to prohibit the preview of the files that are being shared.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' prohibits file preview'."\n" + ."\n" + .' '."\n" + ."\n" + .' .'."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' allows file preview'."\n" + ."\n" + .' '."\n" + ."\n" + .' .', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DisableSave', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', + 'description' => 'Specifies whether to prohibit the dump of the files that are being shared.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' prohibits file dump'."\n" + ."\n" + .' '."\n" + ."\n" + .' .'."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' allows file dump'."\n" + ."\n" + .' '."\n" + ."\n" + .' .', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'MfaEnabled', + 'name' => 'DisableDownload', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable MFA.'."\n" + 'description' => 'Specifies whether to prohibit the download of the files that are being shared.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" + .'- true'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' :'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .'* false'."\n" + .' prohibits file download'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' .'."\n" ."\n" - .' '."\n", + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' allows file download'."\n" + ."\n" + .' '."\n" + ."\n" + .' .', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'type' => 'boolean', - 'required' => true, + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'PreviewLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be previewed. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be previewed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'SaveLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be dumped. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be dumped.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'DownloadLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be downloaded. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the end user.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'FileIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The file IDs.', + 'type' => 'array', + 'items' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' "4221bf6e6ab43c255edc4463bf3a6f5f5d31****"'."\n" + .']', 'title' => ''], + 'required' => false, 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'Team space ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'Code' => ['description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The data information.', '$ref' => '#/components/schemas/CdsFileShareLinkModel', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyOfficeSiteMfaEnabled', - 'summary' => 'Enables or disables multi-factor authentication (MFA) for an enterprise Active Directory (AD) office network (formerly workspace).', - ], - 'ConfigADConnectorTrust' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a file share', + 'summary' => 'Create a file share.', + 'changeSet' => [ + ['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFileShareLink'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CreateCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Description\\": \\"文件分享链接。\\",\\n \\"SaveLimit\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n },\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateCenterPolicy' => [ + 'summary' => 'You can create a region-independent cloud desktop policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Region ID. This feature is region-independent. Set this parameter to cn-shanghai.', + 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai)'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the enterprise AD office network.'."\n", + 'description' => 'Resource type.', + 'enumValueTitles' => ['app' => 'Cloud application', 'desktop' => 'Cloud desktop'], 'type' => 'string', 'required' => true, - 'example' => 'cn-hangzhou+dir-778418****', + 'docRequired' => false, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'TrustKey', + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => 'The trust password. You can specify the password when you configure a trust relationship between the AD domain and the ecd.acs domain.'."\n", - 'type' => 'string', + 'description' => 'Business type.', + 'enumValueTitles' => [1 => 'Public cloud', 8 => 'Commercial edition'], + 'type' => 'integer', + 'format' => 'int32', 'required' => true, - 'docRequired' => true, - 'example' => 'password123***', + 'docRequired' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'RdsLicenseDomain', + 'name' => 'Clipboard', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to configure a trust password for the Remote Desktop Services (RDS) License Domain of the enterprise AD office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: configures a trust password for the RDS License Domain of the AD office network.'."\n" - ."\n" - .'* false: configures a trust password for a regular enterprise AD office network.', - 'type' => 'boolean', + 'description' => 'Clipboard permission.', + 'enumValueTitles' => ['read' => 'One-way allowed. You can copy local content to the cloud desktop, but cannot copy cloud desktop content to the local device.', 'readwrite' => 'Two-way allowed. You can copy local content to the cloud desktop and copy cloud desktop content to the local device.', 'write' => 'One-way allowed. You can copy cloud desktop content to the local device, but cannot copy local content to the cloud desktop.', 'off' => 'Two-way disabled. Copy operations between the cloud desktop and the local device are not allowed. \\[Default value]'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'LocalDrive', + 'in' => 'query', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Local disk mapping permission.', + 'enumValueTitles' => ['read' => 'Read-only. The cloud desktop maps the local disk, but you can only read (copy) local files and cannot modify them.', 'readwrite' => 'Read-write. The cloud desktop maps the local disk. You can read (copy) and modify local files.', 'off' => 'Disabled. The cloud desktop does not map the local disk. \\[Default value]'], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n ECFA4A91-136C-5A58-9C77-858A84D60032\\r\\n","errorExample":""}]', - 'title' => 'ConfigADConnectorTrust', - 'summary' => 'Configures a conditional forwarder and trust relationship for a high-definition experience (HDX)-based office network (formerly workspace). You can call the operation to configure a trust relationship for an enterprise Active Directory (AD) office network.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ConfigADConnectorUser' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'UsbRedirect', + 'in' => 'query', + 'schema' => [ + 'description' => 'USB redirection.', + 'enumValueTitles' => ['off' => 'Disabled \\[Default value]', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', + ], ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PrinterRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'docRequired' => true, - 'example' => 'cn-hangzhou', - 'required' => true, + 'description' => 'Printer redirection policy. This parameter takes effect only when no printer redirection policy is configured in DeviceRedirects.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection \\[Default value]', 'usbRedirect' => 'USB redirection', 'off' => 'Disabled'], 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'VisualQuality', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the AD workspace.'."\n", - 'example' => 'cn-hangzhou+dir-778418****', - 'required' => true, + 'description' => 'Image display quality policy.', + 'enumValueTitles' => ['high' => 'High definition', 'low' => 'Low definition', 'lossless' => 'Lossless', 'medium' => 'Automatic rotation \\[Default value]'], 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'low', + 'title' => '', ], ], [ - 'name' => 'OUName', + 'name' => 'GpuAcceleration', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the OU in the AD domain. You can call the [ListUserAdOrganizationUnits](~~311259~~) to obtain the OU name.'."\n", - 'docRequired' => true, - 'example' => 'example.com/Domain Controllers', - 'required' => false, + 'description' => 'Enable image quality policy for graphics-intensive cloud desktops. Enable this policy if you require high performance and user experience, such as in professional design scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DomainUserName', + 'name' => 'Html5FileTransfer', 'in' => 'query', 'schema' => [ - 'description' => 'The username of the AD user that has the permissions to join computers to domains.'."\n" - ."\n" - .'After the username is configured, the cloud desktops in the same AD workspace are joined to the specified OU.'."\n", - 'docRequired' => true, - 'example' => 'Administrator', - 'required' => true, + 'description' => 'Web client file transfer policy.', + 'enumValueTitles' => ['all' => 'Allow upload and download', 'download' => 'Allow download', 'upload' => 'Allow upload', 'off' => 'Disabled \\[Default value]'], 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DomainPassword', + 'name' => 'Watermark', 'in' => 'query', 'schema' => [ - 'description' => 'The password of the AD user that has the permissions to join computers to domains.'."\n", - 'docRequired' => true, - 'example' => 'testPassword', - 'required' => true, + 'description' => 'Watermark.', + 'enumValueTitles' => ['blind' => 'Enable blind watermark', 'off' => 'Disable watermark \\[Default value]', 'on' => 'Enable visible watermark'], 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Policy name.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'testPolicyGroupName', 'title' => ''], + ], + [ + 'name' => 'WatermarkType', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - 'type' => 'string', - ], - ], - 'type' => 'object', + 'description' => 'Watermark type. You can select up to three types, separated by commas.'."\n" + ."\n" + .'> If you set this parameter to `custom`, you must also specify custom text using the `WatermarkCustomText` parameter.', + 'enumValueTitles' => ['EndUserId' => 'Username', 'Custom' => 'Custom text', 'DesktopIp' => 'Cloud desktop IP address', 'ClientIp' => 'Client IP address', 'HostName' => 'Last 15 characters of the cloud desktop ID', 'ClientTime' => 'Current time on the cloud desktop'], + 'type' => 'string', + 'required' => false, + 'example' => 'EndUserId,HostName,ClientTime', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BB4B415B-A9CA-5A13-8E52-D6D3C24BE140\\r\\n","errorExample":""}]', - 'extraInfo' => ' ', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'title' => 'ConfigADConnectorUser', - ], - 'CreateADConnectorDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'WatermarkCustomText', + 'in' => 'query', + 'schema' => ['description' => 'If you set the `WatermarkType` parameter to `custom`, you must also specify custom text using the `WatermarkCustomText` parameter.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'WatermarkTransparencyValue', + 'in' => 'query', + 'schema' => ['description' => 'Watermark opacity. A higher value indicates lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkSecurity', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Blind watermark security priority rule.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'DomainName', + 'name' => 'CameraRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The fully qualified domain name (FQDN) of the enterprise AD system. The value must contain the hostname and the domain name. You can register each FQDN only once.'."\n", + 'description' => 'Local camera redirection. This parameter takes effect only when no local camera redirection policy is configured in DeviceRedirects.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'off' => 'Disabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'corp.example.com', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DomainUserName', + 'name' => 'NetRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The username of the domain administrator. The username can be up to 64 characters in length.'."\n", + 'description' => 'Enable network redirection.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', + 'enumValueTitles' => ['all' => 'Enable global mode', 'off' => 'Disabled \\[Default value]', 'on' => 'Enable whitelist mode'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'sAMAccountName', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DomainPassword', + 'name' => 'AppContentProtection', 'in' => 'query', 'schema' => [ - 'description' => 'The password of the domain administrator. The password can be up to 64 characters in length.'."\n", + 'description' => 'Enable screenshot prevention.', + 'enumValueTitles' => ['off' => 'Disabled \\[Default value]', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testPassword', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DirectoryName', + 'name' => 'RemoteCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The directory name. The name must be 2 to 255 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", + 'description' => 'Mouse and keyboard control permissions during remote assistance.', + 'enumValueTitles' => ['optionalControl' => 'Disabled by default (can be enabled upon request)', 'fullControl' => 'Full control', 'disableControl' => 'No control'], 'type' => 'string', - 'required' => true, - 'example' => 'testDirectoryName', + 'required' => false, + 'example' => 'fullControl', + 'title' => '', ], ], [ - 'name' => 'EnableAdminAccess', + 'name' => 'InternetCommunicationProtocol', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* '."\n" - ."\n" - .' true'."\n" - ."\n" - .' '."\n" - ."\n" - .' (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', + 'description' => 'Network communication protocol.', + 'enumValueTitles' => ['tcp' => 'TCP mode applies to scenarios where UDP/AST is restricted.', 'rtc' => 'AST mode applies to audio and video scenarios with frequent usage.', 'auto' => 'AUTO mode automatically switches between AST and UDP modes based on desktop content.', 'both' => 'UDP mode applies to office and high-definition graphic design scenarios.'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'To grant the local administrator permission [Default]', - 'false' => 'Not to grant the local administrator permission', - ], - 'example' => 'true', + 'example' => 'both', + 'title' => '', ], ], [ - 'name' => 'DesktopAccessType', + 'name' => 'VideoRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The method in which the cloud computer is connected.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPC'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Internet (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Any'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'Multimedia redirection.', + 'enumValueTitles' => ['off' => 'Disable media redirection', 'on' => 'Enable media redirection'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'VPC' => 'Only connect through VPC', - 'Internet' => 'Only connect through the Internet [Default]', - 'Any' => 'Both VPC and Internet are supported', - ], - 'example' => 'Internet', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'SubDomainName', + 'name' => 'WatermarkColor', + 'in' => 'query', + 'schema' => ['description' => 'Watermark font color. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WatermarkDegree', + 'in' => 'query', + 'schema' => ['description' => 'Watermark tilt angle. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontSize', + 'in' => 'query', + 'schema' => ['description' => 'Watermark font size. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontStyle', 'in' => 'query', 'schema' => [ - 'description' => 'The FQDN of the enterprise AD subdomain. The value must contain the hostname and the subdomain name.'."\n", + 'description' => 'Watermark font style.', + 'enumValueTitles' => ['plain' => 'Plain', 'bold' => 'Bold'], 'type' => 'string', 'required' => false, - 'example' => 'child.example.com', + 'example' => 'plain', + 'title' => '', ], ], [ - 'name' => 'MfaEnabled', + 'name' => 'WatermarkRowAmount', + 'in' => 'query', + 'schema' => ['description' => 'Number of watermark rows. Valid values: 3 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'WatermarkColumnAmount', + 'in' => 'query', + 'schema' => ['description' => 'Number of watermark columns. Valid values: 3 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'CpuProtectedMode', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable Multi-Factor Authentication (MFA). After you enable MFA, all AD users in the directory must enter a dynamic verification code generated by the virtual MFA device in addition to a correct password when they log on to a cloud computer.'."\n" - ."\n" - .'> When end users log on to a cloud computer for the first time, they must bind an MFA device.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', + 'description' => 'CPU protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => 'To enable MFA', - 'false' => 'To disable MFA [Default]', - ], - 'example' => 'false', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DnsAddress', + 'name' => 'CpuRateLimit', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD. You can specify only one IP address. Make sure that the specified IP address is accessible in the network of the selected vSwitch.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.**.**', - ], - 'required' => true, - 'example' => '127.0.**.**', - 'maxItems' => 1, - ], + 'schema' => ['description' => 'CPU overall usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'CpuSampleDuration', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Details of the vSwitch IDs. You can specify only one vSwitch ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp19ocz3erfx15uon****', - ], - 'required' => true, - 'example' => 'vsw-bp19ocz3erfx15uon****', - 'maxItems' => 1, - ], + 'schema' => ['description' => 'CPU overall sampling duration. Valid values: 10 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ - 'name' => 'SubDomainDnsAddress', + 'name' => 'CpuSingleRateLimit', + 'in' => 'query', + 'schema' => ['description' => 'CPU single-core usage percentage. Valid values: 70 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], + ], + [ + 'name' => 'CpuDownGradeDuration', + 'in' => 'query', + 'schema' => ['description' => 'CPU downclocking duration. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'MemoryProtectedMode', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The DNS address of the existing AD subdomain.\\'."\n" - .'If you specify the `SubDomainName` parameter but you do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address of the existing AD subdomain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.**.**', - ], + 'description' => 'Memory protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'example' => '127.0.**.**', - 'maxItems' => 1, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'Specification', + 'name' => 'MemoryRateLimit', + 'in' => 'query', + 'schema' => ['description' => 'Memory overall usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], + ], + [ + 'name' => 'MemorySampleDuration', + 'in' => 'query', + 'schema' => ['description' => 'Memory overall sampling duration. Valid values: 30 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'MemorySingleRateLimit', + 'in' => 'query', + 'schema' => ['description' => 'Memory usage percentage per worker. Valid values: 30 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'MemoryDownGradeDuration', + 'in' => 'query', + 'schema' => ['description' => 'Memory downclocking duration per worker. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'EndUserApplyAdminCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the AD connector.'."\n" - ."\n" - .'Valid values:'."\n" - .'- 1 (General)'."\n" - .'- 2 (Advanced)', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'User requests administrator assistance.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 1 => 'General', - 'Advanced', - ], - 'example' => '1', + 'example' => 'off', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'EndUserGroupCoordinate', + 'in' => 'query', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'TrustPassword' => [ - 'description' => 'The AD trust password.'."\n", - 'type' => 'string', - 'example' => '82Tg****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF', - ], - 'DirectoryId' => [ - 'description' => 'The ID of the AD directory.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'AdConnectors' => [ - 'description' => 'The details of AD connectors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'AD Connector.', - 'type' => 'object', - 'properties' => [ - 'Address' => [ - 'description' => 'The connection address.'."\n", - 'type' => 'string', - 'example' => '127.0.**.**', - ], - ], - ], - ], - ], + 'description' => 'Users in the same office network share cloud desktops.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"RequestId\\": \\"3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"AdConnectors\\": [\\n {\\n \\"Address\\": \\"127.0.XX.XX\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\n \\n
127.0.**.**
\\n \\n","errorExample":""}]', - 'title' => 'CreateADConnectorDirectory', - 'summary' => 'Creates a directory of the Active Directory (AD) type.', - 'description' => 'An AD directory is used to connect to an enterprise\'s existing Active Directory and is suitable for large-scale cloud computer deployment. You are charged directory fees when you connect your AD to cloud computers. For more information, see [Billing overview](~~188395~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateRAMDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => 'Policy scope.', + 'enumValueTitles' => ['IP' => 'Effective for specified IP addresses', 'GLOBAL' => 'Globally effective'], + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL', + 'title' => '', + ], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Recording', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Enable screen recording.', + 'enumValueTitles' => ['period' => 'Periodic recording', 'session' => 'Session recording', 'off' => 'Disabled', 'alltime' => 'Continuous recording'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DirectoryName', + 'name' => 'RecordingAudio', 'in' => 'query', 'schema' => [ - 'description' => 'The directory name. The name must be 2 to 255 characters in length. It must start with a letter but cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).'."\n", + 'description' => 'Options for recording cloud desktop audio.', + 'enumValueTitles' => ['off' => 'Record video only', 'on' => 'Record system and peripheral audio'], 'type' => 'string', - 'required' => true, - 'example' => 'testDirectoryName', + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'EnableInternetAccess', + 'name' => 'RecordingStartTime', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording start time. Format: HH:MM:SS. This parameter takes effect only when `Recording` is set to `PERIOD`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], + ], + [ + 'name' => 'RecordingEndTime', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording end time. Format: HH:MM:SS. This parameter takes effect only when `Recording` is set to `PERIOD`.', 'type' => 'string', 'required' => false, 'example' => '08:59:00', 'title' => ''], + ], + [ + 'name' => 'RecordingFps', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording frame rate. Unit: FPS.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'RecordingDuration', + 'in' => 'query', + 'schema' => ['description' => 'Duration for viewing recorded files. Unit: minutes. Recorded files are automatically split and uploaded to the bucket based on the specified duration. When a file reaches 300 MB, it is rolled over for updates. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'RecordingExpires', + 'in' => 'query', + 'schema' => ['description' => 'Retention period for recorded files. Valid values: 1 to 180 days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'RecordingUserNotify', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable Internet access.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', + 'description' => 'Notify end users that screen recording is enabled.', + 'enumValueTitles' => ['off' => 'Do not notify users about screen recording', 'on' => 'Notify users that screen recording will be enabled'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'EnableAdminAccess', + 'name' => 'RecordingUserNotifyMessage', + 'in' => 'query', + 'schema' => ['description' => 'Message to notify end users that screen recording is enabled.', 'type' => 'string', 'example' => 'Screen recording is enabled.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'AdminAccess', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* '."\n" - ."\n" - .' true'."\n" - ."\n" - .' '."\n" - ."\n" - .' (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false'."\n" - ."\n" - .' '."\n" + 'description' => 'Whether users have administrative permission after logging on to cloud desktops.'."\n" ."\n" - .' '."\n", - 'type' => 'boolean', + .'> This feature is in invitational preview and is not publicly available.', + 'enumValueTitles' => ['allow' => 'Force allow', 'deny' => 'Force deny', 'inherited' => 'Inherit administrative permission control from the user dimension'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'example' => 'deny', + 'title' => '', ], ], [ - 'name' => 'DesktopAccessType', + 'name' => 'EnableSessionRateLimiting', 'in' => 'query', 'schema' => [ - 'description' => 'The method in which the cloud computer is connected.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPC'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Internet (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Any'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'Session bandwidth throttling.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'VPC' => '', - 'Internet' => '', - 'Any' => '', - ], - 'example' => 'Internet', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'VSwitchId', + 'name' => 'SessionMaxRateKbps', + 'in' => 'query', + 'schema' => ['description' => 'Maximum session bandwidth throttling rate. Unit: Kbps. Valid values: 2000 to 100000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'DisplayMode', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The vSwitch IDs. You can configure only one vSwitch.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf62w3qzt4aigvlcb****', - ], - 'required' => true, - 'maxItems' => 20, + 'description' => 'Display mode.', + 'enumValueTitles' => ['clientCustom' => 'User-configurable', 'adminOffice' => 'Daily office scenario', 'adminDesign' => 'Design and 3D applications', 'adminCustom' => 'Custom'], + 'type' => 'string', + 'required' => false, + 'example' => 'clientCustom', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'StreamingMode', + 'in' => 'query', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'DirectoryId' => [ - 'description' => 'The RAM directory ID.'."\n", - 'type' => 'string', - 'example' => 'dri-uf62w3qzt4aigvlcb****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Streaming mode adaptation scenario.', + 'enumValueTitles' => ['intelligent' => 'Intelligent mode', 'smooth' => 'Smoothness priority'], + 'type' => 'string', + 'required' => false, + 'example' => 'smooth', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DirectoryId\\": \\"dri-uf62w3qzt4aigvlcb****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'CreateRAMDirectory', - 'summary' => 'Creates a Resource Access Management (RAM) directory.', - 'description' => 'Before you create a RAM directory, complete the following preparations:'."\n" - ."\n" - .'* Call the `CreateVpc` operation to create a virtual private cloud (VPC) in a region supported by Elastic Desktop Service.'."\n" - .'* Call the `CreateVSwitch` operation to create a vSwitch in the VPC. The vSwitch is in a zone that is supported by Elastic Desktop Service. You can call the [DescribeZones](~~196648~~) operation to obtain the most recent zone list for a region supported by Elastic Desktop Service', - ], - 'DescribeDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ColorEnhancement', + 'in' => 'query', + 'schema' => [ + 'description' => 'Enable color enhancement for design and 3D application scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'SmoothEnhancement', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Enable smoothness enhancement for daily office scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DirectoryType', + 'name' => 'QualityEnhancement', 'in' => 'query', 'schema' => [ - 'description' => 'The directory type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* SIMPLE: the convenience directory.'."\n" - .'* AD_CONNECTOR: the Active Directory (AD) directory.'."\n", + 'description' => 'Enable image quality enhancement for design and 3D application scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'RAM', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DirectoryStatus', + 'name' => 'VideoEncPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The directory status. This parameter is equivalent to `Status`.'."\n", + 'description' => 'Video encoding policy.', + 'enumValueTitles' => ['qualityFirst' => 'Quality priority', 'bandwidthFirst' => 'Bandwidth priority'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'REGISTERED', + 'example' => 'qualityFirst', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'TargetFps', + 'in' => 'query', + 'schema' => ['description' => 'Target frame rate. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'VideoEncMinQP', + 'in' => 'query', + 'schema' => ['description' => 'Minimum QP for video encoding, representing the highest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'VideoEncMaxQP', + 'in' => 'query', + 'schema' => ['description' => 'Maximum QP for video encoding, representing the lowest image quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'VideoEncAvgKbps', + 'in' => 'query', + 'schema' => ['description' => 'Average video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'VideoEncPeakKbps', + 'in' => 'query', + 'schema' => ['description' => 'Peak video encoding bitrate. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], + ], + [ + 'name' => 'MaxReconnectTime', + 'in' => 'query', + 'schema' => ['description' => 'Maximum reconnection retry time when a cloud desktop disconnects due to objective reasons. Valid values: 30 to 7200. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'WyAssistant', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" + 'description' => 'Provide an entry point for Wuying AI Assistant in the floating ball on the cloud desktop when connecting through desktop clients (including Windows and macOS clients).'."\n" ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'> This feature applies only to desktop clients V7.7 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'CpuProcessors', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', + 'description' => 'The name of the process.', + 'type' => 'array', + 'items' => ['description' => 'Process name.', 'type' => 'string', 'required' => false, 'example' => 'notepad.exe', 'title' => ''], 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DirectoryId', + 'name' => 'MemoryProcessors', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'Details of directory IDs. You can specify one or more directory IDs.'."\n", + 'description' => 'Process names.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the directory.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], + 'items' => ['description' => 'Process name.', 'type' => 'string', 'required' => false, 'example' => 'chrome.exe', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - 'maxItems' => 100, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Status', + 'name' => 'DomainResolveRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The directory status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* REGISTERING: The directory is being registered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DEREGISTERING: The directory is being deregistered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGISTERED: The directory is registered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGTRUST: A trust relationship needs to be configured for the directory.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTFAILED: A trust relationship fails to be configured for the directory.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DEREGISTERED: The directory is deregistered.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ERROR: One or more configurations of the directory are invalid.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CONFIGTRUSTING: A trust relationship is being configured.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NEEDCONFIGUSER: Users need to be configured for the directory.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'REGISTERING' => '', - 'DEREGISTERING' => '', - 'REGISTERED' => '', - 'NEEDCONFIGTRUST' => '', - 'CONFIGTRUSTFAILED' => '', - 'DEREGISTERED' => '', - 'ERROR' => '', - 'CONFIGTRUSTING' => '', - 'NEEDCONFIGUSER' => '', - ], - 'example' => 'REGISTERED', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used for the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F369A091-002F-49C8-AD55-02A776297C7B', - ], - 'Directories' => [ - 'description' => 'The directories.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the directory.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnableInternetAccess' => [ - 'description' => 'Indicates whether access over the Internet is enabled.'."\n" - ."\n" - .'> This parameter is unavailable.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VpcId' => [ - 'description' => 'The ID of the VPC to which the vSwitch belongs. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf6tz5k67puge5jn8****', - ], - 'CreationTime' => [ - 'description' => 'The time when the directory was created.'."\n", - 'type' => 'string', - 'example' => '2020-11-02T01:44Z', - ], - 'Status' => [ - 'description' => 'The status of the AD directory.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* REGISTERING'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* REGISTERED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'REGISTERING' => '', - 'REGISTERED' => '', - ], - 'example' => 'REGISTERING', - ], - 'DomainPassword' => [ - 'description' => 'The password of the domain administrator. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'string', - 'example' => 'testPassword', - ], - 'EnableAdminAccess' => [ - 'description' => 'Indicates whether the local administrator permissions are granted to users that use cloud computers in the office network.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SubDomainName' => [ - 'description' => 'The fully qualified domain name (FQDN) of the existing AD subdomain. The value contains both the host name and the domain name.'."\n", - 'type' => 'string', - 'example' => 'child.example.com', - ], - 'DomainUserName' => [ - 'description' => 'The username of the domain administrator.'."\n", - 'type' => 'string', - 'example' => 'sAMAccountName', - ], - 'EnableCrossDesktopAccess' => [ - 'description' => 'Indicates whether cloud computers can communicate with each other in the directory.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CustomSecurityGroupId' => [ - 'description' => 'The security group ID. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'string', - 'example' => 'sg-bp1ce64o4g9mdf5u****', - ], - 'DesktopVpcEndpoint' => [ - 'description' => 'The endpoint that is used to connect to cloud computers in the directory over a VPC.'."\n", - 'type' => 'string', - 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'SsoEnabled' => [ - 'description' => 'Indicates whether single sign-on (SSO) is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DomainName' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - 'DesktopAccessType' => [ - 'description' => 'The method in which the cloud computer is connected.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* VPC'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Internet'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Any'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'VPC' => '', - 'Internet' => '', - 'Any' => '', - ], - 'example' => 'Internet', - ], - 'MfaEnabled' => [ - 'description' => 'Indicates whether MFA is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DirectoryType' => [ - 'description' => 'The directory type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AD_CONNECTOR: AD directory'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RAM: RAM directory'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AD_CONNECTOR' => 'AD_CONNECTOR', - 'RAM' => 'RAM', - ], - 'example' => 'RAM', - ], - 'DnsUserName' => [ - 'description' => 'The username of a DNS user.'."\n", - 'type' => 'string', - 'example' => 'testDnsUserName', - ], - 'TrustPassword' => [ - 'description' => 'The AD trust password. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'string', - 'example' => '82Tg****', - ], - 'OuName' => [ - 'description' => 'The organization unit that you selected when you added the cloud computer to the domain.'."\n", - 'type' => 'string', - 'example' => 'example.com/Domain Controllers', - ], - 'Name' => [ - 'description' => 'The directory name.'."\n", - 'type' => 'string', - 'example' => 'testDirectoryName', - ], - 'DirectoryId' => [ - 'description' => 'The directory ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'ADConnectors' => [ - 'description' => 'Details of the AD connector.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the AD connector.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConnectorStatus' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* CONNECT_ERROR'."\n" - .'* RUNNING'."\n" - .'* CONNECTING: You must configure domain trust for your AD system.'."\n" - .'* EXPIRED'."\n" - .'* CREATING', - 'type' => 'string', - 'enumValueTitles' => [ - 'CONNECT_ERROR' => '', - 'RUNNING' => '', - 'CONNECTING' => '', - 'EXPIRED' => '', - 'CREATING' => '', - ], - 'example' => 'RUNNING', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch with which the AD connector is associated.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp19ocz3erfx15uon****', - ], - 'ADConnectorAddress' => [ - 'description' => 'The connection address.'."\n", - 'type' => 'string', - 'example' => '172.17.**.**', - ], - 'TrustKey' => [ - 'description' => 'The trust password of the AD domain controller.'."\n", - 'type' => 'string', - 'example' => 'yfpoAD****', - ], - 'NetworkInterfaceId' => [ - 'description' => 'The ID of the NIC to which the AD connector is mounted.'."\n", - 'type' => 'string', - 'example' => 'eni-bp1i4wx78lgosrj6****', - ], - 'Specification' => [ - 'description' => 'The AD connector type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: General'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2: Advanced'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - ], - ], - ], - 'Logs' => [ - 'description' => 'The registration logs. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the registration log.'."\n", - 'type' => 'object', - 'properties' => [ - 'Step' => [ - 'description' => 'The step that corresponds to the log entry.'."\n", - 'type' => 'string', - 'example' => 'DescribeDirectories', - ], - 'Message' => [ - 'description' => 'Details of the log entry.'."\n", - 'type' => 'string', - 'example' => 'code:success | message:Create Connector complete.', - ], - 'TimeStamp' => [ - 'description' => 'The time when the log entry was printed.'."\n", - 'type' => 'string', - 'example' => '2021-01-22T06:45Z', - ], - 'Level' => [ - 'description' => 'The level of the log entry.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ERROR'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* INFO'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* WARN'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'ERROR' => '', - 'INFO' => '', - 'WARN' => '', - ], - 'example' => 'INFO', - ], - ], - ], - ], - 'VSwitchIds' => [ - 'description' => 'The IDs of the vSwitches specified when the directory was created.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the vSwitches specified when the directory was created.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp19ocz3erfx15uon****', - ], - ], - 'FileSystemIds' => [ - 'description' => 'The IDs of File Storage NAS (NAS) file systems.', - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of File Storage NAS (NAS) file systems.', - 'type' => 'string', - 'example' => '05b534****', - ], - ], - 'SubDnsAddress' => [ - 'description' => 'The DNS address of the enterprise AD subdomain.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address of the enterprise AD subdomain.'."\n", - 'type' => 'string', - 'example' => '172.24.XX.XX', - ], - ], - 'DnsAddress' => [ - 'description' => 'The DNS address of the directory.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address of the directory.'."\n", - 'type' => 'string', - 'example' => '172.24.XX.XX', - ], - ], - 'NeedVerifyLoginRisk' => [ - 'description' => 'Indicates whether two-step verification for logons is enabled. This parameter is returned only for directories of convenience account type.\\'."\n" - .'If two-factor verification is enabled, the system checks whether security risks exist within the logon account when a convenience user logs on to an Alibaba Cloud Workspace client. If risks are detected, the system sends a verification code to the email address that is associated with the account. Then, the convenience user can log on to the client only after the user enters the correct verification code.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AdHostname' => [ - 'description' => 'The hostname of the domain controller.', - 'type' => 'string', - 'example' => 'dc001', - ], - 'BackupDns' => [ - 'description' => 'The DNS address of the backup domain controller.', - 'type' => 'string', - 'example' => '192.168.2.100', - ], - 'BackupDCHostname' => [ - 'description' => 'The hostname of the backup domain controller.', - 'type' => 'string', - 'example' => 'dc002', - ], - ], + 'description' => 'Domain name resolution policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the domain name resolution policy.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'Domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com', 'title' => ''], + 'Policy' => [ + 'description' => 'Resolution policy.', + 'enumValueTitles' => ['allow' => 'Allow', 'block' => 'Deny'], + 'type' => 'string', + 'required' => false, + 'example' => 'allow', + 'title' => '', ], + 'Description' => ['description' => 'Policy description.', 'type' => 'string', 'required' => false, 'example' => '测试规则', 'title' => ''], ], - 'AdHostname' => [ - 'description' => 'The hostname of the domain controller. The hostname must comply with the hostname naming convention of Windows. This parameter is returned only when the directory type is AD office network.'."\n", - 'type' => 'string', - 'example' => 'cnshsv21hmc****', - ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A776297C7B\\",\\n \\"Directories\\": [\\n {\\n \\"EnableInternetAccess\\": false,\\n \\"VpcId\\": \\"vpc-uf6tz5k67puge5jn8****\\",\\n \\"CreationTime\\": \\"2020-11-02T01:44Z\\",\\n \\"Status\\": \\"REGISTERING\\",\\n \\"DomainPassword\\": \\"testPassword\\",\\n \\"EnableAdminAccess\\": true,\\n \\"SubDomainName\\": \\"child.example.com\\",\\n \\"DomainUserName\\": \\"sAMAccountName\\",\\n \\"EnableCrossDesktopAccess\\": true,\\n \\"CustomSecurityGroupId\\": \\"sg-bp1ce64o4g9mdf5u****\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"SsoEnabled\\": false,\\n \\"DomainName\\": \\"example.com\\",\\n \\"DesktopAccessType\\": \\"Internet\\",\\n \\"MfaEnabled\\": false,\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"DnsUserName\\": \\"testDnsUserName\\",\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"OuName\\": \\"example.com/Domain Controllers\\",\\n \\"Name\\": \\"testDirectoryName\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ADConnectors\\": [\\n {\\n \\"ConnectorStatus\\": \\"RUNNING\\",\\n \\"VSwitchId\\": \\"vsw-bp19ocz3erfx15uon****\\",\\n \\"ADConnectorAddress\\": \\"172.17.XX.XX\\",\\n \\"TrustKey\\": \\"yfpoAD****\\",\\n \\"NetworkInterfaceId\\": \\"eni-bp1i4wx78lgosrj6****\\",\\n \\"Specification\\": \\"1\\"\\n }\\n ],\\n \\"Logs\\": [\\n {\\n \\"Step\\": \\"DescribeDirectories\\",\\n \\"Message\\": \\"code:success | message:Create Connector complete.\\",\\n \\"TimeStamp\\": \\"2021-01-22T06:45Z\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp19ocz3erfx15uon****\\"\\n ],\\n \\"FileSystemIds\\": [\\n \\"05b534****\\"\\n ],\\n \\"SubDnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"DnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"NeedVerifyLoginRisk\\": false,\\n \\"AdHostname\\": \\"dc001\\",\\n \\"BackupDns\\": \\"192.168.2.100\\",\\n \\"BackupDCHostname\\": \\"dc002\\"\\n }\\n ],\\n \\"AdHostname\\": \\"cnshsv21hmc****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n REGISTERING\\n example.com\\n sg-bp1ce64o4g9mdf5u****\\n testDirectoryName\\n RAM\\n testPassword\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\n vpc-uf6tz5k67puge5jn8****\\n 2020-11-02T01:44Z\\n Internet\\n sAMAccountName\\n false\\n testDnsUserName\\n \\n \\n \\n 172.17.**.**\\n eni-bp1i4wx78lgosrj6****\\n RUNNING\\n vsw-bp19ocz3erfx15uon****\\n \\n \\n INFO\\n DescribeDirectories\\n code:success | message:Create Connector complete.\\n 2021-01-22T06:45Z\\n \\n \\n \\n vsw-bp19ocz3erfx15uon****\\n [\\"171.17.**.**\\"]\\n \\n F369A091-002F-49C8-AD55-02A776297C7B\\n caeba0bbb2be03f84eb48b699f0a4883\\n","errorExample":""}]', - 'title' => 'DescribeDirectories', - 'summary' => 'Queries the details of directories.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDirectoryUsers' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query string for fuzzy match. If you specify this parameter, the system returns all results that contain the string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the AD directory.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token used to start the next query. If the value of this parameter is empty, all results are returned.'."\n", - 'type' => 'string', 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'NetRedirectRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" + 'description' => 'Network redirection policy details.'."\n" ."\n" - .'Valid values: 1 to 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'> This feature is in invitational preview and is not publicly available.', + 'type' => 'array', + 'items' => [ + 'description' => 'Network redirection policy details.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'Domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com', 'title' => ''], + 'RuleType' => [ + 'description' => 'Rule type.', + 'enumValueTitles' => ['prc' => 'Process', 'domain' => 'Domain'], + 'type' => 'string', + 'required' => false, + 'example' => 'domain', + 'title' => '', + ], + 'Policy' => ['description' => 'Redirection policy.', 'type' => 'string', 'required' => false, 'example' => 'allow', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OUPath', + 'name' => 'ScopeValue', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The organizational unit (OU) in the specified AD domain.'."\n", - 'type' => 'string', + 'description' => 'Specify this parameter when `Scope` is set to `IP`. This parameter takes effect only when `Scope` is set to `IP`.', + 'type' => 'array', + 'items' => ['description' => 'Effective CIDR block range.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24', 'title' => ''], 'required' => false, - 'example' => 'example.com/Domain Controllers', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AssignedInfo', + 'name' => 'ClientType', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> This parameter is not publicly available. The value can be 1 or left empty.', - 'type' => 'string', + 'description' => 'List of logon method control rules. These rules control which clients can access cloud desktops.', + 'type' => 'array', + 'items' => [ + 'description' => 'Logon method control rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Logon method control. Specify whether to allow users to log on to cloud desktops using a specific type of client.'."\n" + ."\n" + .'> If you do not configure parameters related to `ClientType`, all types of clients are allowed to log on to cloud desktops by default.', + 'enumValueTitles' => ['off' => 'Not allowed', 'on' => 'Allowed'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + 'ClientType' => [ + 'description' => 'Logon method control. Specify the client type.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'ios' => 'iOS client', 'windows' => 'Windows client', 'macos' => 'macOS client'], + 'type' => 'string', + 'required' => false, + 'example' => 'windows', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '1', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SortType', + 'name' => 'UsbSupplyRedirectRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The sort type.'."\n" - ."\n" - .'Valide values:'."\n" - ."\n" - .'- asc: cloud computers assigned to users on bottom'."\n" - .'- desc: cloud computers assigned to users on top', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'asc' => '', - 'desc' => '', + 'description' => 'USB redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'USB redirection rules.', + 'type' => 'object', + 'properties' => [ + 'VendorId' => ['description' => 'Vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '04**', 'title' => ''], + 'UsbRuleType' => [ + 'description' => 'USB redirection rule type.', + 'enumValueTitles' => [2 => 'Product'], + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'title' => '', + ], + 'Description' => ['description' => 'Rule description.', 'type' => 'string', 'required' => false, 'example' => '测试规则', 'title' => ''], + 'UsbRedirectType' => [ + 'description' => 'USB redirection type.', + 'enumValueTitles' => [1 => 'Allow', 'Deny'], + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'ProductId' => ['description' => 'Product ID.', 'type' => 'string', 'required' => false, 'example' => '08**', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'asc', + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IncludeAssignedUser', + 'name' => 'AuthorizeSecurityPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to return the users with assigned cloud computers only.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The token used to start the next query. If the value of this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Users' => [ - 'description' => 'The usernames corresponding to the AD directory. If the AD directory contains only the Administrator and Guest accounts, the Users array will be empty.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username corresponding to the AD directory.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUser' => [ - 'description' => 'The name of the user.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'DisplayName' => [ - 'description' => 'The display name of the user.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - 'AssignedDesktopNumber' => [ - 'description' => 'The number of assigned cloud computers.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Email' => [ - 'description' => 'The email address.', - 'type' => 'string', - 'example' => 'user@example.com', - ], - 'Phone' => [ - 'description' => 'The mobile number.', - 'type' => 'string', - 'example' => '130********', - ], - 'DisplayNameNew' => [ - 'type' => 'string', - ], - 'UserPrincipalName' => [ - 'type' => 'string', - ], - ], + 'description' => 'List of security group control rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of security group control rules.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Direction of the security group control rule.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], + 'type' => 'string', + 'required' => false, + 'example' => 'inflow', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'Authorization policy of the security group control rule.', + 'enumValueTitles' => ['drop' => 'Deny policy. Denies all access requests without returning a denial message. Requests time out or fail to establish connections from the requester VPC.', 'accept' => 'Allow policy. Accepts all access requests. \\[Default value]'], + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + 'title' => '', + ], + 'PortRange' => ['description' => 'Port range of the security group control rule. The port range depends on the protocol (IpProtocol):'."\n" + ."\n" + .'- TCP or UDP: Port range is 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.'."\n" + ."\n" + .'- ICMP: Port is -1/-1.'."\n" + ."\n" + .'- GRE: Port is -1/-1.'."\n" + ."\n" + .'- IpProtocol is all: Port is -1/-1.'."\n" + ."\n" + .'For common ports used by typical applications, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'Description of the security group control rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'Protocol type of the security group control rule.', + 'enumValueTitles' => ['TCP' => 'TCP protocol', 'UDP' => 'UDP protocol', 'ALL' => 'All protocols', 'GRE' => 'GRE protocol', 'ICMP' => 'ICMP (IPv4) protocol'], + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + 'title' => '', ], + 'Priority' => ['description' => 'Priority of the security group control rule. A smaller number indicates a higher priority.
'."\n" + .'Valid values: 1 to 60.
'."\n" + .'Default value: 1.

', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'Object of the security group control rule. IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '10.0.XX.XX/8', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"Alice\\",\\n \\"DisplayName\\": \\"Alice\\",\\n \\"AssignedDesktopNumber\\": 2,\\n \\"Email\\": \\"user@example.com\\",\\n \\"Phone\\": \\"130********\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListDirectoryUsers', - 'summary' => 'Obtains the user information in the AD system if you use an AD directory to connect to an AD system.', - 'description' => 'If you use an AD directory to connect to an AD system, you can call this operation to obtain the user information in the AD system.', - ], - 'ModifyADConnectorDirectory' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DirectoryId', + 'name' => 'AuthorizeAccessPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the directory.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd**** ', + 'description' => 'Client IP address whitelist. After this parameter is configured, only IP addresses within the specified CIDR blocks can access cloud desktops.', + 'type' => 'array', + 'items' => [ + 'description' => 'Client IP address whitelist.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Description of the client IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'Client access IP address range. IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DomainName', + 'name' => 'DeviceRedirects', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The domain name. The name must be 2 to 255 characters in length and must be in the two-part domain name format, such as `example.com`. You can register each domain name only once.'."\n", - 'type' => 'string', + 'description' => 'List of device redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of device redirection rules.', + 'type' => 'object', + 'properties' => [ + 'RedirectType' => [ + 'description' => 'Redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Disabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'usbRedirect', + 'title' => '', + ], + 'DeviceType' => [ + 'description' => 'Device type', + 'enumValueTitles' => ['printer' => 'Printer', 'scanner' => 'Scanner', 'serialport' => 'Serial port device', 'camera' => 'Camera', 'adb' => 'ADB'], + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'example.com', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DomainUserName', + 'name' => 'DeviceRules', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The username of the domain administrator. The username can be up to 64 characters in length.', - 'type' => 'string', + 'description' => 'List of custom peripheral rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of custom peripheral rules.', + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['description' => 'Device name.', 'type' => 'string', 'required' => false, 'example' => 'sandisk', 'title' => ''], + 'RedirectType' => [ + 'description' => 'Redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Prohibited'], + 'type' => 'string', + 'required' => false, + 'example' => 'usbRedirect', + 'title' => '', + ], + 'DeviceType' => [ + 'description' => 'Peripheral type.', + 'enumValueTitles' => ['usbKey' => 'UKey', 'other' => 'Other', 'graphicsTablet' => 'Graphics tablet', 'cardReader' => 'Card reader', 'printer' => 'Printer', 'scanner' => 'Scanner', 'storage' => 'Storage device', 'camera' => 'Camera', 'networkInterfaceCard' => 'Network interface controller (NIC)'], + 'type' => 'string', + 'required' => false, + 'example' => 'storage', + 'title' => '', + ], + 'OptCommand' => ['description' => 'Link optimization command.', 'type' => 'string', 'required' => false, 'example' => '2:0', 'title' => ''], + 'DevicePid' => ['description' => 'Product ID.', 'type' => 'string', 'required' => false, 'example' => '0x55b1', 'title' => ''], + 'DeviceVid' => ['description' => 'Vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '0x0781', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'sAMAccountName', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DomainPassword', + 'name' => 'WatermarkAntiCam', 'in' => 'query', 'schema' => [ - 'description' => 'The password of the domain administrator. The username can be up to 64 characters in length.', + 'description' => 'Blind watermark anti-photo feature.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'testPassword', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DirectoryName', + 'name' => 'WatermarkPower', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the AD directory.', + 'description' => 'Blind watermark enhancement feature.', + 'enumValueTitles' => ['high' => 'High', 'low' => 'Low', 'medium' => 'Medium'], 'type' => 'string', 'required' => false, - 'example' => 'testDirectoryName ', + 'example' => 'medium', + 'title' => '', ], ], [ - 'name' => 'SubDomainName', + 'name' => 'DomainResolveRuleType', 'in' => 'query', 'schema' => [ - 'description' => 'The domain name of the existing AD subdomain.'."\n", + 'description' => 'Domain name resolution policy type.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'childexample.com ', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'MfaEnabled', + 'name' => 'ClipboardScope', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable Multi-Factor Authentication (MFA). After you enable MFA, all AD users in the directory must enter a dynamic verification code generated by the virtual MFA device in addition to a correct password when they log on to a cloud computer.'."\n" - ."\n" - .'> When end users log on to a cloud computer for the first time, they must bind an MFA device.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false (default)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', + 'title' => 'Effective scope of the clipboard ', + 'description' => 'Clipboard scope', + 'type' => 'string', + 'example' => 'GLOBAL', + 'enum' => ['global', 'grained'], 'required' => false, - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'false', ], ], [ - 'name' => 'DnsAddress', + 'name' => 'ClipboardGraineds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD. You can specify only one IP address. Make sure that the specified IP address is accessible in the network of the selected vSwitch.'."\n", + 'maxItems' => 4, + 'description' => 'Fine-grained clipboard control configuration', + 'title' => 'Fine-grained clipboard control configuration', 'type' => 'array', 'items' => [ - 'description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", - 'type' => 'string', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GrainedType' => [ + 'type' => 'string', + 'enum' => ['text', 'richtext', 'file', 'picture'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClipboardType' => [ + 'type' => 'string', + 'enum' => ['off', 'read', 'readwrite', 'write'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'InClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'InClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'OutClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'required' => false, - 'example' => '127.0.**.** ', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => '127.0.**.** ', - 'maxItems' => 1, + 'example' => '', ], ], [ - 'name' => 'SubDomainDnsAddress', + 'name' => 'StatusMonitor', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The DNS address of the existing AD subdomain.\\'."\n" - .'If you specify the `SubDomainName` parameter but you do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The DNS address of the existing AD subdomain.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.**.** ', - ], + 'description' => 'Provide an entry point for status monitoring in the floating ball on the cloud desktop.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'example' => '127.0.**.** ', - 'maxItems' => 1, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'AdHostname', + 'name' => 'MobileRestart', 'in' => 'query', 'schema' => [ - 'description' => 'The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.', + 'description' => 'Provide a restart button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients).'."\n" + ."\n" + .'> This feature applies only to mobile clients V7.4 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'cnshsv21hmcdc01', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'OUName', + 'name' => 'MobileShutdown', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the organizational unit (OU) in the AD domain. You can call the ListUserAdOrganizationUnits operation to obtain the name of the OU.', + 'description' => 'Provide a shutdown button in the floating ball on the cloud desktop when connecting through mobile clients (Android and iOS clients).'."\n" + ."\n" + .'> This feature applies only to mobile clients V7.4 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'example.com/Domain Controllers', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'example' => 'off', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]', - 'title' => 'ModifyADConnectorDirectory', - 'summary' => 'Modifies an Active Directory (AD) directory.', - 'description' => 'You can modify the following domain name- and Domain Name System (DNS)-related parameters only for Active Directory (AD) directories that are in the ERROR or REGISTERING state: `DomainName`, `SubDomainName`, `DnsAddress.N`, and `SubDomainDnsAddress`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResolutionModel', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Resolution type.', + 'enumValueTitles' => ['adaptive' => 'Adaptive resolution', 'customer' => 'Fixed resolution'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'adaptive', + 'title' => '', ], ], [ - 'name' => 'DirectoryId', + 'name' => 'ResolutionWidth', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The directory IDs. You can specify one or more directory IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The directory ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'required' => true, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5CC5E450-FC43-4F5B-B540-9964BD313427', - ], - ], - ], + 'schema' => ['description' => 'Resolution width. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 640 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD313427\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]', - 'title' => 'DeleteDirectories', - 'summary' => 'Deletes one or more directories.', - 'description' => 'You cannot delete a directory that has a cloud computer or is used by a cloud computer.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateDesktops' => [ - 'summary' => 'Creates cloud computers. If you specify end users when you create cloud computers, the cloud computers are assigned to the end users after the cloud computers are created.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52797', - 'abilityTreeNodes' => [ - 'FEATUREgwsOBA7JE', + 'name' => 'ResolutionHeight', + 'in' => 'query', + 'schema' => ['description' => 'Resolution height. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud desktops: 480 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Taskbar', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Application taskbar.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'NoOperationDisconnect', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", + 'description' => 'Disconnect on inactivity.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'dg-boyczi8enfyc5****', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'BundleId', + 'name' => 'NoOperationDisconnectTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'b-je9hani001wfn****', - ], + 'schema' => ['description' => 'Inactivity disconnect duration. Valid values: 120 to 7200. Unit: seconds.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], ], [ - 'name' => 'DesktopName', + 'name' => 'DisconnectKeepSession', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the cloud computer. The name must meet the following requirements:'."\n" + 'description' => 'Session retention after disconnection.'."\n" ."\n" - .'* The name must be 1 to 64 characters in length.'."\n" - .'* The name must start with a letter but cannot start with `http://` or `https://`.'."\n" - .'* The name can only contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).'."\n", + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['customTime' => 'Fixed time', 'persistent' => 'Persistent'], 'type' => 'string', 'required' => false, - 'example' => 'testDesktopName', + 'example' => 'customTime', + 'title' => '', ], ], [ - 'name' => 'UserName', + 'name' => 'DisconnectKeepSessionTime', 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'To be hidden.', - ], + 'schema' => ['description' => 'Session retention duration after disconnection. Valid values: 30 to 7200. Unit: seconds.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'RecordEvents', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', + 'description' => 'List of screen recording events.', + 'type' => 'array', + 'items' => [ + 'description' => 'Screen recording event.', + 'enumValueTitles' => ['transferWithLocal' => 'Clipboard and file transfer operations', 'userInput' => 'User input', 'usbRedirect' => 'USB peripheral plug and unplug'], + 'type' => 'string', + 'required' => false, + 'example' => 'transferWithLocal', + 'title' => '', + ], 'required' => false, - 'example' => 'To be hidden.', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Amount', + 'name' => 'RecordEventFilePaths', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of cloud computers that you want to create. Valid values: 1 to 300. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Absolute paths of files to monitor in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'Absolute path of the file to monitor in screen recording audit.', 'type' => 'string', 'required' => false, 'example' => 'C://test.txt', 'title' => ''], 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '1', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DirectoryId', + 'name' => 'RecordEventRegisters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', + 'description' => 'Absolute paths of registry keys to monitor in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'Absolute path of the registry key to monitor in screen recording audit.', 'type' => 'string', 'required' => false, 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'To be hidden.', + 'maxItems' => 10, + 'title' => '', + 'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'RecordEventDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', - ], + 'schema' => ['description' => 'Duration of screen recording after an event is detected in screen recording audit. Unit: minutes. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'ResetDesktop', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the policy.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'system-all-enabled-policy', - ], + 'schema' => ['description' => 'Reset cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], ], [ - 'name' => 'ChargeType', + 'name' => 'DeviceConnectHint', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the cloud computers.'."\n" - ."\n" - .'Default value: PostPaid. Valid values:'."\n" - ."\n" - .'* Postpaid: pay-as-you-go'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PrePaid: subscription'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], + 'schema' => ['description' => 'Peripheral connection hint control.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'FileMigrate', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration of the cloud desktop that you want to create. The unit is specified by the `PeriodUnit` parameter. This parameter takes effect and is required only when the `ChargeType` parameter is set to `PrePaid`.'."\n" - ."\n" - .'* Valid values if the `PeriodUnit` parameter is set to `Month`:'."\n" - ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 6'."\n" - ."\n" - .'* Valid values if the `PeriodUnit` parameter is set to `Year`:'."\n" - ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 4'."\n" - .' * 5'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'File migration.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'WuyingKeeper', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the subscription duration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', - ], + 'schema' => ['description' => 'Wuying Keeper switch.', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'InternetPrinter', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable automatic payment.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'SafeMenu', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto-renewal. This parameter takes effect only when the ChargeType parameter is set to PrePaid.', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'PromotionId', + 'name' => 'ScreenDisplayMode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the sales promotion.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '23141', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'UserAssignMode', + 'name' => 'ClientControlMenu', 'in' => 'query', - 'schema' => [ - 'description' => 'How the cloud computers are assigned.'."\n" - ."\n" - .'> If you do not specify the `EndUserId` parameter, the cloud computers are not assigned to end users after the cloud computers are created.'."\n" - ."\n" - .'Default value: ALL. Valid values:'."\n" - ."\n" - .'* ALL: If you specify the EndUserId parameter, the cloud computers are assigned to all specified end users after the cloud computers are created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PER_USER: If you specify the EndUserId parameter, the cloud computers are evenly assigned to the specified end users after the cloud computers are created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' In this case, you must make sure that the value of the Amount parameter can be divided by the N value of the EndUserId.N parameter that you specify.'."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'ALL' => '', - 'PER_USER' => '', - ], - 'example' => 'ALL', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Hostname', + 'name' => 'FileTransferSpeedLocation', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom hostnames of the cloud computers. This parameter is valid only if the office network is an AD office network and the operating system type of the cloud computers is Windows.'."\n" - ."\n" - .'The hostnames must meet the following requirements:'."\n" - ."\n" - .'* The hostnames must be 2 to 15 characters in length.'."\n" - .'* The hostnames can contain only letters, digits, and hyphens (-). The hostnames cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.'."\n" - ."\n" - .'When you create multiple cloud computers, you can use the `name_prefix[begin_number,bits]name_suffix` naming format to name the cloud computers. For example, if you set the value of the Hostname parameter to ecd-\\[1,4]-test, the hostname of the first cloud computer is ecd-0001-test, the hostname of the second cloud computer is ecd-0002-test, and so on.'."\n" - ."\n" - .'* `name_prefix`: the prefix of the hostname.'."\n" - .'* `[begin_number,bits]`: the sequential number in the hostname. The `begin_number` value is the starting digit. Valid values of begin_number: 0 to 999999. Default value: 0. The `bits` value is the number of digits. Valid values: 1 to 6. Default value: 6.'."\n" - .'* `name_suffix`: the suffix of the hostname.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testhost', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'FileTransferSpeed', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the end users to which you want to assign the cloud computers. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of an end user to which you want to assign the cloud computer.'."\n" - ."\n" - .'* During a specific period of time, only one end user can use the cloud computer.'."\n" - .'* If you do not specify the `EndUserId` parameter, the cloud computers are not assigned to any end user after the cloud computers are created.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - 'required' => false, - 'example' => '123456789', - 'maxItems' => 300, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Tag', + 'name' => 'FileTransferAddress', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to add to the cloud desktop.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that you want to add.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag. You can specify 1 to 20 keys for a tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The value of the tag. You can specify 1 to 20 values for a tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DesktopNameSuffix', + 'name' => 'CpdDriveClipboard', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to automatically add suffixes to the names of cloud computers when you create multiple cloud computers at the same time.'."\n" - ."\n" - .'Default value: true. Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* False'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'VolumeEncryptionEnabled', + 'name' => 'UseTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'VolumeEncryptionKey', + 'name' => 'AutoReconnect', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to obtain a list of KMS keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], + 'schema' => ['title' => 'Client auto-reconnect toggle', 'description' => 'Client auto-reconnect switch', 'type' => 'string', 'example' => 'off', 'required' => false], ], [ - 'name' => 'DesktopMemberIp', + 'name' => 'MobileWuyingKeeper', 'in' => 'query', - 'schema' => [ - 'description' => 'The private IP address of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.0.0.1', - ], + 'schema' => ['title' => 'Mobile Wuying Keeper toggle', 'description' => 'Mobile Wuying Keeper switch', 'type' => 'string', 'example' => 'off', 'required' => false], ], [ - 'name' => 'UserCommands', + 'name' => 'MobileSafeMenu', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Details about the custom command scripts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom command script of the user.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContentEncoding' => [ - 'title' => '自定义脚本命令编码，默认Base64编码', - 'description' => 'The encoding mode of the command content.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Base64: encodes the command content in Base64.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PlainText: does not encode the command content.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Base64' => '', - 'PlainText' => '', - ], - 'example' => 'Base64', - 'default' => 'Base64', - ], - 'Content' => [ - 'description' => 'The command content.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****', - 'maxLength' => 15000, - ], - 'ContentType' => [ - 'description' => 'The language type of the command.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RunPowerShellScript: PowerShell commands (applicable to Windows cloud computers).'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RunShellScript: shell commands (applicable to Linux cloud computers).'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RunBatScript: batch commands (applicable to Windows cloud computers).'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RunPowerShellScript' => '', - 'RunShellScript' => '', - 'RunBatScript' => '', - ], - 'example' => 'RunPowerShellScript', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['title' => 'Toggle for Windows security controls on mobile devices', 'description' => 'Mobile Windows security control switch', 'type' => 'string', 'example' => 'off', 'required' => false], ], [ - 'name' => 'BundleModels', + 'name' => 'MobileWyAssistant', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', + 'schema' => ['title' => 'Toggle for Xiao Ying on mobile devices ', 'description' => 'Mobile Xiao Ying switch', 'type' => 'string', 'example' => 'off', 'required' => false], + ], + [ + 'name' => 'RecordEventLevels', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The cloud computer templates.'."\n", + 'maxItems' => 20, + 'description' => 'Levels of screen recording events', + 'title' => 'Levels of screen recording management events ', 'type' => 'array', 'items' => [ - 'description' => 'The desktop template that you want to use.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'BundleId' => [ - 'description' => 'The ID of a cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b-je9hani001wfn****', - ], - 'Amount' => [ - 'description' => 'The number of cloud computers that you want to create. Valid values: 1 to 300. Default value: null.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '300', - 'example' => '1', - ], - 'EndUserIds' => [ - 'description' => 'The IDs of the end users to whom the cloud computer are assigned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of an end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], - 'required' => false, - 'maxItems' => 100, - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer. The name must meet the following requirements:'."\n" - ."\n" - .'* The name must be 1 to 64 characters in length.'."\n" - .'* The name must start with a letter but cannot start with `http://` or `https://`.'."\n" - .'* The name can only contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testDesktopName', - ], - 'Hostname' => [ - 'description' => 'The custom hostnames of the cloud computers. This parameter is valid only if the office network is an AD office network and the operating system type of the cloud computers is Windows.'."\n" - ."\n" - .'The hostnames must meet the following requirements:'."\n" - ."\n" - .'* The hostnames must be 2 to 15 characters in length.'."\n" - .'* The hostnames can contain only letters, digits, and hyphens (-). The hostnames cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.'."\n" - ."\n" - .'When you create multiple cloud computers, you can use the `name_prefix[begin_number,bits]name_suffix` naming format to name the cloud computers. For example, if you set the value of the Hostname parameter to ecd-\\[1,4]-test, the hostname of the first cloud computer is ecd-0001-test, the hostname of the second cloud computer is ecd-0002-test, and so on.'."\n" - ."\n" - .'* `name_prefix`: the prefix of the hostname.'."\n" - .'* `[begin_number,bits]`: the sequential number in the hostname. The `begin_number` value is the starting digit. Valid values of begin_number: 0 to 999999. Default value: 0. The `bits` value is the number of digits. Valid values: 1 to 6. Default value: 6.'."\n" - .'* `name_suffix`: the suffix of the hostname.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testhost', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to query the list of KMS keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], + 'EventType' => ['title' => 'Management event Type ', 'description' => 'Event type', 'type' => 'string', 'example' => 'StartApplication', 'required' => false], + 'EventLevel' => ['title' => 'Management event Level ', 'description' => 'Event level', 'type' => 'string', 'example' => 'HIGH', 'required' => false], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 20, + 'example' => '', ], ], [ - 'name' => 'DesktopTimers', + 'name' => 'RecordEventFileExts', 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', + 'style' => 'flat', 'schema' => [ - 'description' => 'The details of the scheduled task on cloud computers.'."\n", + 'maxItems' => 6, + 'description' => 'File name extensions for screen recording events', + 'title' => 'File name extensions for screen recording management events ', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NoOperationReboot', - ], - 'CronExpression' => [ - 'description' => 'The cron expression for the scheduled task.'."\n" - ."\n" - .'> The time must be in UTC. For example, for 24:00 (UTC+8), you must set the value to 0 0 16 ? \\* 1,2,3,4,5,6,7'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 40 7 ? * 1,2,3,4,5,6,7', - ], - 'Interval' => [ - 'description' => 'The interval at which cloud computers are created. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Enforce' => [ - 'description' => 'Specifies whether to forcibly execute the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: forcibly executes the scheduled task regardless of the status and connection of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: does not forcibly execute the scheduled task.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'True', - ], - 'ResetType' => [ - 'description' => 'The reset type of the cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESET_TYPE_SYSTEM: resets the system disks.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RESET_TYPE_BOTH: resets the system disks and data disks.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => 'RESET_TYPE_SYSTEM', - 'RESET_TYPE_BOTH' => 'RESET_TYPE_BOTH', - ], - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'OperationType' => [ - 'description' => 'The operations that scheduled tasks support. This parameter is valid only when TimerType is set to NoConnect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hibernate: hibernates the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Shutdown: stops the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hibernate' => 'Hibernate', - 'Shutdown' => 'Shutdown', - ], - 'example' => 'Shutdown', - ], - 'AllowClientSetting' => [ - 'description' => 'Specifies whether to allow the end user to configure the scheduled task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], + 'items' => ['type' => 'string', 'example' => 'txt', 'description' => '', 'required' => false, 'title' => ''], 'required' => false, - 'maxItems' => 20, + 'example' => '', ], ], [ - 'name' => 'SubnetId', + 'name' => 'ExternalDrive', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'MonthDesktopSetting', + 'name' => 'WatermarkShadow', 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '> This parameter is not publicly available.', - 'type' => 'object', - 'properties' => [ - 'UseDuration' => [ - 'description' => '> This parameter is not publicly available.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => 'null', - ], - 'BuyerId' => [ - 'description' => '> This parameter is not publicly available.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'null', - ], - 'DesktopId' => [ - 'description' => '> This parameter is not publicly available.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'SnapshotPolicyId', + 'name' => 'ClientCreateSnapshot', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the auto-snapshot policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'sp-28mp6my0l6zow****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'AcademicProxy', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-3mtuc28rx95lx****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DesktopAttachment', + 'name' => 'ModelLibrary', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The input parameters used when no templates are used.', - 'type' => 'object', - 'properties' => [ - 'ImageId' => [ - 'description' => 'The ID of the image.', - 'type' => 'string', - 'required' => false, - 'example' => 'm-39ddhdb0ggzjx*****', - ], - 'SystemDiskCategory' => [ - 'description' => 'The category of the system disk. Valid values:'."\n" - ."\n" - .'* cloud_auto: SSD'."\n" - .'* cloud_essd: ESSD', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_auto', - ], - 'SystemDiskSize' => [ - 'description' => 'The size of the system disk. Unit: GiB.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], - 'SystemDiskPerLevel' => [ - 'description' => 'The performance level of the system disk. Valid values:'."\n" - ."\n" - .'- PL0 (default)'."\n" - .'- PL1', - 'type' => 'string', - 'required' => false, - 'example' => 'PL0', - ], - 'DataDiskSize' => [ - 'description' => 'The size of the data disk. Unit: GiB.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], - 'DataDiskCategory' => [ - 'description' => 'The category of the data disk. Valid values:'."\n" - ."\n" - .'* cloud_auto: SSD'."\n" - .'* cloud_essd: ESSD', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_auto', - ], - 'DataDiskPerLevel' => [ - 'description' => 'The performance level of the data disk. Valid values:'."\n" - ."\n" - .'- PL0 (default)'."\n" - .'- PL1', - 'type' => 'string', - 'required' => false, - 'example' => 'PL0', - ], - 'DefaultLanguage' => [ - 'description' => 'The default display language:'."\n" - ."\n" - .'- zh-CN: Simplified Chinese'."\n" - .'- zh-HK: Traditional Chinese'."\n" - .'- en-US: English'."\n" - .'- ja-JP: Japanese', - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], - 'DesktopType' => [ - 'description' => 'The desktop type. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) operation to query the IDs of supported desktop types.', - 'type' => 'string', - 'required' => false, - 'example' => 'eds.enterprise_office.8c16g', - ], - ], - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'TimerGroupId', + 'name' => 'PortProxy', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the timer group.', - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0caoeogrk9m5****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'SavingPlanId', + 'name' => 'BusinessChannel', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The ID of the saving plan.', - 'example' => 'spn-4b945dc4Wktd****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'DiskOverload', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ExtendInfo', + 'name' => 'CpuOverload', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'AppRuleId', + 'name' => 'MemoryOverload', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'QosRuleId', + 'name' => 'ResolutionDpi', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '400', 'minimum' => '25', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ChannelCookie', + 'name' => 'HoverConfigMsg', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MultiScreen', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'KeyboardControl', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AdminKeyboardOnWindows', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AdminKeyboardOnFullScreen', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n" - ."\n" - .'> This parameter is returned only when you set the ChargeType parameter to PrePaid.'."\n", - 'type' => 'string', - 'example' => '123456789', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'DesktopId' => [ - 'description' => 'The IDs of the cloud computers that are created. If multiple cloud computers are created, multiple IDs are returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => '["ecd-gx2x1dhsmucyy****"]', - ], - ], + 'PolicyGroupId' => ['description' => 'Cloud desktop policy ID.', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEncryptionKey.Missing', - 'errorMessage' => 'Parameter VolumeEncryptionKey is missing.', - ], - [ - 'errorCode' => 'InvalidEncryptionKey.NotAuthorized', - 'errorMessage' => 'Eds service cannot access the given VolumeEncryptionKey.', - ], - [ - 'errorCode' => 'InvalidEncryptionKey.NotFound', - 'errorMessage' => 'The specified VolumeEncryptionKey is not found.', - ], - [ - 'errorCode' => 'InvalidImageStatus.NotValid', - 'errorMessage' => 'The specified image status is not valid.', - ], - [ - 'errorCode' => 'InvalidImageVersion.NotSupported', - 'errorMessage' => 'The specified image version is no longer supported.', - ], - [ - 'errorCode' => 'InvalidMemberIp.DesktopAmount', - 'errorMessage' => 'The desktop amount need to be 1.', - ], - [ - 'errorCode' => 'InvalidPolicyGroup.Status', - 'errorMessage' => 'The target policy group is being created. Please try again later.', - ], - [ - 'errorCode' => 'Protocol.NotAllowed', - 'errorMessage' => 'Procotol of the image is not allowed.', - ], - [ - 'errorCode' => 'ExistedHostname', - 'errorMessage' => 'The specified hostname is existed on the domain.', - ], - [ - 'errorCode' => 'HostnameCannotCustomizeForLinux', - 'errorMessage' => 'Customizing hostname is not supported for Linux desktop.', - ], - [ - 'errorCode' => 'IncorrectDirectoryStatus', - 'errorMessage' => 'Only registered directory can create desktop.', - ], - [ - 'errorCode' => 'IncorrectDirectoryType', - 'errorMessage' => 'The protocol type of directory and desktop do not match.', - ], - [ - 'errorCode' => 'InvalidAmount', - 'errorMessage' => 'The specified Amount is not a valid value.', - ], - [ - 'errorCode' => 'InvalidAmount.NotTimesOfUsers', - 'errorMessage' => 'The specified Amount is notmatch EndUserId size.', - ], - [ - 'errorCode' => 'InvalidDesktopBundle.NotFound', - 'errorMessage' => 'The specified param BundleId is not found.', - ], - [ - 'errorCode' => 'InvalidDirectoryId.NotFound', - 'errorMessage' => 'The specified param DirectoryId is not found.', - ], - [ - 'errorCode' => 'InvalidDirectoryType.NotSupported', - 'errorMessage' => 'The specified DirectoryType is not supported.', - ], - [ - 'errorCode' => 'InvalidEncryptionEnabled.Invalid', - 'errorMessage' => 'The parameter VolumeEncryptionEnabled is invalid.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'Create a Region-Free Policy', + 'changeSet' => [ + ['createdAt' => '2025-12-10T02:25:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-23T13:39:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CreateCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 123456789\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n [\\"ecd-gx2x1dhsmucyy****\\"]\\n","errorExample":""}]', - 'title' => 'CreateDesktops', - 'description' => 'Before you create cloud computers, complete the following preparations:'."\n" - ."\n" - .'* An office network (formerly called workspace) and users are created. For more information, see:'."\n" - ."\n" - .' * Convenience office network: [CreateSimpleOfficeSite](~~215416~~) and [CreateUsers](~~437832~~).'."\n" - .' * Active Directory (AD) office network: [CreateADConnectorOfficeSite](~~215417~~) and [Create an AD user](~~188619~~).'."\n" - ."\n" - .'* Make sure a cloud computer template exists. If no cloud computer template exists, call the [CreateBundle](~~188883~~) operation to create a template.'."\n" - ."\n" - .'* Make sure a policy exists. If no policy exists, call the [CreatePolicyGroup](~~188889~~) operation to create a policy.'."\n" - ."\n" - .'If you want the cloud computers to automatically execute a custom command script, you can use the `UserCommands` field to configure a custom command.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'translator' => 'machine', ], - 'CreateDiskEncryptionService' => [ - 'summary' => 'Enables disk encryption and creates the required service-linked role in your Resource Access Management (RAM) user account for the Enterprise Drive.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateCloudDriveGroup' => [ + 'summary' => 'Disk organization authorization.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '214552063030752', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateDiskEncryptionService', - ], - 'DescribeKmsKeys' => [ - 'summary' => 'Queries Key Management Service (KMS) keys of users. The first time you call this operation, you can try to create a service key for Elastic Desktop Service (EDS) and call the operation to return results.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the team.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7f4bbccda0cf40bb85981b65fb5e****', 'minLength' => 0, 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '133183', - 'abilityTreeNodes' => [ - 'FEATUREgwsOD038K', + [ + 'name' => 'TotalSize', + 'in' => 'query', + 'schema' => ['description' => 'The size of the cloud disk in Cloud Drive Service. Unit: bytes. The size is unlimited.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1024000', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AdminUserIds', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'description' => 'User ID.', 'example' => 'admin1', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'maxItems' => 100, + 'minItems' => 0, + 'description' => 'List of user IDs to be set as team space administrators.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameter.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'KmsServiceStatus' => [ - 'description' => 'Indicates whether KMS is activated.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* disabled'."\n" - .'* enabled'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'disabled ' => '', - 'enabled ' => '', - ], - 'example' => 'enabled', - ], - 'AuthorizeStatus' => [ - 'description' => 'The authorization status.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* not_authorized'."\n" - .'* authorized'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'not_authorized' => '', - 'authorized' => '', - ], - 'example' => 'authorized', - ], - 'Keys' => [ - 'description' => 'Customer master key (CMK)'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details about the CMK.', - 'type' => 'object', - 'properties' => [ - 'KeyId' => [ - 'description' => 'The ID of the key.', - 'type' => 'string', - 'example' => '05754286-3ba2-4fa6-8d41-4323aca6****', - ], - 'Arn' => [ - 'description' => 'The Alibaba Cloud Resource Name (ARN) of the key in KMS.', - 'type' => 'string', - 'example' => 'acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****', - ], - 'Alias' => [ - 'description' => 'The alias of the key.', - 'type' => 'string', - 'example' => 'TestAlias', - ], - 'Type' => [ - 'description' => 'The type of the key.', - 'type' => 'string', - 'enumValueTitles' => [ - 'ServiceKey ' => '', - 'CustomKey ' => '', - ], - 'example' => 'ServiceKey', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'FD14D2A1-CC39-5ED3-8EE7-11FDF4B9D6D2', 'title' => ''], + 'Code' => ['description' => 'The returned results. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful. true: The call is successful. false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Data' => ['description' => 'The data information.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"KmsServiceStatus\\": \\"enabled\\",\\n \\"AuthorizeStatus\\": \\"authorized\\",\\n \\"Keys\\": [\\n {\\n \\"KeyId\\": \\"05754286-3ba2-4fa6-8d41-4323aca6****\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****\\",\\n \\"Alias\\": \\"TestAlias\\",\\n \\"Type\\": \\"ServiceKey\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeKmsKeys', - ], - 'DescribeDesktopInfo' => [ - 'summary' => 'Queries the basic information about cloud computers.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD14D2A1-CC39-5ED3-8EE7-11FDF4B9D6D2\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'Add team space', + 'description' => 'The disk team list is synchronized from the EDS client -> User Management -> organization chart. If a user wants to use a team space, you can move the user to the specified organization in the User Management interface. The user can then see the team space menu bar in the disk client.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCloudDriveGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateCloudDriveService' => [ + 'summary' => 'Create a PDS (formerly Wuying Cloud Disk)', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud drive.', 'type' => 'string', 'required' => false, 'example' => 'wuying-cds', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["ecd-gx2x1dhsmucyy****"]', - ], + 'description' => 'The type of the office site.', + 'enumValueTitles' => ['SIMPLE' => 'A simple office site.', 'AD_CONNECTOR' => 'An AD connector-based office site.'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'default' => 'SIMPLE', + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'NeedExtraInfo', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The ID of the office site. This parameter applies only when `OfficeSiteType` is set to `AD_CONNECTOR`.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '062B1439-709A-580E-85DF-CE97A1560565', - ], - 'Desktops' => [ - 'description' => 'The basic information about cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CurrentAppVersion' => [ - 'description' => 'The version of the cloud computer image.'."\n", - 'type' => 'string', - 'example' => '1.4.0-R-***', - ], - 'StartTime' => [ - 'description' => 'The time when the cloud computer was first started.'."\n", - 'type' => 'string', - 'example' => '2020-11-06T08:31Z', - ], - 'ConnectionStatus' => [ - 'description' => 'The connection status of the user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - .'* Disconnected'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => 'Connected', - 'Disconnected' => 'Disconnected', - ], - 'example' => 'Disconnected', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'DesktopStatus' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - .'* Failed'."\n" - .'* Starting'."\n" - .'* Running'."\n" - .'* Stopping'."\n" - .'* Expired'."\n" - .'* Deleted'."\n" - .'* Pending'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => 'Stopped', - 'Failed' => 'Failed', - 'Starting' => 'Starting', - 'Running' => 'Running', - 'Stopping' => 'Stopping', - 'Expired' => 'Expired', - 'Deleted' => 'Deleted', - 'Pending' => 'Pending', - ], - 'example' => 'Running', - ], - 'ManagementFlag' => [ - 'description' => 'The information about flags that are used to manage cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The flag that is used to manage the cloud desktop.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Migrating'."\n" - .'* Updating'."\n" - .'* NoFlag'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Migrating' => 'Migrating', - 'Updating' => 'Updating', - 'NoFlag' => 'NoFlag', - ], - 'example' => 'NoFlag', - ], - ], - 'NewAppVersion' => [ - 'description' => 'The version number of the image that can be updated on the cloud computer.'."\n", - 'type' => 'string', - 'example' => '1.6.0-R-***', - ], - 'ReleaseNote' => [ - 'description' => 'The description of the image version that can be updated.'."\n", - 'type' => 'string', - 'example' => 'Test package 03-07', - ], - 'NewAppSize' => [ - 'description' => 'The size of the update package. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '568533470', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", - 'type' => 'string', - 'example' => 'dg-3uiojcc0j4kh7****', - ], - ], - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Cloud Enterprise Network (CEN) instance. This parameter is required when `OfficeSiteType` is set to `AD_CONNECTOR` and you do not specify `OfficeSiteId`.', 'type' => 'string', 'required' => false, 'example' => 'cen-g4ba1mkji8nj6****', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A1560565\\",\\n \\"Desktops\\": [\\n {\\n \\"CurrentAppVersion\\": \\"1.4.0-R-***\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ManagementFlag\\": [\\n \\"NoFlag\\"\\n ],\\n \\"NewAppVersion\\": \\"1.6.0-R-***\\",\\n \\"ReleaseNote\\": \\"测试升级包03-07\\\\n\\",\\n \\"NewAppSize\\": 568533470,\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDesktopInfo', - ], - 'DescribeDesktops' => [ - 'summary' => 'Queries the details of cloud computers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the domain controller. This parameter is required when `OfficeSiteType` is set to `AD_CONNECTOR` and you do not specify `OfficeSiteId`.', 'type' => 'string', 'required' => false, 'example' => 'test.local', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52826', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', + [ + 'name' => 'UserMaxSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum size of the personal disk for each user, in bytes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '104857600', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MaxSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The total capacity of the cloud drive.'."\n" + ."\n" + .'- For pay-as-you-go cloud drives, the unit is bytes.'."\n" + ."\n" + .'- For subscription cloud drives, the unit is GiB. For example, set the value to 500 for 500 GiB, or to 2048 for 2 TiB.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '536870912000', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", - 'type' => 'string', + 'description' => 'A list of user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'example' => 'dg-boyczi8enfyc5****', + 'docRequired' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopStatus', + 'name' => 'BizType', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - .'* Starting'."\n" - .'* Rebuilding'."\n" - .'* Running'."\n" - .'* Stopping'."\n" - .'* Expired'."\n" - .'* Deleted'."\n" - .'* Pending'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Running', - ], + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'SolutionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 100'."\n" - .'* Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'CdsChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.'."\n", + 'description' => 'The billing method of the cloud drive.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], 'type' => 'string', 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'example' => 'PostPaid', + 'title' => '', ], ], [ - 'name' => 'UserName', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the end user.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'The order is automatically paid. Make sure that your account has a sufficient balance, or an unpaid order will be generated.', 'false' => 'An unpaid order is generated. To pay for the order, log on to the console, go to User Center > My Orders, and use the order ID returned in the response. (Default)'], + 'type' => 'boolean', 'required' => false, - 'example' => 'Alice', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'DesktopName', + 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable auto-renewal. This parameter applies only when `CdsChargeType` is set to `PrePaid`.', + 'enumValueTitles' => ['true' => 'Auto-renewal is enabled.', 'false' => 'Auto-renewal is disabled. (Default)'], + 'type' => 'boolean', 'required' => false, - 'example' => 'testDesktopName', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'DirectoryId', + 'name' => 'Period', 'in' => 'query', 'schema' => [ - 'description' => 'The directory ID, which is the same as the office network ID.'."\n", - 'type' => 'string', + 'description' => 'The subscription duration. The unit is specified by `PeriodUnit`. This parameter is required only when `CdsChargeType` is set to `PrePaid`.', + 'enumValueTitles' => [1 => '', '', ''], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-363353****', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", + 'description' => 'The unit of the subscription duration. This parameter is required only when `CdsChargeType` is set to `PrePaid`.', + 'enumValueTitles' => ['Year' => 'year'], 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', + 'example' => 'Year', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteName', + 'name' => 'UserCount', 'in' => 'query', 'schema' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', + 'description' => 'The maximum number of users for a subscription cloud drive. This parameter is required only when `CdsChargeType` is set to `PrePaid`.', + 'enumValueTitles' => [5 => 'For a `MaxSize` of 500 GiB.', 20 => 'For a `MaxSize` of 2 TiB.', 50 => 'For a `MaxSize` of 5 TiB.'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'example' => 'testName', + 'example' => '5', + 'title' => '', ], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'ResellerOwnerUid', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system-all-enabled-policy', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A156****', 'title' => ''], + 'CdsId' => ['description' => 'The ID of the enterprise network disk.', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****', 'title' => ''], + 'CdsName' => ['description' => 'The name of the cloud storage service.', 'type' => 'string', 'example' => 'CDS_Windows_1126', 'title' => ''], + 'MaxSize' => ['description' => 'The maximum storage usage of the enterprise network disk. Unit: bytes.', 'type' => 'string', 'example' => '5368709120', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The office network type.', + 'enumValueTitles' => ['SIMPLE' => 'convenience office network', 'AD_CONNECTOR' => 'AD office network'], + 'type' => 'string', + 'example' => 'AD_CONNECTOR', + 'title' => '', + ], + 'CenId' => ['description' => 'The ID of the Cloud Enterprise Network (CEN) instance.'."\n" + ."\n" + .'> If you want to connect to a cloud desktop through a VPC, you can add the office network to a CEN instance. This CEN instance connects to your on-premises network through a VPN or a dedicated line.', 'type' => 'string', 'example' => 'cen-638u3wxds9snyc****', 'title' => ''], + 'DomainName' => ['description' => 'The name of the Active Directory (AD) domain corresponding to the AD office network.', 'type' => 'string', 'example' => 'test1.local', 'title' => ''], + 'OrderId' => ['description' => 'The order ID. You can obtain the order ID on the Order Management page in the Alibaba Cloud User Center.', 'type' => 'string', 'example' => '214552063030752', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ExistConflictCds', 'title' => ''], + 'ConflictCdsAndOrder' => [ + 'description' => 'The existing enterprise network disks or orders for enterprise network disks that conflict with the enterprise network disk that you want to create.', + 'type' => 'object', + 'properties' => [ + 'ConflictCds' => [ + 'description' => 'The information of conflicting enterprise network disks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CdsId' => ['description' => 'The ID of the enterprise network disk.', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions that are supported by Elastic Desktop Service.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ConflictOrder' => [ + 'description' => 'The information of conflicting unpaid orders for enterprise network disks (orders for subscription enterprise network disks).', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CdsId' => ['description' => 'The ID of the enterprise network disk (The order is not paid, and the enterprise network disk cannot be used).', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****', 'title' => ''], + 'OrderId' => ['description' => 'The order ID. You can obtain the order ID on the **Order Management** page in the Alibaba Cloud User Center.', 'type' => 'string', 'example' => '22442411898****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CreateCloudDriveService', + 'description' => 'Before using this interface, make sure you understand the billing methods and pricing of Drive and Photo Service. For more information, see [Overview of Drive and Photo Service](~~386301~~).', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-19T03:11:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-12T12:16:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-12-11T14:21:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T14:32:34.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveService'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ChargeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Postpaid (default): pay-as-you-go'."\n" - .'* PrePaid: subscription'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCloudDriveService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'PostPaid', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A156****\\",\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"CdsName\\": \\"CDS_Windows_1126\\",\\n \\"MaxSize\\": \\"5368709120\\",\\n \\"OfficeSiteType\\": \\"AD_CONNECTOR\\",\\n \\"CenId\\": \\"cen-638u3wxds9snyc****\\",\\n \\"DomainName\\": \\"test1.local\\",\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"ErrorCode\\": \\"ExistConflictCds\\",\\n \\"ConflictCdsAndOrder\\": {\\n \\"ConflictCds\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConflictOrder\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"OrderId\\": \\"22442411898****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'CreateCloudDriveUsers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ExpiredTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when a subscription cloud computer expires.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-12-31T15:59:59Z', - ], + 'schema' => ['description' => 'The ID of the region. You can call [DescribeRegions](~~196646~~) to obtain a list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ProtocolType', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], + 'schema' => ['description' => 'Enterprise cloud drive ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'UserMaxSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Maximum storage size for a user\'s personal cloud drive. This value must not exceed the remaining available capacity in the enterprise cloud drive. Unit: byte.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '209715200', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The authorized users of the cloud computer. You can specify the IDs of 1 to 100 users.'."\n" - ."\n" - .'> During a specific period of time, only one user can connect to and use the cloud computer.'."\n", + 'description' => 'List of end user IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The authorized user of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => false, - 'example' => 'alice', + 'items' => ['description' => 'End user ID.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'required' => true, + 'docRequired' => true, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ExcludedEndUserId', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The list of authorized users that you want to exclude from the cloud computer. You can specify the IDs of 1 to 100 users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The authorized user that you want to exclude from the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'andy', + 'description' => 'Response message collection.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '05F0A7AE-17F1-53DF-BD99-ABF936FA****', 'title' => ''], ], - 'required' => false, - 'example' => 'andy', - 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CreateCloudDriveUsers', + 'summary' => 'Creates personal cloud drives for users within your enterprise cloud drive.', + 'changeSet' => [ + ['createdAt' => '2025-10-16T08:02:13.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveUsers'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05F0A7AE-17F1-53DF-BD99-ABF936FA****\\"\\n}","type":"json"}]', + ], + 'CreateConfigGroup' => [ + 'summary' => 'Create a configuration group. A configuration group contains settings for scheduled tasks on cloud desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FilterDesktopGroup', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to exclude pooled cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ [ - 'name' => 'ManagementFlag', + 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The flag that is used to manage the cloud desktops.'."\n", + 'description' => 'The region ID. This feature is not region-specific. You must set this parameter to cn-shanghai.', + 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai)'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Migrating' => '', - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'QueryFotaUpdate', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query the image update information about the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the configuration group.', 'type' => 'string', 'example' => 'Scheduled task group', 'required' => true, 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the configuration group.', 'type' => 'string', 'example' => 'Scheduled task description content', 'required' => false, 'maxLength' => 500, 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the configuration group.', + 'enumValueTitles' => ['Timer' => 'scheduled task'], + 'type' => 'string', + 'required' => true, + 'enum' => ['Timer'], + 'example' => 'Timer', + 'title' => '', ], ], [ - 'name' => 'Tag', + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product to which the configuration group applies.', + 'enumValueTitles' => ['CLOUD_DESKTOP' => 'cloud desktop'], + 'type' => 'string', + 'required' => true, + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + ], + [ + 'name' => 'ConfigTimers', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags that you want to add to the cloud computer. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud computers by group. This facilitates search and batch operations. For more information, see [Use tags to manage cloud computers](~~203781~~).'."\n", + 'description' => 'An array of scheduled task configurations.', 'type' => 'array', 'items' => [ - 'description' => 'The key-value pair of the tag. You can specify 1 to 20 key-value pairs. One tag key corresponds to only one tag value.'."\n", + 'description' => 'The configuration of a scheduled task.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '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.'."\n", + 'TimerType' => [ + 'description' => 'The type of the scheduled task.', + 'enumValueTitles' => ['NoOperationDisconnect' => 'Disconnect the cloud desktop after a specified period of user inactivity.', 'NoConnect' => 'Shut down or hibernate the cloud desktop if it has been disconnected for a specified period. You must also specify the `OperationType` parameter.', 'TimerBoot' => 'Start the cloud desktop at a specified time.', 'TimerReset' => 'Reset the cloud desktop at a specified time.', 'NoOperationShutdown' => 'Shut down the cloud desktop after a specified period of user inactivity.', 'NoOperationHibernate' => 'Hibernate the cloud desktop after a specified period of user inactivity.', 'TimerShutdown' => 'Shut down the cloud desktop at a specified time.', 'NoOperationReboot' => 'Restart the cloud desktop after a specified period of user inactivity.', 'TimerReboot' => 'Restart the cloud desktop at a specified time.'], + 'type' => 'string', + 'required' => true, + 'example' => 'TIMER_BOOT', + 'title' => '', + ], + 'CronExpression' => ['description' => 'The cron expression for the scheduled task.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The cron expression is based on UTC. For example, to run a task at 00:00 China Standard Time (UTC+8) every day, set this parameter to `0 0 16 ? * 1,2,3,4,5,6,7`.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7', 'title' => ''], + 'Interval' => ['description' => 'The time interval, in minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Enforce' => ['description' => 'Whether to forcefully execute the scheduled task.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ResetType' => [ + 'description' => 'The reset type for the cloud desktop.', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => 'Reset the system disk only.', 'RESET_TYPE_USER_DISK' => 'Reset the data disk only.', 'RESET_TYPE_BOTH' => 'Reset both the system disk and the data disk.'], + 'type' => 'string', + 'required' => false, + 'example' => 'RESET_TYPE_SYSTEM', + 'title' => '', + ], + 'AllowClientSetting' => ['description' => 'Whether to allow end users to configure the scheduled task.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'OperationType' => [ + 'description' => 'The operation to perform for the scheduled task. This parameter is valid only when `TimerType` is set to `NoConnect`.', + 'enumValueTitles' => ['Hibernate' => 'Hibernate', 'Shutdown' => 'Shut down'], 'type' => 'string', 'required' => false, - 'example' => 'TestKey', + 'example' => 'Shutdown', + 'title' => '', ], - 'Value' => [ - 'description' => 'The tag value. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.'."\n", + 'TriggerType' => [ + 'description' => 'The trigger condition for inactivity-based scheduled tasks.', + 'enumValueTitles' => ['Advanced' => 'Smart detection', 'Standard' => 'Standard detection'], 'type' => 'string', 'required' => false, - 'example' => 'TestValue', + 'example' => 'Standard', + 'title' => '', + ], + 'ProcessWhitelist' => [ + 'description' => 'The process whitelist for smart detection. If a process from this whitelist is running, the inactivity-based scheduled task does not run.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'required' => false, 'example' => 'chrome', 'title' => ''], + 'required' => false, + 'maxItems' => 30, + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'SegmentTimers' => [ + 'maxItems' => 10, + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OperationType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'StartCronExpression' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'EndCronExpression' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Interval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'TriggerType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ProcessWhitelist' => [ + 'maxItems' => 30, + 'description' => '', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Timezone' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Enforce' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ResetType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ImageId' => ['title' => '', 'description' => 'The image ID for a scheduled task that changes the image of a cloud desktop.', 'type' => 'string', 'example' => 'm-5b0vjqbiqu010XXXXXX', 'required' => false], + 'LockScreenTime' => ['title' => '', 'description' => 'The amount of inactive time, in seconds, before the screen automatically locks. This parameter applies only to Active Directory desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '1800', 'required' => false], + 'AppointmentTimer' => ['title' => '', 'description' => 'The execution time for a one-time scheduled task, specified as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764660600967', 'required' => false], + 'PatchId' => ['type' => 'string', 'example' => 'KB5082063', 'description' => '', 'title' => ''], + 'CreateSnapshot' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + 'VerificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IpSegments' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + 'maxItems' => 10, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result of the operation.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'EE9472BC-0B5D-5458-85CD-C52BDD******'], + 'GroupId' => ['description' => 'Configuration group ID.', 'type' => 'string', 'example' => 'ccg-0ctwi5zbswtql****', 'title' => ''], + 'Message' => ['description' => 'Result message.', 'type' => 'string', 'example' => '无', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'TestCode%sTestCode%sTestCode%s', 'errorMessage' => 'TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE9472BC-0B5D-5458-85CD-C52BDD******\\",\\n \\"GroupId\\": \\"ccg-0ctwi5zbswtql****\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', + 'title' => 'Create Configuration Group', + 'changeSet' => [ + ['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-22T12:24:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-26T02:20:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateDesktopGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SnapshotPolicyId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. To find the regions supported by Elastic Desktop Service (EDS), call the [DescribeRegions](~~DescribeRegions~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'BundleId', + 'in' => 'query', + 'schema' => ['description' => 'The bundle ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'b-je9hani001wfn****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the office network for the desktops.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the policy to apply to the desktops.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-9c2d6t2dwflqr****', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the desktop group. The name must be 1 to 30 characters long, start with a letter or a Chinese character, and must not begin with `http://` or `https://`. The name can contain Chinese characters, letters, digits, colons (:), underscores (\\_), periods (.), or hyphens (-).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SharedComputers01', 'title' => ''], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The directory ID.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dri-uf62w3qzt4aigvlcb****', 'title' => ''], + ], + [ + 'name' => 'ScaleStrategyId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the scaling policy.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ss-f9dkjz6vw3aaw****', 'title' => ''], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Virtual Private Cloud (VPC) that contains the office network for the desktops.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-uf6w8u60n8xbkg5el****', 'title' => ''], + ], + [ + 'name' => 'DefaultInitDesktopCount', + 'in' => 'query', + 'schema' => ['description' => 'The default number of desktops to create in the desktop group. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'KeepDuration', + 'in' => 'query', + 'schema' => ['description' => 'The duration for which a session is kept active after a user disconnects. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session is retained indefinitely.'."\n" + ."\n" + .'If a user reconnects within this period, they can resume their session. If they fail to reconnect, the session is terminated, and any unsaved data is lost.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '180000', 'title' => ''], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The billing method of the desktops.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go', 'PrePaid' => 'subscription'], + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'PrePaid', + 'title' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration for the desktops. This parameter is required only if `ChargeType` is set to `PrePaid`. The `PeriodUnit` parameter specifies the time unit for this duration.'."\n" + ."\n" + .'- If `PeriodUnit` is `Month`, the valid values are:'."\n" + ."\n" + .' - 1'."\n" + ."\n" + .' - 2'."\n" + ."\n" + .' - 3'."\n" + ."\n" + .' - 6'."\n" + ."\n" + .'- If `PeriodUnit` is `Year`, the valid values are:'."\n" + ."\n" + .' - 1'."\n" + ."\n" + .' - 2'."\n" + ."\n" + .' - 3'."\n" + ."\n" + .' - 4'."\n" + ."\n" + .' - 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the snapshot policy.', + 'description' => 'The time unit of the subscription period.', + 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year'], 'type' => 'string', 'required' => false, - 'example' => 'sp-hb12mclyne09xw***', + 'docRequired' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'OnlyDesktopGroup', + 'name' => 'OwnType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to query pooled cloud computers.'."\n", - 'type' => 'boolean', + 'description' => 'The type of the desktop.'."\n" + ."\n" + .'> This parameter is not yet available.', + 'enumValueTitles' => ['Personal (single-session)', 'Shared (multi-session)'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'true', + 'docRequired' => false, + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'AutoPay', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically pay for subscription orders.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Comments', + 'in' => 'query', + 'schema' => ['description' => 'A description or comments for the desktop group.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'comment', 'title' => ''], + ], + [ + 'name' => 'MinDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => 'The minimum number of desktops in the subscription desktop group. This parameter is required only if `ChargeType` is `PrePaid`. Valid values: 0 to `MaxDesktopsCount`. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of desktops in the pay-as-you-go desktop group. Valid values: 0 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'AllowAutoSetup', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer pool. If you specify `OnlyDesktopGroup`, ignore `DesktopGroupId`. If you leave `DesktopId` empty, all IDs of the cloud computers in the cloud computer pool are queried.````'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to allow automatic creation of desktops in the subscription desktop group. This parameter is required and applies only when `ChargeType` is set to `PrePaid`.', + 'enumValueTitles' => ['Disallow', 'Allow'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 'dg-2i8qxpv6t1a03****', + 'docRequired' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'OsTypes', + 'name' => 'AllowBufferCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of desktops to reserve in the pay-as-you-go desktop group. This parameter is required and applies only when `ChargeType` is set to `PostPaid`. Valid values:'."\n" + ."\n" + .'- 0: Does not reserve desktops.'."\n" + ."\n" + .'- N: Reserves N desktops, where N is an integer from 1 to 100.'."\n" + ."\n" + .'> If no desktops are reserved, a user must wait for a new desktop to be created and started, which can cause connection delays. We recommend reserving an appropriate number of desktops to improve connection times.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A client token to ensure the idempotence of the request. You can use your client to generate a token, but you must make sure that the token 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](~~25693~~).', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''], + ], + [ + 'name' => 'EndUserIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The operating systems (OSs).'."\n", + 'description' => 'An array of user IDs to authorize for the desktop group.', 'type' => 'array', - 'items' => [ - 'description' => 'The OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - .'* Windows'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], + 'items' => ['description' => 'A user ID.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'maxItems' => 10, + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopType', + 'name' => 'ResetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The desktop reset type.', + 'enumValueTitles' => ['Do not reset.', 'Reset only the system disk.', 'Reset only the user disk.', 'Reset both the system and user disks.'], + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'LoadPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The load balancing policy for the multi-session desktop group.'."\n" + ."\n" + .'> This parameter is not yet available.', + 'enumValueTitles' => ['Depth-first', 'Breadth-first'], + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'BindAmount', + 'in' => 'query', + 'schema' => ['description' => 'The number of concurrent sessions allowed per desktop in a multi-session desktop group.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Classify', 'in' => 'query', 'schema' => [ - 'description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of all supported types.'."\n", + 'description' => 'The type of the desktop group.'."\n" + ."\n" + .'> This parameter is not yet available.', + 'enumValueTitles' => ['teacher' => 'Desktop for teachers', 'student' => 'Desktop for students'], 'type' => 'string', 'required' => false, - 'example' => 'eds.general.2c8g', + 'example' => 'teacher', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'AllClassifyUsers', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to authorize all users in the desktop group\'s categories.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'boolean', 'required' => false, 'example' => 'Alice', 'title' => ''], + ], + [ + 'name' => 'VolumeEncryptionEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable disk encryption.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'VolumeEncryptionKey', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the key from Key Management Service (KMS) used for disk encryption. You can call the [ListKeys](~~28951~~) operation to obtain the key ID.', 'type' => 'string', 'required' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + ], + [ + 'name' => 'RatioThreshold', + 'in' => 'query', + 'schema' => ['description' => 'The session usage threshold that triggers auto scaling for multi-session desktop groups. Session usage is calculated by using the following formula:'."\n" + ."\n" + .'`Session usage = (Number of connected sessions / (Total number of desktops × Maximum number of sessions per desktop)) × 100%`'."\n" + ."\n" + .'When session usage reaches this threshold, new desktops are created. When session usage falls below this threshold, the group scales in by deleting surplus desktops.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', 'title' => ''], + ], + [ + 'name' => 'ConnectDuration', + 'in' => 'query', + 'schema' => ['description' => 'The maximum duration of a connected session. When the session duration reaches this value, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 (15 minutes) to 345600000 (4 days).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900000', 'title' => ''], + ], + [ + 'name' => 'IdleDisconnectDuration', + 'in' => 'query', + 'schema' => ['description' => 'The maximum duration that a session can be idle before it is automatically disconnected. A session is considered idle if there is no keyboard or mouse input. Unit: milliseconds. Valid values: 360000 (6 minutes) to 3600000 (60 minutes).'."\n" + ."\n" + .'Thirty seconds before disconnection, the user is prompted to save their work to prevent data loss.'."\n" + ."\n" + .'> This parameter applies only to desktops created from image version 1.0.2 or later.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360000', 'title' => ''], + ], + [ + 'name' => 'StopDuration', + 'in' => 'query', + 'schema' => ['description' => 'The amount of time a desktop can be idle before it is automatically stopped. Connecting to a stopped desktop automatically starts it. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300000', 'title' => ''], + ], + [ + 'name' => 'ProfileFollowSwitch', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable user data roaming.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Apsara File Storage NAS file system used for user data roaming.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'example' => 'kegd-nas-****', 'title' => ''], + ], + [ + 'name' => 'BuyDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => '- For `subscription` desktop groups: The number of desktops to purchase. Valid values: 0 to 200.'."\n" + ."\n" + .'- For `pay-as-you-go` desktop groups: The minimum number of desktops in the group. Valid values: 0 to `MaxDesktopsCount`. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'GroupVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the desktop group.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the images.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the image.', - 'type' => 'string', - 'required' => false, - 'example' => 'm-2g65ljy3ynrdq****', - ], + 'description' => 'Specifies whether to enable auto-renewal for the subscription desktop group.', + 'enumValueTitles' => ['true' => 'Enables auto-renewal.', 'false' => 'Disables auto-renewal.'], + 'type' => 'boolean', 'required' => false, - 'maxItems' => 100, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'DesktopStatusList', + 'name' => 'Tag', 'in' => 'query', - 'allowEmptyValue' => false, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of cloud computer status.'."\n", + 'description' => 'The list of tags. You can specify up to 20 tags.', 'type' => 'array', 'items' => [ - 'description' => 'The cloud computer status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - .'* Starting'."\n" - .'* Rebuilding'."\n" - .'* Running'."\n" - .'* Stopping'."\n" - .'* Expired'."\n" - .'* Deleted'."\n" - .'* Pending'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Stopped' => 'Stopped', - 'Starting' => 'Starting', - 'Rebuilding' => 'Rebuilding', - 'Running' => 'Running', - 'Stopping' => 'Stopping', - 'Expired' => 'Expired', - 'Deleted' => 'Deleted', - 'Pending' => 'Pending', + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The key cannot be an empty string, can be up to 128 characters long, and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => true, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag. The value can be an empty string. The value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => true, 'example' => 'TestValue', 'title' => ''], ], - 'example' => 'Stopped', + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 10, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GpuInstanceGroupId', + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_*****', 'title' => ''], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + ], + [ + 'name' => 'SystemDiskCategory', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the elastic GPU pool.'."\n", + 'description' => 'The type of the system disk.', + 'enumValueTitles' => ['cloud_auto' => 'ESSD AutoPL cloud disk', 'cloud_essd' => 'Enhanced SSD (ESSD)'], 'type' => 'string', 'required' => false, - 'example' => 'gp-0bm2iz1v6m6nx****', + 'example' => 'cloud_auto', + 'title' => '', ], ], [ - 'name' => 'QosRuleId', + 'name' => 'SystemDiskSize', + 'in' => 'query', + 'schema' => ['description' => 'The size of the system disk. Unit: GiB.'."\n" + ."\n" + .'> The system disk size must be at least the size of the image.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'SystemDiskPerLevel', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the network throttling rule.'."\n", + 'description' => 'The performance level (PL) of the ESSD. Default value: PL0.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0'], 'type' => 'string', 'required' => false, - 'example' => 'qos-5605u0gelk200****', + 'example' => 'PL0', + 'title' => '', ], ], [ - 'name' => 'SubPayType', + 'name' => 'DataDiskCategory', 'in' => 'query', 'schema' => [ - 'description' => 'The billing method of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* duration: hourly plan (available for users in the whitelist)'."\n" - .'* postPaid: pay-as-you-go'."\n" - .'* monthPackage: monthly subscription (120-hour or 250-hour computing plan)'."\n" - .'* prePaid: monthly subscription (unlimited-hour computing plan)'."\n", + 'description' => 'The type of the data disk.', + 'enumValueTitles' => ['cloud_auto' => 'ESSD AutoPL cloud disk', 'cloud_essd' => 'Enhanced SSD (ESSD)'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'duration' => '', - 'postPaid' => '', - 'monthPackage' => '', - 'prePaid' => '', - ], - 'example' => 'monthPackage', + 'example' => 'cloud_auto', + 'title' => '', ], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'DataDiskSize', + 'in' => 'query', + 'schema' => ['description' => 'The size of the data disk. Unit: GiB. The value must be a multiple of 20 and in the range of 0 to 16,380.'."\n" + ."\n" + .''."\n" + ."\n" + .'- A value of 0 indicates that no data disk is attached.'."\n" + ."\n" + .'- If the selected bundle uses an Enhanced SSD (ESSD) at PL0, the minimum data disk size is 40 GiB.'."\n" + ."\n" + .'- If the selected bundle uses an SSD, the minimum data disk size is 20 GiB.'."\n" + ."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'- A value of 0 indicates that no data disk is attached.'."\n" + ."\n" + .'- If the selected bundle uses an SSD, the minimum data disk size is 20 GiB.'."\n" + ."\n" + .''."\n" + ."\n" + .'Default value: 0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'DataDiskPerLevel', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the enterprise resource group.'."\n", + 'description' => 'The performance level (PL) of the ESSD. Default value: PL0.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0'], 'type' => 'string', 'required' => false, - 'example' => 'rg-4hsvzbbmqdzu3s****', + 'example' => 'PL0', + 'title' => '', ], ], [ - 'name' => 'FillResourceGroup', + 'name' => 'DefaultLanguage', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to query the information about the enterprise resource group.'."\n", - 'type' => 'boolean', + 'description' => 'The system language.', + 'enumValueTitles' => ['en-US' => 'English', 'zh-HK' => 'Traditional Chinese', 'zh-CN' => 'Simplified Chinese', 'ja-JP' => 'Japanese'], + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'example' => 'zh-CN', + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The desktop type. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) operation to query supported desktop types.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.16c64g', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Hostname', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The custom hostname for the desktops. This parameter is applicable only to Windows desktops in an AD office network.'."\n" + ."\n" + .'The hostname must meet the following naming conventions:'."\n" + ."\n" + .'- Must be 2 to 15 characters in length.'."\n" + ."\n" + .'- Can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen, contain consecutive hyphens, or consist only of digits.'."\n" + ."\n" + .'To generate sequential hostnames when creating multiple desktops, use the format `name_prefix[begin_number,bits]name_suffix`. For example, if you set the Hostname parameter to `ecd-[1,4]-test`, the first desktop is named ecd-0001-test, the second is named ecd-0002-test, and so on.'."\n" + ."\n" + .'- `name_prefix`: The prefix of the hostname.'."\n" + ."\n" + .'- `[begin_number,bits]`: The sequential number in the hostname. `begin_number` is the starting number, which can be an integer from 0 to 999999. The default value is 0. `bits` is the number of digits, which can be an integer from 1 to 6. The default value is 6.'."\n" + ."\n" + .'- `name_suffix`: The suffix of the hostname.', 'type' => 'string', 'required' => false, 'example' => 'testhost', 'title' => ''], ], [ 'name' => 'MultiResource', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether the shared group is a multi-cloud computer type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- true: a multi-cloud computer type.'."\n" - .'- false: a single-cloud computer type.', + 'description' => 'Specifies whether to create a desktop group.', + 'enumValueTitles' => ['true' => 'Create a desktop group.', 'false' => 'Create one or more individual desktops.'], 'type' => 'boolean', 'required' => false, 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'IncludeAutoSnapshotPolicy', + 'name' => 'ExclusiveType', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the pool type. To create a static pool, set this parameter to `Exclusive`. This is required if `SessionType` is `MultipleSession`.', 'type' => 'string', 'required' => false, 'example' => 'Exclusive', 'title' => ''], + ], + [ + 'name' => 'GroupAmount', + 'in' => 'query', + 'schema' => ['description' => 'The number of individual desktops to create. This parameter is required only if `MultiResource` is set to `false`. Valid values: 1 to 5. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SessionType', 'in' => 'query', 'schema' => [ - 'type' => 'boolean', + 'description' => 'The session type.', + 'enumValueTitles' => ['SingleSession' => 'Single-session', 'MultipleSession' => 'Multi-session'], + 'type' => 'string', + 'required' => false, + 'example' => 'SingleSession', + 'title' => '', ], ], + [ + 'name' => 'TimerGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the scheduled task group.', 'type' => 'string', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****', 'title' => ''], + ], + [ + 'name' => 'SnapshotPolicyId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => false, 'example' => 'sp-28mp6my0l6zow****', 'title' => ''], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserOuPath', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserGroupName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SimpleUserGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DeleteDuration', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used for the next query. If this parameter is left empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', - ], - 'TotalCount' => [ - 'description' => 'The total number of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'DesktopGroupId' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983', 'title' => ''], + 'OrderIds' => [ + 'description' => 'The order IDs.', + 'type' => 'array', + 'items' => ['description' => 'An order ID. Returned only when `ChargeType` is set to `PrePaid`.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Desktops' => [ - 'description' => 'The cloud computers.'."\n", + 'DesktopGroupIds' => [ + 'description' => 'The desktop group IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the cloud computer was created.'."\n", - 'type' => 'string', - 'example' => '2020-11-06T08:28Z', - ], - 'ChargeType' => [ - 'description' => 'The billing method of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Postpaid (default): pay-as-you-go'."\n" - .'* PrePaid: subscription'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PostPaid', - ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'testDesktopName', - ], - 'PolicyGroupName' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'SystemDiskSize' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PolicyGroupId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => 'system-all-enabled-policy', - ], - 'DesktopStatus' => [ - 'description' => 'The cloud computer status.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'DesktopType' => [ - 'description' => 'The cloud computer type.'."\n", - 'type' => 'string', - 'example' => 'ecd.basic.large', - ], - 'GpuCount' => [ - 'description' => 'The number of GPU cores.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'ProtocolType' => [ - 'description' => 'The protocol.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX'."\n" - .'* ASP'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'Memory' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - ], - 'GpuSpec' => [ - 'description' => 'The GPU Specifications.'."\n", - 'type' => 'string', - 'example' => 'NVIDIA T4', - ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'm-4zfb6zj728hhr****', - ], - 'DirectoryId' => [ - 'description' => 'The directory ID, which is the same as the office network ID (OfficeSiteId).'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'ManagementFlag' => [ - 'description' => 'The flag that is used to manage the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Migrating: The cloud computer is being migrated.'."\n" - .'* Updating: The configurations of the cloud computer are being updated.'."\n" - .'* NoFlag: No flags are available.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Migrating' => '', - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', - ], - 'DataDiskCategory' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'SystemDiskCategory' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'NetworkInterfaceId' => [ - 'description' => 'The ID of the supplementary network interface controller (NIC) created by EDS within an RAM user or Active Directory (AD) user. You cannot modify the ID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'DataDiskSize' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer pool to which cloud computers belong. Default value: null.``'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'OfficeSiteName' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'StartTime' => [ - 'description' => 'The time when the cloud computer was first started.'."\n", - 'type' => 'string', - 'example' => '2020-11-06T08:31Z', - ], - 'DirectoryType' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'SIMPLE', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'NetworkInterfaceIp' => [ - 'description' => 'The IP address of the supplementary NIC created by EDS within an RAM or AD user.'."\n", - 'type' => 'string', - 'example' => '192.168.74.165', - ], - 'ExpiredTime' => [ - 'description' => 'The time when a subscription cloud computer expired.'."\n", - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], - 'OsType' => [ - 'description' => 'The OS that is defined in the desktop template.'."\n", - 'type' => 'string', - 'example' => 'Windows', - ], - 'ConnectionStatus' => [ - 'description' => 'The connection status of the end user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Unknown'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Connected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Disconnected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => '', - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Disconnected', - ], - 'BundleId' => [ - 'description' => 'The ID of the template used to create the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'b-2g65ljy4291vl****', - ], - 'BundleName' => [ - 'description' => 'The name of the template used to create the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'Name', - ], - 'OfficeSiteType' => [ - 'description' => 'The account type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience account'."\n" - .'* AD_CONNECTOR: enterprise AD account'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'SIMPLE', - ], - 'HostName' => [ - 'description' => 'The hostname of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'Disks' => [ - 'description' => 'The information about the disks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the disk.'."\n", - 'type' => 'object', - 'properties' => [ - 'DiskType' => [ - 'description' => 'The type of the disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DATA: data disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'DiskId' => [ - 'description' => 'The disk ID.'."\n", - 'type' => 'string', - 'example' => 'd-jedbpr4sl9l37****', - ], - 'DiskSize' => [ - 'description' => 'The disk size. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'PerformanceLevel' => [ - 'description' => 'The performance level (PL) of the disk when an enterprise SSD (ESSD) is used.'."\n" - ."\n" - .'For more information about the differences among enterprise SSDs (ESSDs) at different PLs, see [ESSDs](~~122389~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - .'* PL0'."\n" - .'* PL3'."\n" - .'* PL2'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL0', - ], - 'DiskCategory' => [ - 'description' => 'The type of the disk. Valid values:'."\n" - ."\n" - .'* cloud_efficiency: ultra disk.'."\n" - .'* cloud_auto: standard SSD.'."\n" - .'* cloud_essd: enhanced SSD (ESSD).', - 'type' => 'string', - 'enumValueTitles' => [ - 'cloud_efficiency' => 'cloud_efficiency', - 'cloud_auto' => 'cloud_auto', - 'cloud_essd' => 'cloud_essd', - ], - 'example' => 'cloud_auto', - ], - ], - ], - ], - 'Tags' => [ - 'description' => 'Details about the tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - ], - ], - 'Sessions' => [ - 'description' => 'The session information about cloud computers connected by end users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The session information about the cloud computer connected by an end user.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the end user that connects to the cloud computer.'."\n", - 'type' => 'string', - 'example' => '29615820929547****', - ], - 'EstablishmentTime' => [ - 'description' => 'The time when the cloud computer session was established.'."\n", - 'type' => 'string', - 'example' => '2021-03-07T08:23Z', - ], - 'ExternalUserName' => [ - 'description' => 'The name of the external user.'."\n", - 'type' => 'string', - 'example' => 'Testname', - ], - ], - ], - ], - 'EndUserIds' => [ - 'description' => 'The end user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - ], - 'DowngradeQuota' => [ - 'description' => 'The number of times for which the cloud desktop can be downgraded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'DowngradedTimes' => [ - 'description' => 'The number of times for which the cloud desktop has been downgraded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GpuCategory' => [ - 'description' => 'Indicates whether the cloud computer uses GPUs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'GpuDriverVersion' => [ - 'description' => 'The GPU driver version used by the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'ZoneType' => [ - 'description' => 'The zone type. Default value: `AvailabilityZone`. This value indicates Alibaba Cloud zones.'."\n", - 'type' => 'string', - 'example' => 'AvailabilityZone', - ], - 'FotaUpdate' => [ - 'description' => 'The information about the image version of the cloud computer.'."\n", - 'type' => 'object', - 'properties' => [ - 'CurrentAppVersion' => [ - 'description' => 'The current image version of the cloud computer.'."\n", - 'type' => 'string', - 'example' => '0.0.0-D-20220102.000000', - ], - 'NewAppVersion' => [ - 'description' => 'The version number to which the image of the cloud computer can be updated.'."\n", - 'type' => 'string', - 'example' => '0.0.0-R-20220307.190736', - ], - 'ReleaseNote' => [ - 'description' => 'The description of the version to which the image of the cloud computer can be updated.'."\n", - 'type' => 'string', - 'example' => 'Upgrade package for testing 03-07'."\n", - ], - 'Size' => [ - 'description' => 'The size of the installation package for the image to which the cloud desktop can be updated. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '108815097', - ], - 'ReleaseNoteEn' => [ - 'description' => 'The English description of the version to which the image of the cloud computer can be updated.'."\n", - 'type' => 'string', - 'example' => 'Release note', - ], - 'ReleaseNoteJp' => [ - 'description' => 'The Japanese description of the image version to which the cloud desktop can be updated.'."\n", - 'type' => 'string', - 'example' => 'リリースノート', - ], - ], - ], - 'Progress' => [ - 'description' => 'The progress of creating the cloud computer.'."\n", - 'type' => 'string', - 'example' => '100%', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to query the list of KMS keys.'."\n", - 'type' => 'string', - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], - 'OfficeSiteVpcType' => [ - 'description' => 'The VPC type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard'."\n" - .'* customized'."\n" - .'* basic'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - 'customized' => '', - 'basic' => '', - ], - 'example' => 'basic', - ], - 'Platform' => [ - 'description' => 'The information about the OS platform.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Ubuntu'."\n" - .'* Windows Server 2022'."\n" - .'* UOS'."\n" - .'* CentOS'."\n" - .'* Windows Server 2019'."\n" - .'* Windows Server 2016'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Ubuntu' => 'Ubuntu', - 'Windows Server 2022' => 'Windows Server 2022', - 'UOS' => 'UOS', - 'CentOS' => 'CentOS', - 'Windows Server 2019' => 'Windows Server 2019', - 'Windows Server 2016' => 'Windows Server 2016', - ], - 'example' => 'Ubuntu', - ], - 'SessionType' => [ - 'description' => 'The type of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SINGLE_SESSION'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* MULTIPLE_SESSION'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '', - 'MULTIPLE_SESSION' => '', - ], - 'example' => 'SINGLE_SESSION', - ], - 'ManagementFlags' => [ - 'description' => 'The flags that are used to manage the cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The management status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Migrating: The cloud computer is being migrated to another office network.'."\n" - .'* Hibernated: The cloud computer is hibernated.'."\n" - .'* UnderMaintenance: The cloud computer is entering maintenance mode.'."\n" - .'* MigratingProtocol: The protocol of the cloud computer is being migrated.'."\n" - .'* EnterMaintenance: The cloud computer is in maintenance mode.'."\n" - .'* WakingUp: The cloud computer is being waking up.'."\n" - .'* updating: The cloud computer is being updated.'."\n" - .'* NoFlag: No status.'."\n" - .'* Assigning: The cloud computer is being assigned to users.'."\n" - .'* Hibernating: The cloud computer is hibernating.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Migrating' => '', - 'Hibernated' => '', - 'UnderMaintenance' => '', - 'MigratingProtocol' => '', - 'EnterMaintenance' => '', - 'WakingUp' => '', - 'Updating' => '', - 'NoFlag' => '', - 'Assigning' => '', - 'Hibernating' => '', - ], - 'example' => '["NoFlag"]', - ], - ], - 'SnapshotPolicyId' => [ - 'title' => '快照策略ID', - 'description' => 'The snapshot policy ID.'."\n", - 'type' => 'string', - 'example' => 'sp-gi007jgyc3kcey2bb', - ], - 'SnapshotPolicyName' => [ - 'title' => '快照策略名称', - 'description' => 'The name of the snapshot policy.'."\n", - 'type' => 'string', - 'example' => 'testSnapshotName', - ], - 'BindAmount' => [ - 'description' => 'The number of concurrent sessions of each cloud computer in a multi-session cloud computer pool.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PolicyGroupIdList' => [ - 'description' => 'The IDs of the cloud computer policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'pg-dasffjkdf*****', - ], - ], - 'PolicyGroupNameList' => [ - 'description' => 'The names of the cloud computer policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'test01', - ], - ], - 'HibernationOptionsConfigured' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SupportHibernation' => [ - 'description' => 'Indicates whether the cloud desktop supports hibernation.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HibernationBeta' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ResourceGroups' => [ - 'description' => 'The information about the enterprise resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the enterprise resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the enterprise resource group.'."\n", - 'type' => 'string', - 'example' => 'Resource group 01'."\n", - ], - 'Id' => [ - 'description' => 'The ID of the enterprise resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-4hsvzbbmqdzu3s****', - ], - ], - ], - ], - 'StandardStartTime' => [ - 'type' => 'string', - 'description' => 'The standard start time.', - 'example' => '2025-02-24T06:38:02Z', - ], - 'OsUpdate' => [ - 'type' => 'object', - 'properties' => [ - 'CheckId' => [ - 'type' => 'string', - ], - 'PackageCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Packages' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Kb' => [ - 'type' => 'string', - ], - 'Title' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'IsLdap' => [ - 'type' => 'boolean', - ], - 'DomainType' => [ - 'type' => 'string', - ], - 'SerialNumber' => [ - 'type' => 'string', - ], - 'AccountType' => [ - 'type' => 'string', - ], - 'EntraDomainName' => [ - 'type' => 'string', - ], - 'EnvType' => [ - 'type' => 'string', - ], - 'EnvId' => [ - 'type' => 'string', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'items' => ['description' => 'A desktop group ID.', 'type' => 'string', 'example' => '[\'dg-1np2yupx0uim****\']', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TotalCount\\": 1,\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"DemoComputer01\\",\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"SystemDiskSize\\": 0,\\n \\"PolicyGroupId\\": \\"system-all-enabled-policy\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"GpuCount\\": 1,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"Memory\\": 4096,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"DataDiskCategory\\": \\"null\\",\\n \\"SystemDiskCategory\\": \\"null\\",\\n \\"NetworkInterfaceId\\": \\"123456\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"DataDiskSize\\": \\"null\\",\\n \\"DesktopGroupId\\": \\"null\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"OfficeSiteName\\": \\"default\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"Cpu\\": 2,\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"BundleId\\": \\"b-2g65ljy4291vl****\\",\\n \\"BundleName\\": \\"TemplateName\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"HostName\\": \\"testName\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80,\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"DiskCategory\\": \\"cloud_auto\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"29615820929547****\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\",\\n \\"ExternalUserName\\": \\"Testname\\"\\n }\\n ],\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"DowngradeQuota\\": 3,\\n \\"DowngradedTimes\\": 0,\\n \\"GpuCategory\\": 0,\\n \\"GpuDriverVersion\\": \\"null\\",\\n \\"ZoneType\\": \\"AvailabilityZone\\",\\n \\"FotaUpdate\\": {\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.000000\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.190736\\",\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": 108815097,\\n \\"ReleaseNoteEn\\": \\"What\'s new\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\"\\n },\\n \\"Progress\\": \\"100%\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"OfficeSiteVpcType\\": \\"basic\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ManagementFlags\\": [\\n \\"[\\\\\\"NoFlag\\\\\\"]\\"\\n ],\\n \\"SnapshotPolicyId\\": \\"sp-gi007jgyc3kce****\\",\\n \\"SnapshotPolicyName\\": \\"testSnapshotName\\",\\n \\"BindAmount\\": 2,\\n \\"PolicyGroupIdList\\": [\\n \\"pg-dasffjkdf*****\\"\\n ],\\n \\"PolicyGroupNameList\\": [\\n \\"测试策略01\\"\\n ],\\n \\"HibernationOptionsConfigured\\": true,\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"DesktopDurationList\\": [\\n {\\n \\"PackageId\\": \\"\\",\\n \\"PackageCreationTime\\": \\"\\",\\n \\"PackageExpiredTime\\": \\"\\",\\n \\"UsedDuration\\": 0,\\n \\"TotalDuration\\": 0,\\n \\"PackageStatus\\": \\"\\",\\n \\"PackageType\\": \\"\\",\\n \\"PeriodStartTime\\": \\"\\",\\n \\"PeriodEndTime\\": \\"\\",\\n \\"PostPaidLimitFee\\": 0,\\n \\"PackageUsedUpStrategy\\": \\"\\",\\n \\"OrderInstanceId\\": \\"\\"\\n }\\n ],\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"资源组01\\",\\n \\"Id\\": \\"rg-4hsvzbbmqdzu3s****\\"\\n }\\n ],\\n \\"StandardStartTime\\": \\"\\",\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"\\",\\n \\"PackageCount\\": 0,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n },\\n \\"IsLdap\\": true,\\n \\"DomainType\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n 1\\n \\n 2020-11-06T08:28Z\\n PostPaid\\n testDesktopName\\n test\\n 0\\n system-all-enabled-policy\\n Running\\n ecd.basic.large\\n 1\\n HDX\\n 4096\\n NVIDIA T4\\n m-4zfb6zj728hhr****\\n cn-hangzhou+dir-363353****\\n NoFlag\\n null\\n null\\n 123456\\n cn-hangzhou+dir-363353****\\n null\\n null\\n ecd-gx2x1dhsmucyy****\\n test\\n SIMPLE\\n basic\\n 2020-11-06T08:31Z\\n 2\\n 192.168.74.165\\n 2021-12-31T15:59Z\\n Windows\\n Disconnected\\n b-2g65ljy4291vl****\\n Name\\n SIMPLE\\n testName\\n \\n SYSTEM\\n d-jedbpr4sl9l37****\\n 80\\n PL0\\n \\n \\n TestKey\\n TestValue\\n \\n \\n 29615820929547****\\n 2021-03-07T08:23Z\\n Testname\\n \\n Alice\\n 3\\n 0\\n 0\\n null\\n AvailabilityZone\\n \\n t-bp198jigq7l0h5ac****\\n 0.0.0-D-20220102.000000\\n 0.0.0-R-20220307.190736\\n 测试升级包03-07\\n 108815097\\n \\n 100%\\n Ubuntu\\n \\n","errorExample":""}]', - 'title' => 'DescribeDesktops', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDesktopTypes' => [ - 'summary' => 'Queries the instance types of cloud computers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'CreateDesktopGroup', + 'summary' => 'Creating a shared EDS.', + 'description' => '- To learn more about shared desktops, including their features, use cases, limitations, and scaling policies, see [Shared desktop (formerly desktop pool) overview](~~290959~~).'."\n" + ."\n" + .'- Before calling this API, ensure you have created the necessary resources, such as an office network, a desktop template, and a policy.', + 'changeSet' => [ + ['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-08-09T10:00:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-05T03:57:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-28T10:13:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-23T08:23:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-24T14:47:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T02:32:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-12T07:02:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktopGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopGroupId\\": \\"dg-2i8qxpv6t1a03****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\",\\n \\"OrderIds\\": [\\n \\"123456789\\"\\n ],\\n \\"DesktopGroupIds\\": [\\n \\"[\'dg-1np2yupx0uim****\']\\"\\n ]\\n}","type":"json"}]', + ], + 'CreateDesktops' => [ + 'summary' => 'Creates one or more cloud desktops. If user information is specified during creation, the cloud desktops are directly assigned to the users.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52797', + 'abilityTreeNodes' => ['FEATUREgwsOBA7JE'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopTypeId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The specification ID.'."\n" - ."\n" - .'> If both `InstanceTypeFamily` and `DesktopTypeId` are empty, all cloud computer specifications will be queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* eds.enterprise_office.4c8g'."\n" - .'* eds.hf.4c8g'."\n" - .'* ecd.basic.large'."\n" - .'* ecd.advanced.large'."\n" - .'* eds.enterprise_office.8c16g'."\n" - .'* ecd.basic.small'."\n" - .'* ecd.graphics.2xlarge'."\n" - .'* eds.hf.8c16g'."\n" - .'* eds.hf.12c24g'."\n" - .'* eds.general.8c16g'."\n" - .'* eds.general.16c32g'."\n" - .'* ecd.advanced.xlarge'."\n" - .'* eds.graphics.16c1t4'."\n" - .'* ecd.graphics.xlarge'."\n" - .'* ecd.performance.2xlarge'."\n" - .'* eds.general.8c32g'."\n" - .'* eds.general.2c2g'."\n" - .'* eds.general.2c4g'."\n" - .'* eds.graphics.24c1t4'."\n" - .'* eds.general.4c8g'."\n" - .'* eds.enterprise_office.2c4g'."\n" - .'* eds.general.4c16g'."\n" - .'* eds.general.2c8g'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'eds.enterprise_office.4c8g' => 'eds.enterprise_office.4c8g', - 'eds.hf.4c8g' => 'eds.hf.4c8g', - 'ecd.basic.large' => 'ecd.basic.large', - 'ecd.advanced.large' => 'ecd.advanced.large', - 'eds.enterprise_office.8c16g' => 'eds.enterprise_office.8c16g', - 'ecd.basic.small' => 'ecd.basic.small', - 'ecd.graphics.2xlarge' => 'ecd.graphics.2xlarge', - 'eds.hf.8c16g' => 'eds.hf.8c16g', - 'eds.hf.12c24g' => 'eds.hf.12c24g', - 'eds.general.8c16g' => 'eds.general.8c16g', - 'eds.general.16c32g' => 'eds.general.16c32g', - 'ecd.advanced.xlarge' => 'ecd.advanced.xlarge', - 'eds.graphics.16c1t4' => 'eds.graphics.16c1t4', - 'ecd.graphics.xlarge' => 'ecd.graphics.xlarge', - 'ecd.performance.2xlarge' => 'ecd.performance.2xlarge', - 'eds.general.8c32g' => 'eds.general.8c32g', - 'eds.general.2c2g' => 'eds.general.2c2g', - 'eds.general.2c4g' => 'eds.general.2c4g', - 'eds.graphics.24c1t4' => 'eds.graphics.24c1t4', - 'eds.general.4c8g' => 'eds.general.4c8g', - 'eds.enterprise_office.2c4g' => 'eds.enterprise_office.2c4g', - 'eds.general.4c16g' => 'eds.general.4c16g', - 'eds.general.2c8g' => 'eds.general.2c8g', - ], - 'example' => 'ecd.graphics.xlarge', - ], + 'schema' => ['description' => 'The cloud desktop pool ID.', 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5****', 'title' => ''], ], [ - 'name' => 'InstanceTypeFamily', + 'name' => 'BundleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the specification family.'."\n" - ."\n" - .'> If both `InstanceTypeFamily` and `DesktopTypeId` are empty, all specification families will be queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ecd.advanced'."\n" - .'* eds.graphics'."\n" - .'* ecd.basic'."\n" - .'* eds.enterprise_office'."\n" - .'* eds.hf'."\n" - .'* ecd.graphics'."\n" - .'* eds.general'."\n" - .'* ecd.performance'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ecd.advanced' => 'ecd.advanced', - 'eds.graphics' => 'eds.graphics', - 'ecd.basic' => 'ecd.basic', - 'eds.enterprise_office' => 'eds.enterprise_office', - 'eds.hf' => 'eds.hf', - 'ecd.graphics' => 'ecd.graphics', - 'eds.general' => 'eds.general', - 'ecd.performance' => 'ecd.performance', - ], - 'example' => 'ecd.graphics', - ], + 'schema' => ['description' => 'The cloud desktop template ID. If no template ID is specified, you can create a cloud desktop by specifying the required fields.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'b-je9hani001wfn****', 'title' => ''], ], [ - 'name' => 'CpuCount', + 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The cloud desktop name. The naming rules are as follows:'."\n" + ."\n" + .'- The name can be up to 64 characters in length.'."\n" + .'- The name must start with a letter or a Chinese character and cannot start with `http://` or `https://`.'."\n" + .'- The name can contain Chinese characters, letters, digits, colons (:), underscores (\\_), periods (.), or hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01', 'title' => ''], ], [ - 'name' => 'MemorySize', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => '> This parameter is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'username', 'title' => ''], ], [ - 'name' => 'GpuCount', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of GPUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '> This parameter is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6w8u60n8xbkg5el****', 'title' => ''], ], [ - 'name' => 'DesktopIdForModify', + 'name' => 'Amount', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer when you change instance types of cloud computers. If you specify this parameter, the information about whether the instance type is compatible with the cloud computer is included in the response.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => 'The number of cloud desktops to create. Valid values: 1 to 300. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'OrderType', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The order type.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DOWNGRADE' => '', - 'UPGRADE' => '', - ], - 'example' => 'DOWNGRADE', - ], + 'schema' => ['description' => '> This parameter is not available for use.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-300943****', 'title' => ''], ], [ - 'name' => 'AppliedScope', + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-387822****', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'system-all-enabled-policy', 'title' => ''], + ], + [ + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'Applicable Scope of specifications. Default value: `Public`', + 'description' => 'The billing method of the cloud desktop.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go [default]', 'PrePaid' => 'subscription.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Public' => 'Public', - 'SavingPlan' => 'SavingPlan', - ], - 'example' => 'Public', + 'docRequired' => false, + 'example' => 'PrePaid', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupIdForModify', + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration of the resource. The unit is specified by `PeriodUnit`. This parameter takes effect and is required only when `ChargeType` is set to `PrePaid`.'."\n" + ."\n" + .'- If `PeriodUnit` is set to `Month`, valid values of this parameter:'."\n" + ."\n" + .' - 1'."\n" + .' - 2'."\n" + .' - 3'."\n" + .' - 6'."\n" + ."\n" + .'- If `PeriodUnit` is set to `Year`, valid values of this parameter:'."\n" + ."\n" + .' - 1'."\n" + .' - 2'."\n" + .' - 3'."\n" + .' - 4'."\n" + .' - 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share you want to modify. If this parameter is provided, the response will include compatibility information for the specified specification.'."\n", + 'description' => 'The unit of the subscription duration.', + 'enumValueTitles' => ['Month' => 'month [default]', 'Year' => 'year.'], 'type' => 'string', 'required' => false, - 'example' => 'dg-abcdefg****', + 'docRequired' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'GpuDriverType', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The GPU driver type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* T4'."\n" - .'* A10'."\n" - .'* G28'."\n" - .'* G39'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Automatic payment is enabled. Make sure that your account balance is sufficient. Otherwise, abnormal orders are generated. [default]', 'false' => 'An order is generated but not paid. You can log on to the console and go to the Orders page in User Center to complete the payment based on the returned order ID.'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'T4' => 'T4', - 'A10' => 'A10', - 'G28' => 'G28', - 'G39' => 'G39', - ], - 'example' => 'A10', + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'OrderBy', + 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting field. If this parameter is not provided, results are sorted by creation time in descending order.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Memory: sorts by memory size.'."\n" - .'* Cpu: sorts by the number of vCPUs.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable auto-renewal. This parameter takes effect only when `ChargeType` is set to `PrePaid`.', + 'enumValueTitles' => ['true' => 'Auto-renewal is enabled. The renewal duration is the same as the subscription duration.', 'false' => 'Auto-renewal is disabled. [default]'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'Memory' => 'Memory', - 'Cpu' => 'Cpu', - ], - 'example' => 'Memory', + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'SortType', + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '23141', 'title' => ''], + ], + [ + 'name' => 'UserAssignMode', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting order.'."\n" + 'description' => 'The cloud desktop assignment mode.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" - .'* ASC (default): the ascending order.'."\n" - .'* DESC: the descending order.'."\n", + .'> If `EndUserId` is not specified, the created cloud desktops are not assigned to any user.', + 'enumValueTitles' => ['ALL' => 'If EndUserId is specified, the created cloud desktops are assigned to each specified user. [default]', 'PER_USER' => 'If EndUserId is specified, the created cloud desktops are evenly distributed among the specified users. The value of Amount must be divisible by the number of EndUserId values (N).'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => 'ASC', - 'DESC' => 'DESC', - ], - 'example' => 'ASC', + 'docRequired' => false, + 'example' => 'ALL', + 'title' => '', ], ], [ - 'name' => 'Scope', + 'name' => 'Hostname', + 'in' => 'query', + 'schema' => ['description' => 'The custom hostname of the cloud desktop. Settings for this parameter are supported only for cloud desktops that run the Windows operating system in an AD office network.'."\n" + ."\n" + .'The naming rules for the hostname are as follows:'."\n" + ."\n" + .'- The hostname must be 2 to 15 characters in length.'."\n" + .'- The hostname can contain uppercase letters, lowercase letters, digits, or hyphens (-). It cannot start or end with a hyphen, contain consecutive hyphens, or consist of only digits.'."\n" + ."\n" + .'When you create multiple cloud desktops, you can use the `name_prefix[begin_number,bits]name_suffix` format to uniformly name the cloud desktops. For example, if you set Hostname to ecd-[1,4]-test, the hostname of the first cloud desktop is ecd-0001-test, the hostname of the second cloud desktop is ecd-0002-test, and so on.'."\n" + ."\n" + .'- `name_prefix`: the prefix of the hostname.'."\n" + .'- `[begin_number,bits]`: the sequential number in the hostname. `begin_number` is the starting number. Valid values: 0 to 999999. Default value: 0. `bits` is the number of digits. Valid values: 1 to 6. Default value: 6.'."\n" + .'- `name_suffix`: the suffix of the hostname.', 'type' => 'string', 'required' => false, 'example' => 'testhost', 'title' => ''], + ], + [ + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The sales mode of the specification.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The list of authorized user IDs to add to the cloud desktops. You can specify 1 to 100 user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The authorized user ID to add to the cloud desktop.'."\n" ."\n" - .'* MonthPackage: the monthly subscription mode.'."\n" - .'* FastBuy: the quick purchase mode.'."\n", - 'type' => 'string', + .'- Only one user can use the cloud desktop at a time.'."\n" + .'- If `EndUserId` is not specified, the created cloud desktops are not assigned to any user.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'MonthPackage' => 'MonthPackage', - 'FastBuy' => 'FastBuy', - ], - 'example' => 'FastBuy', + 'example' => '123456789', + 'maxItems' => 300, + 'title' => '', ], ], [ - 'name' => 'DesktopTypeIdList', + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The specification IDs.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'The specification ID.'."\n", - 'type' => 'string', + 'description' => 'The tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. You can specify 1 to 20 tag keys.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. You can specify 1 to 20 tag values.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], 'required' => false, - 'example' => 'eds.enterprise.4c8g', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SupportMinSessionCount', + 'name' => 'DesktopNameSuffix', 'in' => 'query', 'schema' => [ - 'description' => 'The number of sessions supported by the specification.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to automatically append a suffix to the cloud desktop name when you create multiple cloud desktops in a batch.', + 'enumValueTitles' => ['true' => 'A suffix is automatically appended. [default]', 'false' => 'No suffix is appended.'], + 'type' => 'boolean', 'required' => false, - 'example' => '2', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'ZoneId', + 'name' => 'VolumeEncryptionEnabled', 'in' => 'query', 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable cloud disk encryption.', + 'enumValueTitles' => ['true' => 'Cloud disk encryption is enabled.', 'false' => 'Cloud disk encryption is disabled. [default]'], + 'type' => 'boolean', 'required' => false, - 'example' => 'null', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'GpuMemory', + 'name' => 'VolumeEncryptionKey', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Key Management Service (KMS) key used for cloud disk encryption. You can call [ListKeys](~~28951~~) to obtain the key ID.', 'type' => 'string', 'required' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + ], + [ + 'name' => 'DesktopMemberIp', + 'in' => 'query', + 'schema' => ['description' => 'The private IP address of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', 'title' => ''], + ], + [ + 'name' => 'UserCommands', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The custom command script data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom command script data.', + 'type' => 'object', + 'properties' => [ + 'ContentEncoding' => [ + 'title' => '', + 'description' => 'The encoding method of the command content (CommandContent).', + 'enumValueTitles' => ['Base64' => 'Base64 encoding.', 'PlainText' => 'no encoding, transmitted in plaintext.'], + 'type' => 'string', + 'default' => 'Base64', + 'required' => false, + 'example' => 'Base64', + ], + 'Content' => ['description' => 'The command content.', 'type' => 'string', 'maxLength' => 15000, 'required' => false, 'example' => 'bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****', 'title' => ''], + 'ContentType' => [ + 'description' => 'The language type of the command.', + 'enumValueTitles' => ['RunPowerShellScript' => 'PowerShell command for Windows instances.', 'RunShellScript' => 'Shell command for Linux instances.', 'RunBatScript' => 'Bat command for Windows instances.'], + 'type' => 'string', + 'required' => false, + 'example' => 'RunPowerShellScript', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'description' => 'The GPU memory size. Unit: MB.', - 'example' => '2048', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ScopeSet', + 'name' => 'BundleModels', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ + 'description' => 'The list of cloud desktop templates.', 'type' => 'array', 'items' => [ - 'type' => 'string', + 'description' => 'The cloud desktop template.', + 'type' => 'object', + 'properties' => [ + 'BundleId' => ['description' => 'The cloud desktop template ID.', 'type' => 'string', 'required' => false, 'example' => 'b-je9hani001wfn****', 'title' => ''], + 'Amount' => ['description' => 'The number of cloud desktops to create. Valid values: 1 to 300. Default value: 0.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '300', 'required' => false, 'example' => '1', 'title' => ''], + 'EndUserIds' => [ + 'description' => 'The list of users to whom the cloud desktops are assigned.', + 'type' => 'array', + 'items' => ['description' => 'The username.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + 'DesktopName' => ['description' => 'The cloud desktop name. The naming rules are as follows:'."\n" + ."\n" + .'- The name can be up to 64 characters in length.'."\n" + .'- The name must start with a letter or a Chinese character and cannot start with `http://` or `https://`.'."\n" + .'- The name can contain Chinese characters, letters, digits, colons (:), underscores (\\_), periods (.), or hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer02', 'title' => ''], + 'Hostname' => ['description' => 'The custom hostname of the cloud desktop. Settings for this parameter are supported only for cloud desktops that run the Windows operating system in an AD office network.'."\n" + ."\n" + .'The naming rules for the hostname are as follows:'."\n" + ."\n" + .'- The hostname must be 2 to 15 characters in length.'."\n" + .'- The hostname can contain uppercase letters, lowercase letters, digits, or hyphens (-). It cannot start or end with a hyphen, contain consecutive hyphens, or consist of only digits.'."\n" + ."\n" + .'When you create multiple cloud desktops, you can use the `name_prefix[begin_number,bits]name_suffix` format to uniformly name the cloud desktops. For example, if you set Hostname to ecd-[1,4]-test, the hostname of the first cloud desktop is ecd-0001-test, the hostname of the second cloud desktop is ecd-0002-test, and so on.'."\n" + ."\n" + .'- `name_prefix`: the prefix of the hostname.'."\n" + .'- `[begin_number,bits]`: the sequential number in the hostname. `begin_number` is the starting number. Valid values: 0 to 999999. Default value: 0. `bits` is the number of digits. Valid values: 1 to 6. Default value: 6.'."\n" + .'- `name_suffix`: the suffix of the hostname.', 'type' => 'string', 'required' => false, 'example' => 'testhost', 'title' => ''], + 'VolumeEncryptionEnabled' => ['description' => 'Specifies whether to enable cloud disk encryption.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the Key Management Service (KMS) key used for cloud disk encryption. You can call [ListKeys](~~28951~~) to obtain the key ID.', 'type' => 'string', 'required' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'maxItems' => 100, + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DesktopTimers', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The scheduled task details of the cloud desktop. This parameter is being deprecated. Use the TimerGroupId parameter instead.', + 'type' => 'array', + 'items' => [ + 'description' => 'The scheduled task details of the cloud desktop.', + 'type' => 'object', + 'properties' => [ + 'TimerType' => ['description' => 'The type of the scheduled task.', 'type' => 'string', 'required' => false, 'example' => 'NoOperationReboot', 'title' => ''], + 'CronExpression' => ['description' => 'The cron expression of the scheduled task.'."\n" + ."\n" + .'>Specify the time in UTC. For example, to schedule a task at 00:00 (UTC+8) every day, set the value to 0 0 16 ? * 1,2,3,4,5,6,7.', 'type' => 'string', 'required' => false, 'example' => '0 40 7 ? * 1,2,3,4,5,6,7', 'title' => ''], + 'Interval' => ['description' => 'The time interval, in minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Enforce' => [ + 'description' => 'Specifies whether to forcefully execute the task.', + 'enumValueTitles' => ['true' => 'The scheduled task is forcefully executed regardless of the cloud desktop status or connection status.', 'false' => 'The task is not forcefully executed.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + 'ResetType' => [ + 'description' => 'The reset type of the cloud desktop.', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => 'Resets the system cloud disk.', 'RESET_TYPE_BOTH' => 'Resets the system cloud disk and user cloud disk.'], + 'type' => 'string', + 'required' => false, + 'example' => 'RESET_TYPE_SYSTEM', + 'title' => '', + ], + 'OperationType' => [ + 'description' => 'The operation type of the scheduled task. Currently, only the disconnection scheduled task is supported.', + 'enumValueTitles' => ['Hibernate' => 'hibernate.', 'Shutdown' => 'shut down.'], + 'type' => 'string', + 'required' => false, + 'example' => 'Shutdown', + 'title' => '', + ], + 'AllowClientSetting' => ['description' => 'Specifies whether to allow end users to configure scheduled tasks.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SubnetId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The subnet ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1m*****', 'title' => ''], + ], + [ + 'name' => 'MonthDesktopSetting', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The purchase parameters for the monthly hourly package.', + 'type' => 'object', + 'properties' => [ + 'UseDuration' => ['description' => 'The package option when purchasing a monthly hourly package. Valid values: 120, 250, and 360.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], + 'BuyerId' => ['description' => '> This field is not available for use.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'null', 'title' => ''], + 'DesktopId' => ['description' => '> This field is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SnapshotPolicyId', + 'in' => 'query', + 'schema' => ['description' => 'The WUYING automatic snapshot policy ID.', 'type' => 'string', 'required' => false, 'example' => 'sp-28mp6my0l6zow****', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The WUYING resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-3mtuc28rx95lx****', 'title' => ''], + ], + [ + 'name' => 'DesktopAttachment', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The parameters for creating a cloud desktop without a template. This parameter is invalid when the BundleId parameter is specified.', + 'type' => 'object', + 'properties' => [ + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-39ddhdb0ggzjx*****', 'title' => ''], + 'SystemDiskCategory' => ['description' => 'The system cloud disk type. The system cloud disk type must be the same as the data cloud disk type. Valid values:'."\n" + .'- cloud_auto: standard SSD ultra cloud disk'."\n" + .'- cloud_essd: ESSD cloud disk', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], + 'SystemDiskSize' => ['description' => 'The system cloud disk capacity. Valid values: 60 to 500 GiB, in increments of 10 GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], + 'SystemDiskPerLevel' => ['description' => 'The performance level (PL) of the ESSD cloud disk. This parameter is required when an ESSD cloud disk is selected. Valid values:'."\n" + .'- PL0'."\n" + .'- PL1', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], + 'DataDiskSize' => ['description' => 'The user cloud disk capacity. Valid values: 40 to 2040 GiB, in increments of 10 GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], + 'DataDiskCategory' => ['description' => 'The data cloud disk type. The system cloud disk type must be the same as the data cloud disk type. Valid values:'."\n" + .'- cloud_auto: standard SSD ultra cloud disk'."\n" + .'- cloud_essd: ESSD cloud disk', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto', 'title' => ''], + 'DataDiskPerLevel' => ['description' => 'The performance level (PL) of the ESSD cloud disk. This parameter is required when an ESSD cloud disk is selected. Valid values:'."\n" + .'- PL0'."\n" + .'- PL1', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], + 'DefaultLanguage' => ['description' => 'The language. Valid values:'."\n" + .'- zh-CN'."\n" + .'- zh-HK'."\n" + .'- en-US'."\n" + .'- ja-JP', 'type' => 'string', 'required' => false, 'example' => 'zh-CN', 'title' => ''], + 'DesktopType' => ['description' => 'The cloud desktop specification. You can call [DescribeDesktopTypes](~~188882~~) to query the supported specification IDs.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TimerGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled task group ID.', 'type' => 'string', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****', 'title' => ''], + ], + [ + 'name' => 'SavingPlanId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => '> This field is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'spn-26c1b7bcrjcI****', 'title' => ''], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['description' => 'The user ID for resource ownership in reseller pattern. This parameter is not required in non-reseller pattern.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1828644634819902', 'title' => ''], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'schema' => ['description' => 'The extended information in JSON string format. This parameter is available only for internal customers.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'AppRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The application control policy ID.', 'type' => 'string', 'required' => false, 'example' => 'bwr-245d4e0e6b7d42f5afa97eb3fbc7e488', 'title' => ''], + ], + [ + 'name' => 'QosRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The public network rate limiting rule ID.', 'type' => 'string', 'required' => false, 'example' => 'qos-52fqmg6kvyro7zu4l', 'title' => ''], + ], + [ + 'name' => 'ChannelCookie', + 'in' => 'query', + 'schema' => ['description' => '> This field is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'PBKB1QbqEl2tslEuU6gRrLxvCFBU2M%2FVD0Eru6Oo%2FI9LTU3XQhvq3PGMWarE%2BPJdkNvCqT3blqlRSthNy4A%2BJQ%3D%3D', 'title' => ''], + ], + [ + 'name' => 'PurchaseOptions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The additional parameters for a specific purchase type.', + 'type' => 'object', + 'properties' => [ + 'MonthlyCredits' => ['description' => 'The monthly credit package for purchasing Agent resources. Valid values: 200, 1600, and 4000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'OuPath', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The OU path. If specified, the cloud desktop is added to the corresponding organizational unit (OU) in Active Directory (AD).', 'type' => 'string', 'required' => false, 'example' => 'test.com/wuyingtest/computers'], + ], + [ + 'name' => 'SubPayType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'DesktopTypes' => [ - 'description' => 'The specifications.'."\n", + 'OrderId' => ['description' => 'The order ID.'."\n" + .'> This parameter is returned only when the request parameter ChargeType is set to PrePaid.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'DesktopId' => [ + 'description' => 'The list of cloud desktop IDs. If multiple cloud desktops are created in a single call, multiple cloud desktop IDs are returned.', 'type' => 'array', - 'items' => [ - 'description' => 'The specification.'."\n", - 'type' => 'object', - 'properties' => [ - 'SystemDiskSize' => [ - 'description' => 'The size of the system disk. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '150', - ], - 'DesktopTypeId' => [ - 'description' => 'The ID of the cloud desktop type.'."\n", - 'type' => 'string', - 'example' => 'ecd.graphics.xlarge', - ], - 'DataDiskSize' => [ - 'description' => 'The size of the data disk. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '150', - ], - 'CpuCount' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'string', - 'example' => '2', - ], - 'GpuCount' => [ - 'description' => 'The number of GPUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'GpuSpec' => [ - 'description' => 'The GPU memory.'."\n", - 'type' => 'string', - 'example' => '16 GiB', - ], - 'InstanceTypeFamily' => [ - 'description' => 'The family of the cloud desktop type.'."\n", - 'type' => 'string', - 'example' => 'ecd.graphics', - ], - 'MemorySize' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'string', - 'example' => '23552', - ], - 'DesktopTypeStatus' => [ - 'description' => 'The status of the cloud desktop type. If SUFFICIENT is returned, the number of cloud desktops of the type is sufficient.'."\n", - 'type' => 'string', - 'example' => 'SUFFICIENT', - ], - 'Scopes' => [ - 'description' => 'The sales modes of the specifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The sales mode of the specification.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* MonthPackage: the monthly subscription mode.'."\n" - .'* FastBuy: the quick purchase mode.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'MonthPackage' => '', - 'FastBuy' => '', - ], - 'example' => 'FastBuy', - ], - ], - 'StockState' => [ - 'description' => 'The inventory status of the specification.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Insufficient'."\n" - .'* Sufficient'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Insufficient' => '', - 'Sufficient' => '', - ], - 'example' => 'Sufficient', - ], - 'GpuMemory' => [ - 'description' => 'The GPU memory size. For GPU-accelerated cloud computers, this return value is significant. Unit: MB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', - ], - 'MaxSessionCount' => [ - 'description' => 'The number of sessions supported by the specification.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Description' => [ - 'type' => 'string', - ], - 'EnvType' => [ - 'type' => 'string', - ], - 'EnvId' => [ - 'type' => 'string', - ], - ], - ], + 'items' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'example' => '["ecd-gx2x1dhsmucyy****"]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopTypes\\": [\\n {\\n \\"SystemDiskSize\\": \\"150\\",\\n \\"DesktopTypeId\\": \\"ecd.graphics.xlarge\\",\\n \\"DataDiskSize\\": \\"150\\",\\n \\"CpuCount\\": \\"2\\",\\n \\"GpuCount\\": 1,\\n \\"GpuSpec\\": \\"16 GiB\\",\\n \\"InstanceTypeFamily\\": \\"ecd.graphics\\",\\n \\"MemorySize\\": \\"23552\\",\\n \\"DesktopTypeStatus\\": \\"SUFFICIENT\\",\\n \\"Scopes\\": [\\n \\"FastBuy\\"\\n ],\\n \\"StockState\\": \\"Sufficient\\",\\n \\"GpuMemory\\": 2048,\\n \\"MaxSessionCount\\": 4,\\n \\"Description\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nFE1810C7-09DA-4224-A8DC-5110954FD47F\\n\\n 95232\\n 24\\n eds.graphics.24c1t4\\n 150\\n eds.graphics\\n 16 GiB\\n 1\\n 150\\n\\n\\n 63488\\n 16\\n eds.graphics.16c1t4\\n 150\\n eds.graphics\\n 16 GiB\\n \\n 150\\n 150\\n \\n 1\\n 150\\n\\n\\n 24576\\n 12\\n eds.hf.12c24g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 16384\\n 8\\n eds.hf.8c16g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 8192\\n 4\\n eds.hf.4c8g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 32768\\n 16\\n eds.general.16c32g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 32768\\n 8\\n eds.general.8c32g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 16384\\n 8\\n eds.general.8c16g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 16384\\n 4\\n eds.general.4c16g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 8192\\n 4\\n eds.general.4c8g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 8192\\n 2\\n eds.general.2c8g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 4096\\n 2\\n eds.general.2c4g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 2048\\n 2\\n eds.general.2c2g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 47104\\n 10\\n ecd.graphics.2xlarge\\n 150\\n ecd.graphics\\n 8 GiB\\n \\n 150\\n 150\\n \\n 0.5\\n 150\\n\\n\\n 23552\\n 4\\n ecd.graphics.xlarge\\n 150\\n ecd.graphics\\n 4 GiB\\n \\n 150\\n 150\\n \\n 0.25\\n 150\\n\\n\\n 32768\\n 8\\n ecd.performance.2xlarge\\n 150\\n ecd.performance\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 150\\n\\n\\n 16384\\n 4\\n ecd.advanced.xlarge\\n 150\\n ecd.advanced\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 150\\n\\n\\n 8192\\n 2\\n ecd.advanced.large\\n 80\\n ecd.advanced\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 70\\n\\n\\n 4096\\n 2\\n ecd.basic.large\\n 80\\n ecd.basic\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 70\\n\\n\\n 2048\\n 1\\n ecd.basic.small\\n 80\\n ecd.basic\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n","errorExample":""}]', - 'title' => 'DescribeDesktopTypes', - 'description' => 'When no values are specified for the `InstanceTypeFamily` and `DesktopTypeId` parameters for a cloud desktop, all types of cloud desktops are queried.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidEncryptionKey.Missing', 'errorMessage' => 'Parameter VolumeEncryptionKey is missing.', 'description' => 'When the disk encryption function is enabled, the encryption key cannot be empty.'], + ['errorCode' => 'InvalidEncryptionKey.NotAuthorized', 'errorMessage' => 'Eds service cannot access the given VolumeEncryptionKey.', 'description' => 'Unable to access unauthorized encryption keys'], + ['errorCode' => 'InvalidEncryptionKey.NotFound', 'errorMessage' => 'The specified VolumeEncryptionKey is not found.', 'description' => 'The specified encryption key could not be found'], + ['errorCode' => 'InvalidImageStatus.NotValid', 'errorMessage' => 'The specified image status is not valid.', 'description' => 'The status of the specified image is unavailable and cannot be created.'], + ['errorCode' => 'InvalidImageVersion.NotSupported', 'errorMessage' => 'The specified image version is no longer supported.', 'description' => 'The specified image version is no longer supported. Please select another image.'], + ['errorCode' => 'InvalidMemberIp.DesktopAmount', 'errorMessage' => 'The desktop amount need to be 1.', 'description' => 'When you specify an IP to create a desktop, the number of desktops can only be 1'], + ['errorCode' => 'InvalidPolicyGroup.Status', 'errorMessage' => 'The target policy group is being created. Please try again later.', 'description' => ''], + ['errorCode' => 'Protocol.NotAllowed', 'errorMessage' => 'Procotol of the image is not allowed.', 'description' => 'The protocol type of the image is not supported. Check the image ID.'], + ['errorCode' => 'ExistedHostname', 'errorMessage' => 'The specified hostname is existed on the domain.', 'description' => 'The specified hostname already exists in the current workspace'], + ['errorCode' => 'HostnameCannotCustomizeForLinux', 'errorMessage' => 'Customizing hostname is not supported for Linux desktop.', 'description' => 'The custom hostname feature does not support Linux desktops'], + ['errorCode' => 'IncorrectDirectoryStatus', 'errorMessage' => 'Only registered directory can create desktop.', 'description' => 'Workspace status error, only desktop creation with registered workspace is supported'], + ['errorCode' => 'IncorrectDirectoryType', 'errorMessage' => 'The protocol type of directory and desktop do not match.', 'description' => 'The protocol types of the specified workspace and the target desktop do not match, please check'], + ['errorCode' => 'InvalidAmount', 'errorMessage' => 'The specified Amount is not a valid value.', 'description' => 'The specified quantity is illegal'], + ['errorCode' => 'InvalidAmount.NotTimesOfUsers', 'errorMessage' => 'The specified Amount is notmatch EndUserId size.', 'description' => 'The number of desktops specified is not equal to the number of users to be assigned, please re-specify'], + ['errorCode' => 'InvalidDesktopBundle.NotFound', 'errorMessage' => 'The specified param BundleId is not found.', 'description' => 'Specified BundleId not found'], + ['errorCode' => 'InvalidDirectoryId.NotFound', 'errorMessage' => 'The specified param DirectoryId is not found.', 'description' => 'Unable to find workspace ID, please check workspace'], + ['errorCode' => 'InvalidDirectoryType.NotSupported', 'errorMessage' => 'The specified DirectoryType is not supported.', 'description' => 'Specified'], + ['errorCode' => 'InvalidEncryptionEnabled.Invalid', 'errorMessage' => 'The parameter VolumeEncryptionEnabled is invalid.', 'description' => 'When specifying the encryption key, you need to turn on the disk encryption function.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Create one or more cloud desktops', + 'description' => 'Before creating cloud desktops, complete the following preparations:'."\n" + .'- Create an office network (formerly workspace) and users. For more information, see the following API operations or documentation:'."\n" + .' - Convenience office network: [CreateSimpleOfficeSite](~~215416~~) and [CreateUsers](~~437832~~).'."\n" + .' - AD office network: [CreateADConnectorOfficeSite](~~215417~~) and [Create AD users](~~188619~~).'."\n" + .'- Call [CreatePolicyGroup](~~188889~~) to create a policy, or confirm that an existing policy is available.'."\n" + ."\n" + .'**Call examples:**'."\n" + .'
'."\n" + .'Example of creating with a template'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RegionId": "ap-southeast-1",'."\n" + .' "DesktopName": "test-desktop-name",'."\n" + .' "Amount": "1",'."\n" + .' "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance'."\n" + .' "PolicyGroupId": "system-all-enabled-policy",'."\n" + .' "ChargeType": "PostPaid",'."\n" + .' "BundleId": "b-enterprise_office_8c16g_windows2022"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'
'."\n" + .'
'."\n" + .'Example of creating without a template'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RegionId": "ap-southeast-1",'."\n" + .' "DesktopName": "test-desktop-name",'."\n" + .' "Amount": "1",'."\n" + .' "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance'."\n" + .' "PolicyGroupId": "system-all-enabled-policy",'."\n" + .' "ChargeType": "PostPaid",'."\n" + .' "DesktopAttachment": {'."\n" + .' "ImageId": "desktopimage-windows-server-2022-64-asp",'."\n" + .' "SystemDiskSize": "40",'."\n" + .' "DataDiskSize": "0",'."\n" + .' "DefaultLanguage": "zh-CN",'."\n" + .' "DesktopType": "eds.enterprise_office.4c8g"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'
'."\n" + .'
'."\n" + .'Example of creating a monthly hourly package'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RegionId": "ap-southeast-1",'."\n" + .' "DesktopName": "test-desktop-name",'."\n" + .' "Amount": "1",'."\n" + .' "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance'."\n" + .' "PolicyGroupId": "system-all-enabled-policy",'."\n" + .' "ChargeType": "PostPaid",'."\n" + .' "DesktopAttachment": {'."\n" + .' "ImageId": "desktopimage-windows-server-2022-64-asp",'."\n" + .' "SystemDiskSize": "40",'."\n" + .' "DataDiskSize": "0",'."\n" + .' "DefaultLanguage": "zh-CN",'."\n" + .' "DesktopType": "eds.enterprise_office.4c8g"'."\n" + .' },'."\n" + .' "MonthDesktopSetting": {'."\n" + .' "UseDuration": "120"'."\n" + .' },'."\n" + .' "Period": "1",'."\n" + .' "PeriodUnit": "Month"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'
'."\n" + .'
'."\n" + .'Example of creating an Agent resource'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "RegionId": "ap-southeast-1",'."\n" + .' "BundleId": "b-openclaw-linux",'."\n" + .' "DesktopName": "test-desktop-name",'."\n" + .' "Amount": "1",'."\n" + .' "OfficeSiteId": "ap-southeast-1+dir-xxx",// Create an office network in advance'."\n" + .' "ChargeType": "PostPaid",'."\n" + .' "DesktopAttachment": {'."\n" + .' "DesktopType": "cloud.space.4c.8g"'."\n" + .' },'."\n" + .' "PurchaseOptions": {'."\n" + .' "MonthlyCredits": "120"'."\n" + .' },'."\n" + .' "Period": "1",'."\n" + .' "PeriodUnit": "Month"'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'
'."\n" + ."\n\n" + .'To have cloud desktops automatically run custom command scripts, use the `UserCommands` field to configure custom commands.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeCustomizedListHeaders' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-10-16T07:32:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-29T08:05:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-22T02:00:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-07T09:58:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-26T07:06:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-24T06:10:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-17T06:49:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-11T09:32:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-10T07:45:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-31T10:03:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-22T02:11:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-29T13:57:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-21T14:36:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-15T13:06:19.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-11-15T12:06:54.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-05-24T02:48:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-24T02:38:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-24T07:40:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-14T11:45:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-08T06:45:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-24T05:56:23.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktops'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateDiskEncryptionService' => [ + 'summary' => 'Enables disk encryption and creates the required service-linked role in your Resource Access Management (RAM) user account for the Enterprise Drive.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10361,2303 +7493,2126 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ListType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'desktop' => '', - ], - 'example' => 'desktop', - ], - ], - [ - 'name' => 'LangType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'zh-CN' => '', - 'en-GB' => '', - ], - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Headers' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DisplayType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'hide' => '', - 'display' => '', - 'required' => '', - ], - 'example' => 'display', - ], - 'HeaderKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pay_type', - ], - 'HeaderName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], + 'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '214552063030752', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'type' => 'boolean', + 'example' => 'true', + 'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'], + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Headers\\": [\\n {\\n \\"DisplayType\\": \\"display\\",\\n \\"HeaderKey\\": \\"system_data_disk\\",\\n \\"HeaderName\\": \\"系统盘/数据盘\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCustomizedListHeaders', - 'summary' => 'Queries the header information of the cloud computer list.', - ], - 'ExportDesktopListInfo' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateDiskEncryptionService', + 'changeSet' => [ + ['createdAt' => '2022-05-23T04:01:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDiskEncryptionService'], + ], ], + 'ramActions' => [], + ], + 'CreateDrive' => [ + 'summary' => 'Creates a user-level storage resource.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'AliUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer pool to which the cloud computers belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-boyczi8enfyc5***', - ], + 'schema' => ['description' => 'The ID of your Alibaba Cloud account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1202****', 'title' => ''], ], [ - 'name' => 'DesktopStatus', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Starting'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Rebuilding'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Stopping'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Expired'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Deleted'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Pending'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Running', - ], + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DomainId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the storage resource.'."\n" + ."\n" + .'> Call the DescribeDrives operation to retrieve the storage resource ID.', 'type' => 'string', 'required' => false, 'example' => 'dom-aaaa****', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'ExternalDomainId', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that is used for the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The ID of the external storage resource.'."\n" + ."\n" + .'> Call the DescribeDrives operation to retrieve the external storage resource ID.', 'type' => 'string', 'required' => false, 'example' => '1234****', 'title' => ''], ], [ - 'name' => 'UserName', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The username of the end user who is using the cloud computer.'."\n", + 'description' => 'The type of the storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- NAS: File Storage NAS'."\n" + ."\n" + .'- PDS: Drive and Photo Service', + 'enumValueTitles' => ['NAS' => '', 'PDS' => ''], 'type' => 'string', 'required' => false, - 'example' => 'alice', + 'example' => 'NAS', + 'title' => '', ], ], [ - 'name' => 'DesktopName', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the cloud computer.'."\n", + 'description' => 'The usage of the storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- DESKTOP: data disk space'."\n" + ."\n" + .'- USER\\_PROFILE: space for personal data of the user', + 'enumValueTitles' => ['DESKTOP' => '', 'USER_PROFILE' => ''], 'type' => 'string', 'required' => false, - 'example' => 'testName', + 'example' => 'USER_PROFILE', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DriveName', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'schema' => ['description' => 'The name of the user-level storage resource.', 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the policy that is attached to the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system-all-enabled-policy', - ], + 'schema' => ['description' => 'The description of the user-level storage resource.', 'type' => 'string', 'required' => false, 'example' => 'test01', 'title' => ''], ], [ - 'name' => 'ChargeType', + 'name' => 'ProfileRoaming', 'in' => 'query', + 'schema' => ['description' => '> This parameter is deprecated.', 'type' => 'boolean', 'required' => false, 'example' => '-', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The billing method of the cloud computer.'."\n" - ."\n" - .'Default value: Postpaid. Valid values:'."\n" - ."\n" - .'* Postpaid: pay-as-you-go'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PrePaid: subscription'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'B7AA****'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Code' => ['description' => 'The response code. The value 200 indicates that the request was successful.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Drive' => [ + 'description' => 'The user-level storage resource.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the storage resource was created.', 'type' => 'string', 'example' => '2025-07-02T08:42:26.000+00:00', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the storage resource was last modified.', 'type' => 'string', 'example' => '2025-07-07T02:46:04.000+00:00', 'title' => ''], + 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'example' => '1202****', 'title' => ''], + 'DomainId' => ['description' => 'The ID of the storage resource.', 'type' => 'string', 'example' => 'dom-aaaa****', 'title' => ''], + 'DriveId' => ['description' => 'The ID of the user-level storage resource.', 'type' => 'string', 'example' => 'dri-aaaa****', 'title' => ''], + 'ExternalDriveId' => ['description' => 'The ID of the external user-level storage resource.'."\n" + ."\n" + .'> A value is returned for this parameter only if ResourceType is set to PDS.', 'type' => 'string', 'example' => '1100****', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'user01', 'title' => ''], + 'ExternalUserId' => ['description' => 'The ID of the external user.', 'type' => 'string', 'example' => 'user01@cn-hangzhou.120****', 'title' => ''], + 'Name' => ['description' => 'The name of the storage resource.', 'type' => 'string', 'example' => 'test****', 'title' => ''], + 'Description' => ['description' => 'The description of the storage resource.', 'type' => 'string', 'example' => 'test****', 'title' => ''], + 'TotalSize' => ['description' => 'The total amount of the user-level storage resource capacity.'."\n" + ."\n" + .'> Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '536870912000', 'title' => ''], + 'UsedSize' => ['description' => 'The amount of user-level storage resource capacity used.'."\n" + ."\n" + .'> Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '243175936', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the user-level storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- INIT: initializing'."\n" + ."\n" + .'- MAINTAIN: maintaining'."\n" + ."\n" + .'- DELETING'."\n" + ."\n" + .'- INVALID'."\n" + ."\n" + .'- NORMAL'."\n" + ."\n" + .'- FAIL: failed', + 'enumValueTitles' => ['INIT' => '', 'MAINTAIN' => '', 'DELETING' => '', 'INVALID' => '', 'NORMAL' => '', 'FAIL' => ''], + 'type' => 'string', + 'example' => 'NORMAL', + 'title' => '', + ], + 'Type' => [ + 'description' => 'The usage of the storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- DESKTOP: data disk space'."\n" + ."\n" + .'- USER\\_PROFILE: space for personal data of the user', + 'enumValueTitles' => ['DESKTOP' => '', 'USER_PROFILE' => ''], + 'type' => 'string', + 'example' => 'USER_PROFILE', + 'title' => '', + ], + 'ProfileRoaming' => ['description' => '> This parameter is deprecated.', 'type' => 'boolean', 'example' => '-', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'PostPaid', + 'example' => '', ], ], + ], + 'title' => 'CreateDrive', + 'changeSet' => [ + ['createdAt' => '2022-08-31T07:11:35.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrive'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ExpiredTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when a subscription cloud computer expires.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-12-31T15:59Z', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDrive', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Drive\\": {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": \\"1202****\\",\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true\\n }\\n}","type":"json"}]', + ], + 'CreateEcdReportTask' => [ + 'summary' => 'Creates a data report export task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DesktopId', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'BusinessChannel', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => false, - 'maxItems' => 100, + 'type' => 'string', + 'enum' => ['Enterprise', 'Business'], + 'title' => '', + 'description' => '', + 'example' => '', ], ], [ - 'name' => 'EndUserId', + 'name' => 'TaskType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the end users of the cloud computer. You can specify 1 to 100 IDs.'."\n" + 'description' => 'The type of the report task.'."\n" ."\n" - .'> During a specific period of time, only one user can connect to and use the cloud computer.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of an end user of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => false, - 'maxItems' => 100, + .'Valid value:'."\n" + ."\n" + .'- RESOURCE\\_REPORT', + 'enumValueTitles' => ['RESOURCE_REPORT' => ''], + 'type' => 'string', + 'required' => true, + 'example' => 'RESOURCE_REPORT', + 'title' => '', ], ], [ - 'name' => 'LangType', + 'name' => 'SubType', 'in' => 'query', 'schema' => [ - 'description' => 'The language in which the cloud computer is displayed in the console UI. You can export the list of cloud computers in the specified language.'."\n" - ."\n" - .'Default value: zh-CN. Valid values:'."\n" - ."\n" - .'* zh-CN: Simplified Chinese'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* en-GB: British English'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The sub-type of the report export task.', + 'enumValueTitles' => [' DESKTOP' => 'Cloud computer'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'zh-CN' => '', - 'en-GB' => '', - ], - 'example' => '`zh-CN`', + 'required' => true, + 'example' => ' DESKTOP', + 'title' => '', ], ], [ - 'name' => 'Tag', + 'name' => 'FilterList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags that are added to the cloud computer. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud computers by group. This facilitates search and batch operations. For more information, see [Use tags to manage cloud computers](~~203781~~).'."\n", + 'description' => 'The filter conditions for filtering query results. The logical relationship between each filter condition is "and" (&). Each filter condition contains FilterKey and FilterValues, which indicate the key and value for the filter condition.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The filter condition object.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '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 cannot contain only spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.'."\n", - 'type' => 'string', + 'FilterKey' => ['description' => 'The key of the filter condition for filtering query results. When SubType is set to:'."\n" + ."\n" + .'1. DESKTOP (indicating a cloud computer report), the following filter conditions are available:'."\n" + ."\n" + .'- KeyWord: cloud computer keyword (supports automatic recognition)'."\n" + ."\n" + .'- RegionId: region ID'."\n" + ."\n" + .'- DesktopId: cloud computer ID'."\n" + ."\n" + .'- DesktopName: cloud computer name (supports fuzzy matching)'."\n" + ."\n" + .'- OfficeSiteId: office network ID'."\n" + ."\n" + .'- OfficeSiteName: office network name (supports fuzzy matching)'."\n" + ."\n" + .'- Status: cloud computer status'."\n" + ."\n" + .'- DesktopType: desktop type'."\n" + ."\n" + .'- DesktopIP: cloud computer IP address'."\n" + ."\n" + .'- SubPayType: billing method'."\n" + ."\n" + .'- EndUserId: user name (supports fuzzy matching)'."\n" + ."\n" + .'- ExpireTime: expiration date and time, in the yyyy-MM-dd\'T\'HH:mm:ss\'Z\' format'."\n" + ."\n" + .'- IncludeAssignedUser: indicates whether the cloud computer is assigned to users or not'."\n" + ."\n" + .'- ResourceGroupId: resource group ID'."\n" + ."\n" + .'- PolicyId: policy ID'."\n" + ."\n" + .'- Tag:{Tag Key value}: cloud computer tag (To filter data using multiple tags, specify multiple filter condition objects.)', 'type' => 'string', 'required' => false, 'example' => 'Tag:TestKey', 'title' => ''], + 'FilterValues' => [ + 'description' => 'The value of the filter condition. Only the first value of the FilterValues parameter is used, if FilterKey is set to one of the following values:'."\n" + ."\n" + .'- KeyWord'."\n" + ."\n" + .'- DesktopName'."\n" + ."\n" + .'- OfficeSiteName'."\n" + ."\n" + .'- DesktopIP'."\n" + ."\n" + .'- EndUserId'."\n" + ."\n" + .'- ExpireTime'."\n" + ."\n" + .'- IncludeAssignedUser', + 'type' => 'array', + 'items' => ['description' => 'The specific value of the filter condition for filtering query results.', 'type' => 'string', 'required' => false, 'example' => '测试云电脑名称', 'title' => ''], 'required' => false, - 'example' => 'TestValue', + 'maxItems' => 200, + 'title' => '', + 'example' => 'Test cloud desktop name', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ReportFileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the report file.', 'type' => 'string', 'example' => 'Test report name', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'LangType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the report. An enumerated type.', + 'enumValueTitles' => ['zh-CN' => '(Default) Chinese', 'en-GB' => 'English'], + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The URL of the exported file of the cloud computer list.'."\n", - 'type' => 'string', - 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The request result. If the request was successful, `success` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed. This parameter is not returned if the value of Code is success.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the report export task.', 'type' => 'string', 'example' => 'ret-g67ip******', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ExportDesktop.UnknowError', - 'errorMessage' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"ret-g67ip******\\"\\n}","type":"json"}]', + 'title' => 'CreateEcdReportTask', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateEcdReportTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CreateEcdReportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\n D3DFB159-0FAD-5C96-9E1F-DDBF15534B71\\n","errorExample":""}]', - 'title' => 'ExportDesktopListInfo', - 'summary' => 'Exports a cloud computer list as a CSV file.', - 'description' => 'The cloud computer list exported by calling this operation is saved as a CSV file. Each entry of data of a cloud computer includes the following fields:'."\n" - ."\n" - .'* Cloud computer ID and name'."\n" - .'* Office network ID and name'."\n" - .'* The instance type, OS and protocol of the cloud computer'."\n" - .'* System disk and data disk of the cloud computer'."\n" - .'* The status'."\n" - .'* Purchase method'."\n" - .'* The time when the cloud computer expires'."\n" - .'* Remaining duration and total duration'."\n" - .'* Number of assigned users and number of current users'."\n" - .'* Office network type'."\n" - .'* The time when the cloud computer was created'."\n" - .'* Tags'."\n" - .'* Encryption status'."\n" - .'* IP'."\n" - .'* The hostname'."\n", + 'translator' => 'manual', ], - 'StartDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to view the list of regions that support WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DesktopId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the image. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testImageName', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the image. The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'This is description.', 'title' => ''], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the snapshot.', 'type' => 'string', 'required' => false, 'example' => 's-2zefuwk8l6ytcgd3bf4o', 'title' => ''], + ], + [ + 'name' => 'ImageResourceType', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not available for use.', 'type' => 'string', 'required' => false, 'example' => 'deprecated', 'title' => ''], + ], + [ + 'name' => 'SnapshotIds', + 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers.'."\n", + 'description' => 'A list of snapshot IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - 'required' => true, - 'example' => 'ecd-7w78ozhjcwa3u****', + 'items' => ['description' => 'A snapshot ID.', 'type' => 'string', 'required' => false, 'example' => '[\\"s-2ze2ai7op1duq4mnx5ha\\"]', 'title' => ''], + 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'AutoCleanUserdata', + 'in' => 'query', 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Specify whether to clear user personal data. If set to `true`, the image clears all folders under `C:\\Users`, except `Administrator` and `Public`.', + 'enumValueTitles' => ['true' => 'Clear user personal data', 'false' => 'Do not clear user personal data \\[default]'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53\\r\\n","errorExample":""}]', - 'title' => 'StartDesktops', - 'summary' => 'Starts stopped cloud computers. After the API operation is successfully called, the cloud computers enter the Running state.', - 'description' => 'The cloud computers that you want to start must be in the Stopped state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'HibernateDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DiskType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", + 'description' => 'The disk data included in the image.', + 'enumValueTitles' => ['SYSTEM' => 'Save only system disk data', 'ALL' => 'Save system disk and data disk data \\[default]'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'ALL', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'DataSnapshotIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud desktops. You can specify 1 to 20 cloud desktop IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-eumyo1qzxscjf****', - ], - 'required' => true, + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '101AE027-8299-5E6E-A782-6C91C962****', - ], + 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"101AE027-8299-5E6E-A782-6C91C962****\\"\\n}","type":"json"}]', - 'title' => 'HibernateDesktops', - 'summary' => 'Hibernates cloud desktops.', - 'description' => 'Hibernating a cloud desktop is in private preview. If you want to try this feature, submit a ticket.'."\n", - ], - 'WakeupDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateImage', + 'summary' => 'Create a custom image from an existing WUYING Workspace. Use this image to quickly deploy more workspaces with identical configurations. Avoid repeating configuration steps each time you create a new workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-09T09:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-13T12:35:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-22T06:24:02.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateImage'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'CreateNASFileSystem' => [ + 'summary' => 'Create a NAS file system.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'Workspace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Name of the NAS file system.'."\n" + .'The file name must follow these rules:'."\n" + ."\n" + .'- Length: 2 to 128 English or Chinese characters.'."\n" + ."\n" + .'- Must start with an uppercase or lowercase letter or a Chinese character, cannot start with http\\:// or https\\://.'."\n" + ."\n" + .'- Can include numbers, underscores (\\_), or hyphens (-).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testNAS', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Description of the NAS file system.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription', 'title' => ''], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", + 'description' => 'Storage specification type of the NAS file system.', + 'enumValueTitles' => ['Capacity' => 'Capacity type (default)', 'Performance' => 'Performance type'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'docRequired' => false, + 'example' => 'Capacity', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'EncryptType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-j2eoqgf5u4mwj****', - ], - 'required' => true, - 'maxItems' => 100, + 'description' => 'Whether the file system is encrypted. Uses KMS service-managed keys to encrypt the file system\'s on-disk data. No decryption is required when reading and writing encrypted data.', + 'enumValueTitles' => ['Not encrypted (default)', 'Encrypted using NAS-managed keys.'], + 'type' => 'string', + 'required' => false, + 'example' => '0', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Return object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6557DBA9-CF3E-5C1B-B1F1-68FDA599****', - ], + 'FileSystemId' => ['description' => 'ID of the NAS file system.', 'type' => 'string', 'example' => '04f314****', 'title' => ''], + 'FileSystemName' => ['description' => 'Name of the NAS file system.', 'type' => 'string', 'example' => 'testNAS', 'title' => ''], + 'MountTargetDomain' => ['description' => 'Mount point domain.', 'type' => 'string', 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], + 'OfficeSiteId' => ['description' => 'Workspace ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6557DBA9-CF3E-5C1B-B1F1-68FDA599****\\"\\n}","type":"json"}]', - 'title' => 'WakeupDesktops', - 'summary' => 'Wakes up cloud computers.', - 'description' => 'Only cloud computers that are in the Hibernated state can be waked up.'."\n", - ], - 'StopDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateNASFileSystem', + 'description' => ''."\n" + ."\n" + .'- Each standard workspace can create one NAS file system to meet the need for sharing files between cloud desktops in the workspace.'."\n" + ."\n" + .'- The system will automatically create a general-purpose NAS file system (with storage specifications of Capacity and Performance, with capacities of 10 PiB and 1 PiB respectively) and generate a default mount point.'."\n" + ."\n" + .'- The NAS file system uses pay-as-you-go by default. You need to pay for the actual storage usage. You can also purchase resource packages to offset the storage usage.'."\n" + ."\n" + .'For more information, see [Creating Shared Storage NAS](~~214481~~).'."\n" + ."\n" + .''."\n" + ."\n" + .''."\n" + ."\n" + .'- Each standard workspace can create one NAS file system to meet the need for sharing files between cloud desktops in the workspace.'."\n" + ."\n" + .'- The system will automatically create a general-purpose NAS file system (with storage specifications of Capacity and Performance, with capacities of 10 PiB and 1 PiB respectively) and generate a default mount point.'."\n" + ."\n" + .'- The NAS file system uses pay-as-you-go by default. You need to pay for the actual storage usage. You can also purchase storage packages to offset the storage usage.'."\n" + ."\n" + .'For more information, see [Creating Shared Storage NAS](~~214481~~).'."\n" + ."\n" + .'', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-25T05:50:52.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNASFileSystem'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateNASFileSystem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FileSystemId\\": \\"04f314****\\",\\n \\"FileSystemName\\": \\"testNAS\\",\\n \\"MountTargetDomain\\": \\"04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]', + ], + 'CreateNetworkPackage' => [ + 'summary' => 'Creates a premium bandwidth plan for an office network.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => ['description' => 'The bandwidth of the premium bandwidth plan. Unit: Mbit/s. '."\n" + ."\n" + .'- If the premium bandwidth plan uses the subscription billing method, the valid values are 2 to 1000.'."\n" + .'- If the premium bandwidth plan uses the pay-as-you-go billing method and the billing type is pay-by-data-transfer (PayByTraffic), the valid values are 2 to 200.'."\n" + .'- If the premium bandwidth plan uses the pay-as-you-go billing method and the billing type is pay-by-bandwidth (PayByBandwidth), the valid values are 2 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20000', 'minimum' => '2', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + [ + 'name' => 'PayType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'docRequired' => false, + 'example' => 'PrePaid', + 'title' => '', ], ], [ - 'name' => 'StoppedMode', + 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The billing mode after you stop the cloud computer.'."\n" - ."\n" - .'Default value: StopCharging. Valid values:'."\n" + 'description' => 'The billable methods of the premium bandwidth plan.'."\n" ."\n" - .'* StopCharging: After the cloud computer is stopped, the system automatically reclaims computing resources. You are no longer charged for computing resources. However, you are still charged for storage resources.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* KeepCharging: After the cloud computer is stopped, the system does not reclaim resources to prevent insufficient resources and startup failures. You are still charged for the resources.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + .'- If the parameter `PayType` is set to `PrePaid`, valid values:'."\n" + .' - PayByBandwidth: billing by fixed bandwidth.'."\n" + .'- If the parameter `PayType` is set to `PostPaid`, valid values:'."\n" + .' - PayByTraffic: billing by data transfer.'."\n" + .' - PayByBandwidth: billing by fixed bandwidth.', + 'enumValueTitles' => ['PayByTraffic' => 'pay-by-data-transfer.', 'PayByBandwidth' => 'pay-by-bandwidth.'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'StopCharging' => '', - 'KeepCharging' => '', - ], - 'example' => 'StopCharging', + 'example' => 'PayByTraffic', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when PayType is set to PrePaid. Valid values are determined by the PeriodUnit parameter.'."\n" + ."\n" + .'- If PeriodUnit is set to Week, the valid value is 1.'."\n" + .'- If PeriodUnit is set to Month, valid values are 1, 2, 3, and 6.'."\n" + .'- If PeriodUnit is set to Year, valid values are 1, 2, and 3.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PeriodUnit', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - 'required' => true, - 'example' => 'ecd-7w78ozhjcwa3u****', - 'maxItems' => 100, + 'description' => 'The unit of the subscription duration for the premium bandwidth plan. This parameter takes effect and is required only when PayType is set to PrePaid.', + 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year', 'Week' => 'Week'], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Week', + 'title' => '', ], ], [ - 'name' => 'OsUpdate', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'Whether to perform a patch update when the update is ready. A value of true indicates that a patch update is performed.'."\n", + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Automatic payment is enabled. Make sure that your account has sufficient balance. Otherwise, abnormal orders are generated. (Default)', 'false' => 'An order is generated but not paid. You can log on to the console and pay for the order on the Orders page in User Center by using the returned order ID.'], 'type' => 'boolean', 'required' => false, + 'docRequired' => false, 'example' => 'false', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'AutoRenew', + 'in' => 'query', 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Specifies whether to enable auto-renewal.', + 'enumValueTitles' => ['true' => 'Auto-renewal is enabled.', 'false' => 'Auto-renewal is disabled.'], + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53\\r\\n","errorExample":""}]', - 'title' => 'StopDesktops', - 'summary' => 'Stop cloud computers that are in the Running state. After the operation is successfully called, the cloud computers enter the Stopped state.', - 'description' => 'The cloud computers that you want to stop must be in the Running state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RebootDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '23141', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResellerOwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'ChannelCookie', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'OsUpdate', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, + 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'NetworkPackageId' => ['description' => 'The premium bandwidth plan ID.', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '234526262716724', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 8F851208-C0EA-4CDD-9074-DBE70CB430DA\\r\\n","errorExample":""}]', - 'title' => 'RebootDesktops', - 'summary' => 'Restart cloud computers.', - 'description' => 'The cloud computers that you want to restart must be in the Running state.'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'RISK.RISK_CONTROL_REJECTION', 'errorMessage' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', 'description' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.'], + ], + ], + 'title' => 'Create a premium bandwidth plan for an office network', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'RebuildDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [ + ['createdAt' => '2025-09-22T02:00:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-06T09:59:53.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2025-07-22T04:52:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-30T03:32:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-14T07:58:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkPackage'], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify the IDs of 1 to 20 cloud computers.', - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the new image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-84mztzatmlnys****', - ], - ], - [ - 'name' => 'OperateType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operation type on the data disk.'."\n" - ."\n" - .'> This parameter is empty by default regardless of whether data disks are attached to the cloud computer.'."\n" - ."\n" - .'* No data disks are attached to the cloud computer:\\'."\n" - .' No operation is performed on the data disks of the cloud computer regardless of the value of this parameter.'."\n" - ."\n" - .'* Data disks are attached to the cloud computer:'."\n" - ."\n" - .' 1. The OS of the cloud computer is the same as the OS of the destination image:'."\n" - ."\n" - .' * If you set the OperateType parameter to `replace`, the data in the data disks of the cloud computer is replaced.'."\n" - .' * If you leave the OperateType parameter empty, the data in the data disks of the cloud computer is retained.'."\n" - ."\n" - .' 2. The OS of the cloud computer is different from the OS of the destination image:'."\n" - ."\n" - .' * If you set the OperateType parameter to `replace`, the data in the data disks of the cloud computer is replaced.'."\n" - .' * If you leave the OperateType parameter empty, the data in the data disks of the cloud computer is cleared.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'replace', - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'description' => 'The OS language. Only system images are supported, and Linux cloud computers support only English.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: English'."\n" - .'* zh-HK: Traditional Chinese (Hong Kong, China)'."\n" - .'* zh-CN: Simplified Chinese'."\n" - .'* ja-JP: Japanese'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'en-US', - ], - ], + 'ramActions' => [ [ - 'name' => 'AfterStatus', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'RebuildResults' => [ - 'description' => 'The recreation results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The recreation result code. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'IncorrectDesktopStatus', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is invalid if the value of `Code` is `success`.'."\n", - 'type' => 'string', - 'example' => 'The current status of the desktop does not support this operation.', - ], - 'DesktopId' => [ - 'description' => 'The IDs of the cloud computers.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - ], - ], - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateNetworkPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RebuildResults\\": [\\n {\\n \\"Code\\": \\"IncorrectDesktopStatus\\",\\n \\"Message\\": \\"The current status of the desktop does not support this operation.\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n The current status of the desktop does not support this operation.\\n ecd-gx2x1dhsmucyy****\\n IncorrectDesktopStatus\\n \\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n","errorExample":""}]', - 'title' => 'RebuildDesktops', - 'summary' => 'Rebuilds images for one or more cloud computers.', - 'description' => 'Before you proceed, take note of the following limits:'."\n" - ."\n" - .'* You cannot convert a cloud computer\'s operating system image from one type to another (e.g., Windows to Linux or vice versa) in China (Hong Kong) or overseas regions.'."\n" - .'* GPU and non-GPU images are not interchangeable, as graphic-based cloud computers can only use GPU-accelerated images, while other cloud computers are limited to non-GPU-accelerated images.'."\n" - ."\n" - .'When a cloud computer’s image is updated, the system initializes its system disk by using the new image, resulting in the following effects:'."\n" - ."\n" - .'* All data on the original system disk is erased. Snapshots created from the original system disk become unavailable and are automatically deleted.'."\n" - .'* If the OS changes, data on the original data disk is cleared, and snapshots created from the original data disk become unavailable and are automatically deleted. If the OS remains the same, data on the original data disk is retained, and snapshots from the original data disk remain available.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '* If the `200` status code is returned, the parameters in the `RebuildResults` section indicate whether the system starts to re-create the cloud computers. If the value of the `Code` parameter is `success`, the system starts to re-create the cloud computers. Otherwise, an error code that indicates the cloud computers fail to be re-created is returned in the Code parameter.'."\n" - .'* If a `4xx` status code is returned, a parameter is invalid and the system does not start to re-create the cloud computers.'."\n", - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OrderId\\": \\"234526262716724\\"\\n}","type":"json"}]', ], - 'SetDesktopMaintenance' => [ - 'summary' => 'Set the cloud computer maintenance mode.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateOfficeSiteAccelerator' => [ + 'summary' => 'Enables the Global Accelerator (GA) service for an office network.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'Mode', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Enter or exit cloud computer maintenance mode.'."\n" - ."\n" - .'Enumerated values:'."\n" - ."\n" - .'* ENTER: The enters the maintenance mode.'."\n" - .'* EXIT: The exits the maintenance mode.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ENTER' => '', - 'EXIT' => '', - ], - 'example' => 'enter', - ], + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-259382****', 'title' => ''], ], [ - 'name' => 'DesktopIds', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the GA instance.', 'type' => 'string', 'required' => false, 'example' => 'testGA', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-3mtuc28rx95lx****', 'title' => ''], + ], + [ + 'name' => 'AccelerateRegion', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'A list of cloud computer IDs for which you want to set maintenance mode. A maximum of 100 cloud computer IDs are supported.'."\n", + 'description' => 'A list of regions where access points provide acceleration.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the cloud computer for which you want to set maintenance mode.'."\n", - 'type' => 'string', + 'description' => 'The information about the acceleration region.', + 'type' => 'object', + 'properties' => [ + 'AccelerateRegionId' => ['description' => 'The ID of the acceleration region.', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1', 'title' => ''], + 'IpVersion' => [ + 'description' => 'The IP protocol version used to access the GA instance.'."\n" + ."\n" + .'> Only standard pay-as-you-go GA instances support `DUAL_STACK`.', + 'enumValueTitles' => ['DUAL_STACK' => 'IPv4 and IPv6', 'IPv6' => 'IPv6 protocol', 'IPv4' => 'IPv4 protocol (Default)'], + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + 'title' => '', + ], + 'Bandwidth' => ['description' => 'The bandwidth allocated to the acceleration region. Unit: Mbps.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '2', 'example' => '50', 'title' => ''], + 'IspType' => [ + 'description' => 'The line type.'."\n" + ."\n" + .'> - This parameter is required for pay-by-data-transfer GA instances.'."\n" + .'>'."\n" + .'> - The supported line types vary by acceleration region.', + 'enumValueTitles' => ['BGP' => 'BGP (Multi-ISP) lines', 'BGP_PRO' => 'BGP (Multi-ISP) Pro lines'], + 'type' => 'string', + 'required' => true, + 'example' => 'BGP', + 'title' => '', + ], + ], 'required' => false, - 'example' => 'ecd-dzeotbgawdnfo****', + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 100, + 'docRequired' => true, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response elements.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BA6A1853-3EA9-5EEB-86C8-3D14A3E01905', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'AcceleratorId' => ['description' => 'The ID of the GA instance.', 'type' => 'string', 'example' => 'ga-bp1qxuk10jceqw3zb***p', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA6A1853-3EA9-5EEB-86C8-3D14A3E01905\\"\\n}","type":"json"}]', - 'title' => 'SetDesktopMaintenance', - 'description' => 'If you need to perform some maintenance operations on the cloud computer and want to prohibit end user from connecting and using the cloud computer during this period, you can switch it to maintenance mode.'."\n", - ], - 'ModifyDesktopName' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'update', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateOfficeSiteAccelerator', + 'description' => 'Before you call this operation, ensure you fully understand the billing methods and [pricing](t2208086.xdita#) of the GA service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'NewDesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new name of the cloud computer. The name of the cloud computer must meet the following requirements:'."\n" - ."\n" - .'* The name must be 1 to 64 characters in length.'."\n" - .'* The name must start with a letter but cannot start with `http://` or `https://`.'."\n" - .'* The name can only contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], - ], + 'ramActions' => [ [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy**** ', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateOfficeSiteAccelerator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\r\\n","errorExample":""}]', - 'title' => 'ModifyDesktopName', - 'summary' => 'Changes the name of a cloud computer to a new name.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AcceleratorId\\": \\"ga-bp1qxuk10jceqw3zb***p\\"\\n}","type":"json"}]', ], - 'ModifyDiskSpec' => [ - 'summary' => 'Changes the performance level (PL) of a system disk or data disk.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePolicyGroup' => [ + 'summary' => 'Creates a cloud computer policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~DescribeRegions~~) operation to obtain the list of regions that support WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'Clipboard', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", + 'description' => 'The clipboard permission.', + 'enumValueTitles' => ['read' => 'one-way transfer. You can copy content from your local computer to the cloud computer, but not the other way around.', 'readwrite' => 'bidirectional transfer. You can copy content between your local computer and the cloud computer.', 'write' => 'one-way transfer. You can copy content from the cloud computer to your local computer, but not the other way around.', 'off' => 'disabled. You cannot copy content between the cloud computer and your local computer. \\[Default]'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecd-2yjhqxo1monxxxxxx', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'RootDiskPerformanceLevel', + 'name' => 'LocalDrive', 'in' => 'query', 'schema' => [ - 'description' => 'The PL of the system disk. Only Enterprise Graphics or High Frequency cloud computers support disk PL adjustments.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - .'* PL0'."\n" - .'* PL3'."\n" - .'* PL2'."\n", + 'description' => 'The local disk mapping permission.', + 'enumValueTitles' => ['read' => 'read-only. The local disk is mapped to the cloud computer. You can read and copy local files, but you cannot modify them.', 'readwrite' => 'read and write. The local disk is mapped to the cloud computer. You can read, copy, and modify local files.', 'off' => 'disabled. The local disk is not mapped to the cloud computer. \\[Default]'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL1', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'UserDiskPerformanceLevel', + 'name' => 'UsbRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The PL of the data disk. Only Enterprise Graphics or High Frequency cloud computers support disk PL adjustments.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - .'* PL0'."\n" - .'* PL3'."\n" - .'* PL2'."\n", + 'description' => 'USB redirection.', + 'enumValueTitles' => ['off' => 'disabled \\[Default]', 'on' => 'enabled'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL1', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'PromotionId', + 'name' => 'VisualQuality', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the sales promotion activity. You can call the DescribePrice operation to obtain the IDs of matching sales promotion activities.'."\n", + 'description' => 'The image display quality policy.', + 'enumValueTitles' => ['high' => 'high definition', 'low' => 'low definition', 'lossless' => 'lossless', 'medium' => 'adaptive \\[Default]'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => 'youhuiquan_promotion_option_id_for_blank', + 'example' => 'medium', + 'title' => '', ], ], [ - 'name' => 'AutoPay', + 'name' => 'Html5Access', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the automatic payment feature.'."\n" - ."\n" - .'* If you set the value to `true`, ensure your account has sufficient balance to avoid generating abnormal orders.'."\n" - .'* If you set the value to `false`, go to the **Expenses and Costs** page to complete the payment based on the order number.'."\n" + 'description' => 'The policy for access from web clients.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default): enables the automatic payment feature.'."\n" - .'* false: generates the order and manually complete the payment.'."\n", - 'type' => 'boolean', + .'> Use the `ClientType` parameters to manage logon methods.', + 'enumValueTitles' => ['off' => 'disabled \\[Default]', 'on' => 'enabled'], + 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'Html5FileTransfer', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The file transfer policy for web clients.', + 'enumValueTitles' => ['all' => 'allows uploads and downloads', 'download' => 'allows downloads', 'upload' => 'allows uploads', 'off' => 'disabled \\[Default]'], + 'type' => 'string', 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order. You can obtain the ID of an order from the [Expenses and Costs > Orders](https://usercenter2-intl.aliyun.com/order/list) page.'."\n", - 'type' => 'string', - 'example' => '219861020660568', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F89BBB13-8B3B-5C8A-A700-EEFDC17B8227', - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"219861020660568\\",\\n \\"RequestId\\": \\"F89BBB13-8B3B-5C8A-A700-EEFDC17B8227\\"\\n}","type":"json"}]', - 'title' => 'ModifyDiskSpec', - 'description' => 'When creating a cloud computer in Elastic Desktop Service (EDS) Enterprise, you can use a template to define specifications that align with your business needs. By default, Enterprise Graphics or High Frequency cloud computers utilize Enterprise SSDs (ESSDs). You can customize the disk capacity and performance level (PL) of these ESSDs, and adjust the PL for both system and data disks as needed.'."\n" - ."\n" - .'> Only Enterprise Graphics or High Frequency cloud computers support disk PL adjustments.'."\n", - ], - 'ModifyDesktopChargeType' => [ - 'summary' => 'Changes the billing method of cloud computers to subscription or pay-as-you-go.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Watermark', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The watermark feature.', + 'enumValueTitles' => ['blind' => 'enables invisible watermarks', 'off' => 'disables watermarks \\[Default]', 'on' => 'enables visible watermarks'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ChargeType', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The new billing method that you want to apply.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: changes the billing method from subscription to pay-as-you-go.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PrePaid: changes the billing method from pay-as-you-go to subscription.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], + 'schema' => ['description' => 'The policy name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testPolicyGroupName', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'WatermarkType', 'in' => 'query', 'schema' => [ - 'description' => 'The subscription duration of the cloud computers if you set the ChargeType parameter to PrePaid. The unit is specified by the `PeriodUnit` parameter. This parameter is valid only when the `ChargeType` parameter is set to `PrePaid`. In this case, you must specify this parameter.'."\n" + 'description' => 'The type of watermark. You can specify up to three types. Separate multiple types with commas (,).'."\n" ."\n" - .'* If the `PeriodUnit` parameter is set to `Week`, set the Period parameter to 1.'."\n" - .'* If the `PeriodUnit` parameter is set to `Month`, the valid values of the Period parameter are 1, 2, 3, and 6.'."\n" - .'* If the `PeriodUnit` parameter is set to `Year`, the valid values of the Period parameter are 1, 2, 3, 4, and 5.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'> If you set this parameter to `custom`, you must also specify the `WatermarkCustomText` parameter.', + 'enumValueTitles' => ['EndUserId' => 'username', 'Custom' => 'custom text', 'DesktopIp' => 'cloud computer IP address', 'ClientIp' => 'client IP address', 'HostName' => 'the last 15 characters of the cloud computer ID', 'ClientTime' => 'current time of the cloud computer'], + 'type' => 'string', 'required' => false, - 'example' => '1', + 'example' => 'EndUserId', + 'title' => '', ], ], [ - 'name' => 'PeriodUnit', + 'name' => 'WatermarkTransparency', 'in' => 'query', 'schema' => [ - 'description' => 'The unit of the subscription duration if you specify subscription as the new billing method for the cloud desktop.'."\n", + 'description' => 'The transparency of the watermark.', + 'enumValueTitles' => ['LIGHT' => 'light \\[Default]', 'DARK' => 'dark', 'MIDDLE' => 'medium'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - 'Week' => '', - ], - 'example' => 'Month', + 'example' => 'LIGHT', + 'title' => '', ], ], [ - 'name' => 'AutoPay', + 'name' => 'PreemptLogin', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable automatic payment if you specify subscription as the new billing method for the cloud desktop.'."\n", - 'type' => 'boolean', + 'description' => 'The preemption policy.'."\n" + ."\n" + .'> To ensure the user experience and data security of the end users who are using cloud computers, mutual preemption among multiple users is not allowed. This parameter is set to `off` by default and cannot be changed.', + 'enumValueTitles' => ['off' => 'Mutual preemption among multiple users is not allowed. \\[Default]'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'DomainList', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 20 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["ecd-gx2x1dhsmucyy****"]', - ], - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy****', - 'maxItems' => 100, + 'description' => 'The policy for controlling access to domain names. You can use a wildcard character (\\*). Separate multiple domain names with commas (,).', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'PromotionId', + 'name' => 'PrinterRedirection', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the promotional activity.'."\n", + 'description' => 'The printer redirection policy.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], 'type' => 'string', 'required' => false, - 'example' => '500038360030606', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'UseDuration', + 'name' => 'PreemptLoginUser', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '> This parameter is in invitational preview and not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The usernames of the users that are allowed to preempt the cloud computer. You can specify up to five usernames.'."\n" + ."\n" + .'> To ensure the user experience and data security of the end users who are using cloud computers, mutual preemption among multiple users is not allowed.', + 'type' => 'array', + 'items' => ['description' => 'The username of a user that can preempt the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], 'required' => false, - 'example' => 'internal only', + 'example' => 'Alice', + 'maxItems' => 5, + 'title' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'AuthorizeSecurityPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '123456789', + 'description' => 'The list of security group rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'A security group rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The direction of the security group rule.', + 'enumValueTitles' => ['outflow' => 'outbound', 'inflow' => 'inbound'], + 'type' => 'string', + 'required' => false, + 'example' => 'inflow', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'The authorization policy of the security group rule.', + 'enumValueTitles' => ['drop' => 'denies all access requests. No rejection message is returned. The requester receives a timeout error or fails to establish a connection.', 'accept' => 'accepts all access requests. \\[Default]'], + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + 'title' => '', + ], + 'PortRange' => ['description' => 'The port range of the security group rule. The value of this parameter depends on the value of the \\`IpProtocol\\` parameter.'."\n" + ."\n" + .'- If \\`IpProtocol\\` is set to TCP or UDP, the port range is 1 to 65535. Use a forward slash (/) to separate the start port and the end port. For example: 1/200.'."\n" + ."\n" + .'- If \\`IpProtocol\\` is set to ICMP, the port range is -1/-1.'."\n" + ."\n" + .'- If \\`IpProtocol\\` is set to GRE, the port range is -1/-1.'."\n" + ."\n" + .'- If \\`IpProtocol\\` is set to all, the port range is -1/-1.'."\n" + ."\n" + .'For more information about common ports, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'The description of the security group rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'The protocol type of the security group rule.', + 'enumValueTitles' => ['TCP' => 'TCP', 'UDP' => 'UDP', 'ALL' => 'all protocols', 'GRE' => 'GRE', 'ICMP' => 'ICMP for IPv4'], + 'type' => 'string', + 'required' => false, + 'example' => 'tcp', + 'title' => '', + ], + 'Priority' => ['description' => 'The priority of the security group rule. A smaller value indicates a higher priority.
'."\n" + .'Valid values: 1 to 60.
'."\n" + .'Default value: 1.

', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'The object of the security group rule. The value is an IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AuthorizeAccessPolicyRule', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The client IP address whitelist. After you configure this parameter, only IP addresses in the whitelist can access the cloud computer.', + 'type' => 'array', + 'items' => [ + 'description' => 'The client IP address whitelist.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the client IP address whitelist.', 'type' => 'string', 'example' => 'North China Branch', 'required' => false, 'title' => ''], + 'CidrIp' => ['description' => 'The client IP address CIDR block. The value is an IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], ], - 'DesktopId' => [ - 'description' => 'The IDs of the cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of logon method control rules. These rules control which clients can be used to access the cloud computer.', + 'type' => 'array', + 'items' => [ + 'description' => 'A logon method control rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Logon method control. Specifies whether to allow a specific type of client to log on to the cloud computer.'."\n" + ."\n" + .'> If you do not configure the `ClientType` parameters, all types of clients are allowed to log on to the cloud computer by default.', + 'enumValueTitles' => ['OFF' => 'not allowed', 'ON' => 'allowed'], 'type' => 'string', - 'example' => '["ecd-gx2x1dhsmucyy****"]', + 'required' => false, + 'example' => 'ON', + 'title' => '', + ], + 'ClientType' => [ + 'description' => 'Logon method control. Specifies the client type.'."\n" + ."\n" + .'> If you do not configure the `ClientType` parameters, all types of clients are allowed to log on to the cloud computer by default.', + 'enumValueTitles' => ['html5' => 'web client', 'android' => 'Android client', 'ios' => 'iOS client', 'windows' => 'Windows client', 'macos' => 'macOS client'], + 'type' => 'string', + 'required' => false, + 'example' => 'windows', + 'title' => '', ], ], - 'TaskId' => [ - 'type' => 'string', - ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ],\\n \\"TaskId\\": \\"\\"\\n}","type":"json"}]', - 'title' => 'ModifyDesktopChargeType', - 'description' => '* Before you call this operation, make sure that you fully understand the billing methods of cloud computers. For more information, see [Billing overview](~~188395~~).'."\n" - .'* Before you call this operation, make sure that the cloud computers whose billing method you want to change are in the Running or Stopped state and you have no overdue payments in your Alibaba Cloud account.'."\n" - .'* After the order payment is completed, the system starts to change the billing method of the cloud computers. During the change, you cannot perform operations, such as starting or stopping the cloud computers, and changing configurations of the cloud computers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDesktopSpec' => [ - 'summary' => 'Changes the instance type of a cloud computer and scales up the disks of the cloud computer.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'GpuAcceleration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the image quality policy for graphics cloud computers. Enable this policy for scenarios that require high performance and user experience, such as professional design.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'abilityTreeCode' => '52878', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', + [ + 'name' => 'UsbSupplyRedirectRule', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The USB redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'A USB redirection rule.', + 'type' => 'object', + 'properties' => [ + 'VendorId' => ['description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '04**', 'title' => ''], + 'ProductId' => ['description' => 'The product ID (PID).', 'type' => 'string', 'required' => false, 'example' => '08**', 'title' => ''], + 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'required' => false, 'example' => '测试规则', 'title' => ''], + 'UsbRedirectType' => [ + 'description' => 'The USB redirection type.', + 'enumValueTitles' => [1 => 'allow', 'deny'], + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'DeviceClass' => ['description' => 'The device class. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'required' => false, 'example' => '0Eh', 'title' => ''], + 'DeviceSubclass' => ['description' => 'The device subclass. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'required' => false, 'example' => 'xxh', 'title' => ''], + 'UsbRuleType' => [ + 'description' => 'The USB redirection rule type.', + 'enumValueTitles' => [1 => 'device class', 'device vendor'], + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DomainResolveRuleType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The type of the domain name resolution policy.', + 'enumValueTitles' => ['OFF' => 'disabled', 'ON' => 'enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'DomainResolveRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', + 'description' => 'The details of the domain name resolution policy.', + 'type' => 'array', + 'items' => [ + 'description' => 'A domain name resolution policy.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com', 'title' => ''], + 'Policy' => [ + 'description' => 'The resolution policy.', + 'enumValueTitles' => ['allow' => 'allow', 'block' => 'deny'], + 'type' => 'string', + 'required' => false, + 'example' => 'allow', + 'title' => '', + ], + 'Description' => ['description' => 'The policy description.', 'type' => 'string', 'required' => false, 'example' => '测试规则', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => 'ecd-4543qyik164a4****', + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopType', + 'name' => 'Recording', 'in' => 'query', 'schema' => [ - 'description' => 'The destination instance type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the instance types supported by cloud computers.'."\n", + 'description' => 'Specifies whether to enable screen recording.', + 'enumValueTitles' => ['byaction_cmd_ft' => 'records the screen when a user runs a command or transfers a file.', 'ALLTIME' => 'records the screen for the entire session, from when a user connects to the cloud computer to when the user disconnects.', 'session' => 'records the screen based on the session lifecycle.', 'PERIOD' => 'records the screen at specified intervals. You must set the start and end times for recording.', 'byaction_commands' => 'records the screen only when a user runs a command.', 'OFF' => 'disables screen recording.', 'byaction_file_transfer' => 'records the screen only when a user transfers a file.'], 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'eds.general.2c8g', + 'required' => false, + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'RootDiskSizeGib', + 'name' => 'RecordingStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The time when screen recording starts. The value is in the HH:MM:SS format. This parameter is valid only when \\`Recording\\` is set to \\`PERIOD\\`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], + ], + [ + 'name' => 'RecordingEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The time when screen recording ends. The value is in the HH:MM:SS format. This parameter is valid only when \\`Recording\\` is set to \\`PERIOD\\`.', 'type' => 'string', 'required' => false, 'example' => '08:59:00', 'title' => ''], + ], + [ + 'name' => 'RecordingFps', 'in' => 'query', 'schema' => [ - 'description' => 'The size of the new system disk. Unit: GiB. Valid values: 80 to 500 GiB. The value must be a multiple of 10.'."\n", + 'description' => 'The frame rate for screen recording. Unit: frames per second (fps).', + 'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'], 'type' => 'integer', - 'format' => 'int32', + 'format' => 'int64', 'required' => false, - 'docRequired' => false, - 'maximum' => '32768', - 'minimum' => '0', - 'example' => '80', + 'example' => '2', + 'title' => '', ], ], [ - 'name' => 'UserDiskSizeGib', + 'name' => 'RecordingExpires', + 'in' => 'query', + 'schema' => ['description' => 'The retention period of the recording file. Valid values: 1 to 180. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'CameraRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The destination data disk size. Unit: GiB.'."\n" - ."\n" - .'* The data disk size of a non-graphical cloud computer ranges from 20 to 1020 GiB and must be a multiple of 10.'."\n" - .'* The data disk size of a graphical cloud computer ranges from 40 to 1020 GiB and must be a multiple of 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to enable local camera redirection.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled \\[Default]'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '65536', - 'minimum' => '0', - 'example' => '100', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'AutoPay', + 'name' => 'NetRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the auto-payment feature.'."\n" - ."\n" - .'Default value: true. Valid values:'."\n" - ."\n" - .'* true: enables the auto-payment feature.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' Make sure that you have sufficient balance in your Alibaba Cloud account. Otherwise, an exception occurs on your order.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated, and no payment is automatically made.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' You can log on to the Elastic Desktop Service console and complete the payment based on the order ID on the Orders page.'."\n" + 'description' => 'Specifies whether to enable network redirection.'."\n" ."\n" - .' ', - 'type' => 'boolean', + .'> This feature is in invitational preview and is not available to the public.', + 'enumValueTitles' => ['off' => 'disabled \\[Default]', 'on' => 'enabled'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'UserDiskPerformanceLevel', + 'name' => 'AppContentProtection', 'in' => 'query', 'schema' => [ - 'description' => 'The performance level (PL) of the data disk. Default value: PL0.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL0'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL3'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL2'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'Specifies whether to enable the anti-screenshot feature.', + 'enumValueTitles' => ['off' => 'disabled \\[Default]', 'on' => 'enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL0', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'PromotionId', + 'name' => 'RecordContent', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the promotional activity.'."\n", + 'description' => 'Specifies whether to enable custom screen recording.', + 'enumValueTitles' => ['off' => 'disabled \\[Default]', 'on' => 'enabled'], 'type' => 'string', 'required' => false, - 'example' => '500033080110596', + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'ResourceSpecs', + 'name' => 'RecordContentExpires', + 'in' => 'query', + 'schema' => ['description' => 'The expiration time of custom recording files. The default value is 30. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'RemoteCoordinate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyboard and mouse control permissions for remote assistance.', + 'enumValueTitles' => ['optionalControl' => 'disabled by default (can be requested to be enabled)', 'fullControl' => 'full control', 'disableControl' => 'no control'], + 'type' => 'string', + 'required' => false, + 'example' => 'fullControl', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingDuration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The duration for viewing the recording file. Unit: minutes. The recording file is automatically split based on the specified duration and uploaded to a bucket. If a file reaches 300 MB, it is rolled over first.', + 'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'title' => '', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scope of the policy.', + 'enumValueTitles' => ['IP' => 'takes effect based on the IP address', 'GLOBAL' => 'takes effect globally'], + 'type' => 'string', + 'required' => false, + 'example' => 'GLOBAL', + 'title' => '', + ], + ], + [ + 'name' => 'ScopeValue', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The array of resource specification templates.', + 'description' => 'This parameter is required when `Scope` is set to `IP`. It takes effect only when `Scope` is set to `IP`.', 'type' => 'array', - 'items' => [ - 'description' => 'The resource specification template.', - 'type' => 'object', - 'properties' => [ - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-4543qyik164a4****', - ], - 'RootDiskSizeGib' => [ - 'description' => 'The target size of the system disk. Valid values: 80-500 GiB. The value must be a multiple of 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], - 'UserDiskSizeGib' => [ - 'description' => 'The target size of the data disk. Valid values: 80-500 GiB. The value must be a multiple of 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The CIDR block that takes effect.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24', 'title' => ''], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResourceType', + 'name' => 'RecordingAudio', 'in' => 'query', 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'> This parameter is optional for non-subscribed cloud computers.', + 'description' => 'The option to record audio from the cloud computer.', + 'enumValueTitles' => ['off' => 'records only the screen, not the audio', 'on' => 'records both the screen and audio'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'DesktopMonthPackage' => 'DesktopMonthPackage', - ], - 'example' => 'DesktopMonthPackage', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'InternetCommunicationProtocol', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The network communication protocol.', + 'enumValueTitles' => ['TCP' => 'allows only TCP \\[Default]', 'BOTH' => 'allows automatic switching between TCP and UDP'], + 'type' => 'string', 'required' => false, + 'example' => 'both', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'VideoRedirect', + 'in' => 'query', 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '123456789', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OrderIds' => [ - 'description' => 'The array of order IDs.', - 'type' => 'array', - 'items' => [ - 'description' => 'The order ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456789', - ], - ], - ], + 'description' => 'Multimedia redirection.', + 'enumValueTitles' => ['off' => 'disables media redirection', 'on' => 'enables media redirection'], + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderIds\\": [\\n 123456789\\n ]\\n}","type":"json"}]', - 'title' => 'ModifyDesktopSpec', - 'description' => 'Changing the configurations of a cloud computer includes changing the instance type of the cloud computer and scaling up the disks of the cloud computer.'."\n" - ."\n" - .'* Before you change the configurations of a cloud computer, you must understand the instance types and disk sizes supported by cloud computers. For more information, see [Cloud computer types](~~188609~~). You can call the [DescribeDesktopTypes](~~188882~~) operation to query the instance types supported by cloud computers.'."\n" - ."\n" - .'* You must change at least one of the following configurations: instance type, system disk size, and data disk size of the cloud computer. You must specify at least one of the following parameters: `DesktopType`, `RootDiskSizeGib`, and `UserDiskSizeGib`. Take note of the following items:'."\n" - ."\n" - .' * The instance type of a cloud computer includes the configurations of vCPUs, memory, and GPUs. You can only change an instance type to another. You cannot change only one of the configurations.'."\n" - .' * You cannot change a cloud computer between the General Office type and the non-General Office type. You cannot yet change a cloud computer between the Graphics type and the non-Graphics type.'."\n" - .' * The system disk and data disks of a cloud computer can only be scaled up and cannot be scaled down.'."\n" - .' * If the billing method of the cloud computer is subscription, the system calculates the price difference based on the configuration difference between the original cloud computer and the new cloud computer. You must make up for the price difference or receive a refund for the price difference.'."\n" - .' * We recommend that you do not change the configurations of a cloud computer twice within 5 minutes.'."\n" - .' * When you change the configurations of a cloud computer, the cloud computer must be in the Stopped state.'."\n" - ."\n" - .'* After you change the configurations of a cloud computer, the personal data on the cloud computer is not affected.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyDesktopTimer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'WatermarkTransparencyValue', + 'in' => 'query', + 'schema' => ['description' => 'The opacity of the watermark. A larger value indicates lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'WatermarkColor', + 'in' => 'query', + 'schema' => ['description' => 'The font color of the watermark. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WatermarkDegree', + 'in' => 'query', + 'schema' => ['description' => 'The rotation angle of the watermark. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontSize', + 'in' => 'query', + 'schema' => ['description' => 'The font size of the watermark. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontStyle', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The font style of the watermark.', + 'enumValueTitles' => ['plain' => 'plain', 'bold' => 'bold'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'plain', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'WatermarkRowAmount', + 'in' => 'query', + 'schema' => ['description' => 'The number of watermark rows.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'EndUserApplyAdminCoordinate', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-asuk39x45qnjp****', - ], - 'required' => true, - 'maxItems' => 101, + 'description' => 'Specifies whether to allow end users to request assistance from administrators.', + 'enumValueTitles' => ['OFF' => 'disabled', 'ON' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'title' => '', ], ], [ - 'name' => 'DesktopTimers', + 'name' => 'EndUserGroupCoordinate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable stream collaboration between users.', + 'enumValueTitles' => ['OFF' => 'disabled', 'ON' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'ON', + 'title' => '', + ], + ], + [ + 'name' => 'WatermarkSecurity', + 'in' => 'query', + 'schema' => [ + 'description' => 'The security priority rule for invisible watermarks.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'title' => '', + ], + ], + [ + 'name' => 'AdminAccess', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether a user has administrative permissions after logging on to the cloud computer.'."\n" + ."\n" + .'> This feature is in invitational preview and is not available to the public.', 'type' => 'string', 'required' => false, 'example' => 'deny', 'title' => ''], + ], + [ + 'name' => 'WatermarkAntiCam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The anti-screen-recording feature for invisible watermarks.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + ], + [ + 'name' => 'WatermarkPower', + 'in' => 'query', + 'schema' => [ + 'description' => 'The enhanced feature for invisible watermarks.', + 'enumValueTitles' => ['high' => 'high', 'low' => 'low', 'medium' => 'medium'], + 'type' => 'string', + 'required' => false, + 'example' => 'medium', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingUserNotify', + 'in' => 'query', + 'schema' => [ + 'description' => 'The feature that sends notifications to the client when screen recording is in progress.', + 'enumValueTitles' => ['off' => 'disabled', 'on' => 'enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + ], + [ + 'name' => 'RecordingUserNotifyMessage', + 'in' => 'query', + 'schema' => ['description' => 'The content of the notification that is sent to the client when screen recording is in progress. You do not need to specify this parameter.', 'type' => 'string', 'example' => 'Your cloud desktop is being recorded.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'MaxReconnectTime', + 'in' => 'query', + 'schema' => ['description' => 'The maximum amount of time to retry the connection if the cloud computer is disconnected due to an unexpected event. Valid values: 30 to 7200. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'DeviceRedirects', 'in' => 'query', - 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The details of the scheduled task on cloud computers.'."\n", + 'description' => 'The list of device redirection rules.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A device redirection rule.', 'type' => 'object', 'properties' => [ - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NoOperationDisconnect: Disconnects the cloud computers without performing operations on the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* LogoutShutdown: Stops the cloud computers when end users log out Alibaba Cloud Workspace clients.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoConnect: Disconnects the cloud computers when end users perform one of the actions that is specified by the OperationType parameter.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* TimerBoot: Starts the cloud computers on schedule.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* TimerReset: Resets the cloud computers on schedule.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* LoginAutoConnect: automatically connects to the cloud computers when end users log on to Alibaba Cloud Workspace clients.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoOperationShutdown: Stops the cloud computers without performing operations on the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* TimerShutdown: Stops the cloud computers on schedule.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoOperationReboot: Restarts the cloud computers without performing operations on the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* TimerReboot: Restarts the cloud computers on schedule.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'DeviceType' => [ + 'description' => 'The peripheral type.', + 'enumValueTitles' => ['printer' => 'printer', 'scanner' => 'scanner', 'camera' => 'camera', 'adb' => 'Android device'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'LogoutShutdown' => '', - 'NoConnect' => '', - 'TimerBoot' => '', - 'TimerReset' => '', - 'LoginAutoConnect' => '', - 'NoOperationShutdown' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], - 'example' => 'TimerBoot', + 'example' => 'camera', + 'title' => '', ], - 'CronExpression' => [ - 'description' => 'The cron expression of the schedule.'."\n" - ."\n" - .'> The time must be in UTC. For example, for 24:00 (UTC+8), you must set the value to 0 0 16 ? \\* 1,2,3,4,5,6,7'."\n", + 'RedirectType' => [ + 'description' => 'The redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'disables redirection'], 'type' => 'string', 'required' => false, - 'example' => '0 0 16 ? * 1,2,3,4,5,6,7', - ], - 'Interval' => [ - 'description' => 'The interval at which the scheduled task is executed. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Enforce' => [ - 'description' => 'Specifies whether to forcibly execute the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: forcibly executes the scheduled task regardless of the status and connection of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: does not forcibly execute the scheduled task.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'example' => 'deviceRedirect', + 'title' => '', ], - 'ResetType' => [ - 'description' => 'The reset type of the cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESET_TYPE_SYSTE: resets the system disk.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RESET_TYPE_BOTH: resets data and user disks.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DeviceRules', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of custom peripheral rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'A custom peripheral rule.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => [ + 'description' => 'The peripheral type.', + 'enumValueTitles' => ['usbKey' => 'UKey', 'other' => 'other', 'graphicsTablet' => 'graphics tablet', 'printer' => 'printer', 'cardReader' => 'card reader', 'scanner' => 'scanner', 'storage' => 'storage device', 'camera' => 'camera', 'adb' => 'Android device', 'networkInterfaceCard' => 'network interface controller (NIC)'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '', - 'RESET_TYPE_BOTH' => '', - ], - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'description' => 'Specifies whether to allow end users to configure the scheduled task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'example' => 'storage', + 'title' => '', ], - 'OperationType' => [ - 'description' => 'The operations that scheduled tasks support. This parameter is valid only when TimerType is set to NoConnect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hibernate: hibernates the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Shutdown: stops the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'required' => false, 'example' => 'sandisk', 'title' => ''], + 'DeviceVid' => ['description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '0x0781', 'title' => ''], + 'DevicePid' => ['description' => 'The product ID (PID).', 'type' => 'string', 'required' => false, 'example' => '0x55b1', 'title' => ''], + 'RedirectType' => [ + 'description' => 'The redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'disables redirection'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Hibernate' => '', - 'Shutdown' => '', - ], - 'example' => 'Shutdown', + 'example' => 'usbRedirect', + 'title' => '', ], + 'OptCommand' => ['description' => 'The link optimization instruction.', 'type' => 'string', 'required' => false, 'example' => '2:0', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UseDesktopTimers', + 'name' => 'WyAssistant', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to use the `DesktopTimers`** parameter. Set the value to `true`**.'."\n", - 'type' => 'boolean', + 'description' => 'When you connect to a cloud computer from a desktop client (including a Windows client and a macOS client), specifies whether to display the entry for the WUYING AI assistant in the floating ball on the cloud computer.'."\n" + ."\n" + .'> This feature is available only for desktop clients of V7.7 or later.', + 'enumValueTitles' => ['off' => 'does not display the entry', 'on' => 'displays the entry'], + 'type' => 'string', 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'example' => 'on', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'DesktopIds' => [ - 'description' => 'The IDs of the cloud computers for which you successfully configure the scheduled task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer for which you successfully configure the scheduled task.'."\n", - 'type' => 'string', - 'example' => '[\'ecd-c6u0eis7rnqfw****\']', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4638719F-3CAB-5704-BD54-55617BFF****', - ], + 'PolicyGroupId' => ['description' => 'The ID of the cloud computer policy.', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopIds\\": [\\n \\"[\'ecd-c6u0eis7rnqfw****\']\\"\\n ],\\n \\"RequestId\\": \\"4638719F-3CAB-5704-BD54-55617BFF****\\"\\n}","type":"json"}]', - 'title' => 'ModifyDesktopTimer', - 'summary' => 'Creates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule.', - ], - 'ModifyDesktopHostName' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'CreatePolicyGroup', + 'description' => 'A cloud computer policy is a set of rules for performance and security. These rules configure features such as local disk mapping, USB redirection, watermarks, and DNS control. For more information, see [Policy overview](~~189345~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-14T04:04:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T02:54:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-31T09:50:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-22T01:55:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-07T06:02:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreatePolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'CreateQosRule' => [ + 'summary' => 'Creates a QoS rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'NetworkPackageId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the premium bandwidth plan.', 'type' => 'string', 'required' => true, 'example' => 'np-cfedn7r2pe48g****', 'title' => ''], + ], + [ + 'name' => 'QosRuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the QoS rule.', 'type' => 'string', 'example' => 'Test', 'required' => true, 'title' => ''], + ], + [ + 'name' => 'Upload', + 'in' => 'query', + 'schema' => ['description' => 'The maximum upstream bandwidth. Unit: Mbps.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'Download', + 'in' => 'query', + 'schema' => ['description' => 'The maximum downstream bandwidth. Unit: Mbps.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'AuthDesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-sfasdfsddsat*****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud desktops to include in this rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NewHostName', + 'name' => 'AuthAndroidId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The new hostname of the cloud computer. The hostname must meet the following requirements:'."\n" - ."\n" - .'* The hostname must be 2 to 15 characters in length.'."\n" - .'* The hostname can contain only letters, digits, and hyphens (-). The hostname cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'NewName', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud phone.', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud phones to include in this rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'AuthDesktopGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy****', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'QosRuleId' => ['description' => 'The ID of the created QoS rule.', 'type' => 'string', 'example' => 'qos-5605u0gelk200****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyDesktopHostName', - 'summary' => 'Modifies the hostname of a Windows cloud computer in the Active Directory (AD) office network.', - 'description' => 'The Windows cloud computer whose hostname you want to modify must be in an AD office network. After the hostname is modified, the cloud computer is re-created.'."\n", - ], - 'ModifyCustomizedListHeaders' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateQosRule', + 'description' => 'Creates a QoS rule to manage network bandwidth for resources such as cloud desktops and cloud phones.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateQosRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateRAMDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DirectoryName', + 'in' => 'query', + 'schema' => ['description' => 'The directory name. The name must be 2 to 255 characters in length. It must start with a letter but cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => true, 'example' => 'testDirectoryName', 'title' => ''], + ], + [ + 'name' => 'EnableInternetAccess', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'Specifies whether to enable Internet access.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'ListType', + 'name' => 'EnableAdminAccess', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the list.'."\n" + 'description' => 'Specifies whether to grant the local administrator permissions to users that are authorized to use cloud computers in the office network.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* desktop: cloud computer'."\n" + .'* '."\n" + ."\n" + .' true'."\n" + ."\n" + .' '."\n" + ."\n" + .' (default)'."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'DesktopAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method in which the cloud computer is connected.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* VPC'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Internet (default)'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Any'."\n" ."\n" .' '."\n" ."\n" @@ -12666,894 +9621,768 @@ .' '."\n", 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'desktop' => '', + 'enumValueTitles' => ['VPC' => '', 'Internet' => '', 'Any' => ''], + 'example' => 'Internet', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The vSwitch IDs. You can configure only one vSwitch.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-uf62w3qzt4aigvlcb****', 'title' => ''], + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DirectoryId' => ['description' => 'The RAM directory ID.'."\n", 'type' => 'string', 'example' => 'dri-uf62w3qzt4aigvlcb****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'desktop', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'CreateRAMDirectory', + 'summary' => 'Creates a Resource Access Management (RAM) directory.', + 'description' => 'Before you create a RAM directory, complete the following preparations:'."\n" + ."\n" + .'* Call the `CreateVpc` operation to create a virtual private cloud (VPC) in a region supported by Elastic Desktop Service.'."\n" + .'* Call the `CreateVSwitch` operation to create a vSwitch in the VPC. The vSwitch is in a zone that is supported by Elastic Desktop Service. You can call the [DescribeZones](~~196648~~) operation to obtain the most recent zone list for a region supported by Elastic Desktop Service', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRAMDirectory'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DirectoryId\\": \\"dri-uf62w3qzt4aigvlcb****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'CreateSimpleOfficeSite' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Headers', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to get a list of regions that support Elastic Desktop Service (ECD).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CidrBlock', + 'in' => 'query', + 'schema' => ['description' => 'The IPv4 CIDR block for the office site\'s Virtual Private Cloud (VPC). This parameter is required for standard office sites. The system automatically creates a VPC based on the specified IPv4 CIDR block. Use one of the following CIDR blocks or their subnets:'."\n" + ."\n" + .'- `10.0.0.0/12` (The valid mask range is 12 to 24 bits.)'."\n" + ."\n" + .'- `172.16.0.0/12` (The valid mask range is 12 to 24 bits.)'."\n" + ."\n" + .'- `192.168.0.0/16` (The valid mask range is 16 to 24 bits.)', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/12', 'title' => ''], + ], + [ + 'name' => 'CenId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Cloud Enterprise Network (CEN) instance.'."\n" + ."\n" + .'> If you want to connect to cloud desktops over a VPC, attach the office site to the same CEN instance that is connected to your on-premises network by a VPN or an Express Connect circuit.', 'type' => 'string', 'required' => false, 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], + ], + [ + 'name' => 'CenOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that owns the CEN instance.'."\n" + ."\n" + .'- If you do not specify CenId, or if the CEN instance belongs to your Alibaba Cloud account, this parameter is not required.'."\n" + ."\n" + .'- If the CEN instance is owned by another Alibaba Cloud account, specify the ID of that account.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '118272523431****', 'title' => ''], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => ['description' => 'The verification code. If the CEN instance is owned by another Alibaba Cloud account, you must first call [SendVerifyCode](~~335132~~) to obtain a verification code.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => ['description' => 'The peak public bandwidth. Valid values: 10 to 200. Unit: Mbps.'."\n" + .'This parameter is valid only when `EnableInternetAccess` is set to `true`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the office site. The name must be 2 to 255 characters in length. It must start with a letter or a Chinese character, and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'TestOfficeSite_Simple', 'title' => ''], + ], + [ + 'name' => 'EnableInternetAccess', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable internet access.', + 'enumValueTitles' => ['true' => 'Internet access is enabled.', 'false' => 'Internet access is disabled. (Default)'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'EnableAdminAccess', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to grant users local administrator privileges on their cloud desktops.', + 'enumValueTitles' => ['true' => 'Grants local administrator privileges. (Default)', 'false' => 'Does not grant local administrator privileges.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'DesktopAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies how clients can connect to cloud desktops.'."\n" + ."\n" + .'> VPC connections rely on the Alibaba Cloud PrivateLink service, which is free of charge. If you set this parameter to `VPC` or `Any`, the system automatically enables the PrivateLink service.', + 'enumValueTitles' => ['VPC' => 'Clients can connect to cloud desktops only from within a VPC.', 'Internet' => 'Clients can connect to cloud desktops only over the internet. (Default)', 'Any' => 'Clients can connect to cloud desktops from either a VPC or the internet.'], + 'type' => 'string', + 'required' => false, + 'example' => 'Internet', + 'title' => '', + ], + ], + [ + 'name' => 'NeedVerifyZeroDevice', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable trusted device verification.', + 'enumValueTitles' => ['true' => 'Trusted device verification is enabled.', 'false' => 'Trusted device verification is disabled.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'VSwitchId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The headers.'."\n", + 'description' => 'The vSwitch ID. This parameter is required when you create a Cloud Box office site.', 'type' => 'array', - 'items' => [ - 'description' => 'The header.'."\n", - 'type' => 'object', - 'properties' => [ - 'HeaderKey' => [ - 'description' => 'The key of the header.'."\n" - ."\n" - .'> All header keys of the list must be specified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* desktop_id_name: the IDs and names of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* system_data_disk: the system disks and data disks of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* office_site_type: the office network types of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* create_time: the time when the cloud computers are created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ip: the IP addresses of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* spec_system_protocol: the instance types, OSs, and protocol types of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* monitor: the monitoring information of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* assigned_users: the number of end users that are assigned to the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* encryption: indicates whether the cloud computers are encrypted.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* office_site_id_name: the IDs and names of the office networks.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* pay_type: the billing methods of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* tag: the tags that are attached to the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* hostname: the hostnames of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* status: the statuses of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* current_user: the current end users of the cloud computers.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'desktop_id_name' => '', - 'system_data_disk' => '', - 'office_site_type' => '', - 'create_time' => '', - 'ip' => 'IP', - 'spec_system_protocol' => '', - 'monitor' => '', - 'assigned_users' => '', - 'encryption' => '', - 'office_site_id_name' => '', - 'pay_type' => '', - 'tag' => '', - 'host_name' => '', - 'status' => '', - 'current_user' => '', - ], - 'example' => 'pay_type', - ], - 'DisplayType' => [ - 'description' => 'The display type of the header.'."\n" - ."\n" - .'> For the desktop_id_name and office_site_id_name head keys, set the value of this parameter to required. For other header keys, set the value of this parameter to display or hide based on your requirements.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'hide' => '', - 'display' => '', - 'required' => '', - ], - 'example' => 'display', - ], - ], - 'required' => false, - ], + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'vsw-bp12mw1f8k3jgy****', 'title' => ''], 'required' => false, - 'maxItems' => 100, - 'minItems' => 1, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'CloudBoxOfficeSite', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Specifies whether to create a Cloud Box office site.', + 'enumValueTitles' => ['true' => 'Creates a Cloud Box office site.', 'false' => 'Creates a public office site.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyCustomizedListHeaders', - 'summary' => 'Modifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings.', - ], - 'MigrateDesktops' => [ - 'summary' => 'Migrates cloud computers from the current office network (formerly called workspace) to the new office network.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '128374', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'VpcType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The type of the office site.', + 'enumValueTitles' => ['standard' => 'A standard office site.', 'basic' => 'A basic office site.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', + 'required' => false, + 'example' => 'standard', + 'title' => '', ], ], [ - 'name' => 'TargetOfficeSiteId', + 'name' => 'AccountType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the destination office network.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen+dir-388505****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'AuthorityHost', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-39clsqyxr****', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ClientSecret', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Eid', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AccessAttribute', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E46DECEC-AC72-570E-958B-B52A4B****', - ], + 'OfficeSiteId' => ['description' => 'The office site ID.', 'type' => 'string', 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ChooseClusterError.ZoneId', - 'errorMessage' => 'Cannot choose zone, please try other zone.', - ], + ['errorCode' => 'NetworkSpace.VpcInfoExist', 'errorMessage' => 'vpc info already exist.', 'description' => 'Office network already exists for the corresponding VPC'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E46DECEC-AC72-570E-958B-B52A4B****\\"\\n}","type":"json"}]', - 'title' => 'MigrateDesktops', - ], - 'RenewDesktops' => [ - 'summary' => 'Renews monthly subscription cloud computers.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CreateSimpleOfficeSite', + 'summary' => 'Elastic Desktop Service (EDS) supports two types of accounts: convenience accounts and enterprise AD accounts. Use this API to create an office network (formerly a workspace) that uses convenience accounts.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-25T06:01:39.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-11-15T08:54:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSimpleOfficeSite'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateSimpleOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OfficeSiteId\\": \\"cn-hangzhou+os-c5cy7q578s8jc****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'CreateSnapshot' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The renewal duration. Valid values of this parameter are determined by the value of the `PeriodUnit` parameter.'."\n" - ."\n" - .'* Valid values if you set the `PeriodUnit` parameter to `Month`: 1, 2, 3, and 6'."\n" - .'* Valid values if you set the `PeriodUnit` parameter to `Year`: 1, 2, 3, 4, 5, and 6'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => true, 'example' => 'ecd-gx2x1dhsmucyy****"', 'title' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'SnapshotName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the snapshot. The name must be 2 to 127 characters in length. The name must start with a letter. The name can contain letters, digits, underscores (\\_), and hyphens (-). The name cannot start with `auto` because snapshots whose names start with auto are recognized as automatic snapshots.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'testSnapshotName', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the snapshot. The description can be up to 128 characters in length.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => 'testDescription', 'title' => ''], + ], + [ + 'name' => 'SourceDiskType', 'in' => 'query', 'schema' => [ - 'description' => 'The unit of the renewal duration specified by the `Period` parameter.'."\n" + 'description' => 'The type of the disk for which you want to create a snapshot.'."\n" ."\n" - .'Default value: Month. Valid values:'."\n" + .'Valid values:'."\n" ."\n" - .'* Month'."\n" + .'- system: system disk'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .'* Year'."\n" + .'- data: data disk'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n", + .' ', + 'enumValueTitles' => ['system' => '', 'data' => ''], 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', - ], - ], - [ - 'name' => 'AutoPay', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the auto-payment feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default): enables the auto-payment feature. Make sure that your account balance is sufficient. Otherwise, an abnormal order is generated.'."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated but you need to complete the payment. You can log on to the EDS console and complete the payment based on the order ID on the Orders page.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs. You can only renew monthly subscription cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID. You can only renew monthly subscription cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - ], 'required' => true, - 'example' => 'ecd-ia2zw38bi6cm7****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'PromotionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the promotional activity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '500030980150146', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => '> This field is not available for public use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the auto-renewal feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ResellerOwnerUid', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'example' => 'system', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The object returned.', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '20844399755****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'SnapshotId' => ['description' => 'The ID of the snapshot.', 'type' => 'string', 'example' => 's-2ze81owrnv9pity4****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20844399755****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\n 20844399755****\\n","errorExample":""}]', - 'title' => 'RenewDesktops', + 'title' => 'CreateSnapshot', + 'summary' => 'Create a snapshot for a disk of a cloud computer to back up or restore the data on the disk.', + 'description' => 'The cloud computer must be in the **Running** or **Stopped** state.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDesktops' => [ - 'summary' => 'Releases pay-as-you-go cloud computers or expired subscription cloud computers.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-02-05T01:54:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-22T06:30:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => true, - 'maxItems' => 200, - ], - ], + 'ramActions' => [ [ - 'name' => 'ResellerOwnerUid', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteDesktops', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SnapshotId\\": \\"s-2ze81owrnv9pity4****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\"\\n}","type":"json"}]', ], - 'DescribeDesktopMetadata' => [ - 'summary' => 'Queries the list and metadata of cloud computers in a specific region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTemplate' => [ + 'summary' => 'Creates a custom cloud computer template. A cloud computer template (or simply "template") simplifies the process of creating cloud computers by providing a predefined set of configurations. This eliminates the need to manually configure each setting, saving significant time and effort.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => ['description' => 'The template name. It must meet the following criteria:'."\n" + ."\n" + .'- It can be 2 to 126 characters in length.'."\n" + ."\n" + .'- It must begin with a letter and cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). Note: Periods (.) are not supported in the name.', 'type' => 'string', 'example' => 'My cloud desktop template 001', 'required' => true, 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'title' => ''], ], [ - 'name' => 'SearchRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The template description. It must meet the following criteria:'."\n" + ."\n" + .'- It can be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- It can contain letters, digits, and special characters, including spaces. Note: You can use carriage returns to break lines.', 'type' => 'string', 'example' => 'Design department template', 'maxLength' => 256, 'minLength' => 2, 'required' => false, 'title' => ''], ], [ - 'name' => 'OfficeSiteId', - 'in' => 'query', + 'name' => 'ProductType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The service type. Set the value to `CloudDesktop`.', + 'enumValueTitles' => ['CloudDesktop' => 'Cloud computers'], 'type' => 'string', + 'title' => '', 'required' => false, - 'example' => 'cn-hangzhou+dir-778418****', + 'example' => 'CloudDesktop', ], ], [ - 'name' => 'GroupId', - 'in' => 'query', + 'name' => 'BizType', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => '> This parameter is not publicly available.', + 'enumValueTitles' => [1 => 'The Enterprise edition.'], 'type' => 'string', + 'title' => '', 'required' => false, - 'example' => 'dg-i1ruuudp92qpj****', + 'example' => '1', ], ], [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'name' => 'SystemDiskSize', + 'in' => 'formData', + 'schema' => ['description' => 'The size of the system disk. Unit: GiB. Valid values: 40 to 500. Increments: 10 GiB.'."\n" + ."\n" + .'> The system disk size must be at least as large as the configured image size.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2040', 'minimum' => '40', 'title' => '', 'required' => false, 'example' => '80'], ], [ - 'name' => 'NextToken', - 'in' => 'query', + 'name' => 'SystemDiskPerformanceLevel', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The performance level (PL) of the system disk.'."\n" + ."\n" + .'> Only cloud computers of the Graphics or High Frequency type support Enterprise SSDs (ESSDs).', + 'enumValueTitles' => ['PL1' => 'A PL1 ESSD.', 'PL0' => 'A PL0 ESSD.', 'AutoPL' => 'An AutoPL ESSD.'], 'type' => 'string', 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'example' => 'AutoPL', + 'title' => '', ], ], [ - 'name' => 'Keyword', - 'in' => 'query', + 'name' => 'DataDiskList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The data disks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => ['description' => 'The size of the data disk. Unit: GiB. Valid values: 40 to 2040. Increments: 10 GiB.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The larger the ESSD disk capacity, the higher the available PL (for example, PL2 is available for disks larger than 460 GiB). A higher PL comes with a higher cost. Select an ESSD based on your specific needs.'."\n" + ."\n" + .'>', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2040', 'minimum' => '20', 'required' => false, 'example' => '40', 'title' => ''], + 'PerformanceLevel' => [ + 'description' => 'The PL of the data disk. Default value: `AutoPL`.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'AutoPL', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'ecd', - 'maxLength' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CreationTimeStart', - 'in' => 'query', + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'desktopimage-windows-server-2022-64-asp'], + ], + [ + 'name' => 'DefaultLanguage', + 'in' => 'formData', + 'schema' => ['description' => 'The default language of cloud computers during startup. This parameter takes effect only when cloud computers are created from system images.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'zh-CN'], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the policy group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pg-8hlryfn331******'], + ], + [ + 'name' => 'TimerGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the scheduled task group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-4knxmfneq1e******', 'title' => ''], + ], + [ + 'name' => 'ResourceTagList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The tags added to cloud computers. Specify tags in key-value pairs. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'design', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '2025-01-01T12:00:00Z', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OperationTimeStart', - 'in' => 'query', + 'name' => 'RegionConfigList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The regions of the template. You can create cloud computers by using a template only within the same region as the template itself.'."\n" + ."\n" + .'> You can specify up to 20 regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'SnapshotPolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => false, 'example' => 'sp-35fvn8m21pnx2****', 'title' => ''], + 'ResourceInstanceType' => ['description' => 'The ID of the cloud computer type.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g', 'title' => ''], + 'VolumeEncryptionEnable' => [ + 'description' => 'Specifies whether to enable disk encryption.', + 'enumValueTitles' => ['false' => '(Default) Disables disk encryption.', 'true' => 'Enables disk encryption.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + 'VolumeEncryptionKey' => ['description' => 'The ID of the Key Management Service (KMS) key that you want to use to encrypt disks. You can call the [](t22712.xdita#)operation to query KMS keys.', 'type' => 'string', 'required' => false, 'example' => 'a7b3c0c8-b3a2-4876-b1cc-*********', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-709******', 'title' => ''], + 'SubnetId' => ['description' => 'The subnet ID.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1yiu**********', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '2025-01-01T12:00:00Z', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IncludeDesktopGroup', - 'in' => 'query', + 'name' => 'SiteConfigList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'boolean', + 'description' => 'The site configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => 'The site ID.', + 'enumValueTitles' => ['outside_mainland' => 'Outside the Chinese mainland.', 'mainland' => 'Chinese mainland.'], + 'type' => 'string', + 'required' => false, + 'example' => 'mainland', + 'title' => '', + ], + 'AppRuleId' => ['description' => 'The application control policy ID.', 'type' => 'string', 'required' => false, 'example' => 'bwr-5a5371e0db954d********', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'false', - 'default' => 'false', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageId', - 'in' => 'query', + 'name' => 'ChargeType', + 'in' => 'formData', 'schema' => [ - 'description' => '', 'type' => 'string', + 'enum' => ['PostPaid', 'PrePaid'], + 'description' => '', 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopIds', - 'in' => 'query', - 'style' => 'repeatList', + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '6', 'minimum' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'formData', 'schema' => [ + 'type' => 'string', + 'enum' => ['Month', 'Year', 'Week'], 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-84mztzatmipf2****', - ], 'required' => false, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'HostName', - 'in' => 'query', + 'name' => 'AutoPay', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserDuration', + 'in' => 'formData', 'schema' => [ - 'title' => '主机名称', + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['120', '250', '360'], 'description' => '', - 'type' => 'string', 'required' => false, - 'example' => 'ASW-2F-SRV-YXYZ-4.SHPTG', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PostPaidAfterUsedUp', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'PlainResult', + 'description' => 'The response elements.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Desktops' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-11-06T08:28Z', - ], - 'LocalName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'OfficeSiteId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'ChargeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'PostPaid', - ], - 'DesktopName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testDesktopName', - ], - 'DesktopId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'DesktopGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'dg-3uiojcc0j4kh7****', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2020-11-06T08:31Z', - ], - 'DesktopStatus' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Running', - ], - 'ExpiredTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], - 'ImageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'm-4zfb6zj728hhr****', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg-f3s3dgt8dtb0vlqc8', - ], - 'ResourceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'serverless_new', - ], - 'ManagementFlags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '["NoFlag"]', - ], - ], - 'DesktopType' => [ - 'type' => 'string', - ], - 'MemberEniIp' => [ - 'type' => 'string', - ], - 'Platform' => [ - 'type' => 'string', - ], - ], - ], - ], + 'Data' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'b-0cc7rx533*****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The creation result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '791CC0D3-1A38-573B-8F5F-********', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"LocalName\\": \\"华东2（上海）\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"serverless_new\\",\\n \\"ManagementFlags\\": [\\n \\"[\\\\\\"NoFlag\\\\\\"]\\"\\n ],\\n \\"DesktopType\\": \\"\\",\\n \\"MemberEniIp\\": \\"\\",\\n \\"Platform\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDesktopMetadata', - ], - 'DescribeUsersPassword' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"b-0cc7rx533*****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"791CC0D3-1A38-573B-8F5F-********\\"\\n}","type":"json"}]', + 'title' => 'CreateTemplate', + 'description' => 'When you call this operation, take note of the following item:'."\n" + ."\n" + .'- Most parameters in templates are optional. When you create a template, Elastic Desktop Service (EDS) does not validate the existence or correctness of the parameter values you specify. The parameter values in the template are only verified when you use the template to create cloud computers.'."\n" + ."\n" + .'- For parameters that include the region attribute in the template, it\'s important to note that if the specified region doesn\'t match the region where the template is used to create a cloud computer, those parameters will not take effect.', + 'changeSet' => [ + ['createdAt' => '2025-12-25T06:33:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DeleteAutoSnapshotPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'PolicyId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the automatic snapshot policies that you want to delete.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the automatic snapshot policies that you want to delete. You can specify 1 to 100 IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sp-424g04y887d9e****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'ecd-gq8u6whi9f6k8****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -13562,155 +10391,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F7B4B17B-5C8A-514C-AA4D-F8090E3A63E9', - ], - 'DesktopUsers' => [ - 'description' => 'The authorized users of the cloud computer.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the user.'."\n", - 'type' => 'object', - 'properties' => [ - 'DisplayName' => [ - 'description' => 'The display name of the end user.'."\n", - 'type' => 'string', - 'example' => 'alice_1365*****', - ], - 'Password' => [ - 'description' => 'The password of the end user.'."\n", - 'type' => 'string', - 'example' => 'tes123', - ], - 'EndUserId' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7B4B17B-5C8A-514C-AA4D-F8090E3A63E9\\",\\n \\"DesktopUsers\\": [\\n {\\n \\"DisplayName\\": \\"demo_user01_1488****\\",\\n \\"Password\\": \\"3q8p-NDey-2Nac-TWcQ-****\\",\\n \\"EndUserId\\": \\"demo_user01\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeUsersPassword', - 'summary' => 'Queries the passwords for the accounts within a cloud computer image. For example, when the Chrome browser on the cloud computer queries the cached password, it requires the end user to enter the password for identity verification.', - ], - 'GetConnectionTicket' => [ - 'summary' => 'Obtains the credential that is used to connect to a cloud desktop.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', + 'title' => 'DeleteAutoSnapshotPolicy', + 'summary' => 'Deletes an automatic snapshot policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'], + ], ], + 'ramActions' => [], + ], + 'DeleteBundles' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'BundleId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computer templates. You can specify 1 to 100 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b-cezrnfgecbich****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'b-cezrnfgecbich****', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the end user of the cloud computer. The end user must be the current end user of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A5CDCED9-54D4-457C-917D-3F2A783CDA1E\\r\\n","errorExample":""}]', + 'title' => 'DeleteBundles', + 'summary' => 'Deletes custom cloud computer templates.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBundles'], + ], + ], + 'ramActions' => [], + ], + 'DeleteCdsFile' => [ + 'summary' => 'Delete files or folders from the network disk.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Password', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the current end user of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Ab123456', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer connection task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da', - ], + 'schema' => ['description' => 'The ID of the user who uses the network disk.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer for which you want to generate a connection credential. This parameter is required.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => 'The ID of the enterprise drive.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-066224****', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', - ], + 'schema' => ['description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', 'title' => ''], ], [ - 'name' => 'CommandContent', + 'name' => 'GroupId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The command that you want to run to configure a custom application in user mode. After you obtain the credential, the application is automatically started. Parameter description in the command:'."\n" - ."\n" - .'* appPath: the path of the application startup file. Example: `"C:\\\\Program Files (x86)\\\\000\\\\000.exe"`. Use double slashes (\\\\\\) as the delimiter. Type of the parameter value: string.'."\n" - .'* appParameter: the startup arguments of the application. Example: `"meetingid 000 meetingname aaa"`. Separate multiple arguments with spaces. Type of the parameter value: string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "startApplication": {'."\n" - .' "startApplicationList": ['."\n" - .' {'."\n" - .' "sessionName": "",'."\n" - .' "appList": ['."\n" - .' {'."\n" - .' "appPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe",'."\n" - .' "appParameter": "www.example.com www.example1.com"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], + 'schema' => ['description' => 'The ID of the team space.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], ], ], 'responses' => [ @@ -13718,718 +10512,441 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'TaskStatus' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FAILED: The credential fails to be obtained.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* RUNNING: The credential is being obtained.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CC5E450-FC43-4F5B-B540-9964BD31****', 'title' => ''], + 'Code' => ['description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n" ."\n" - .' '."\n" + .'Valid value:'."\n" ."\n" - .'* FINISHED: The credential is obtained.'."\n" + .'- true'."\n" ."\n" - .' '."\n" + .'- false', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Indicates whether the data is returned.'."\n" ."\n" - .' '."\n" + .'Valid value:'."\n" ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '', - 'RUNNING' => '', - 'FINISHED' => '', - ], - 'example' => 'FINISHED', - ], - 'Ticket' => [ - 'description' => 'The credentials for connecting to the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - 'TaskId' => [ - 'description' => 'The ID of the cloud computer connection task.'."\n", - 'type' => 'string', - 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', - ], - 'TaskCode' => [ - 'description' => 'Before you use the credential, you must Base64 decode the content of the credential, save the credential as an xxx.ica file, and then open the file. Python sample code:'."\n" + .'- true'."\n" ."\n" - .' import base64'."\n" - .' response = {'."\n" - .' "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",'."\n" - .' "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",'."\n" - .' }'."\n" - .' f = open (\'xxx.ica\', \'w\')'."\n" - .' out = base64.b64decode(response[\'Ticket\'])'."\n" - .' f.write(out)'."\n" - .' f.close()'."\n", + .'- false', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - 'TaskMessage' => [ - 'description' => 'The ID of the connection task.'."\n", - 'type' => 'string', - 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', + 'example' => 'true', + 'title' => '', ], + 'Message' => ['description' => 'Error message. This parameter is not returned if the value of Code is `success`.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n}","type":"json"}]', - 'title' => 'GetConnectionTicket', - 'description' => 'The cloud computer must be in the Running state. The ticket obtained by calling this operation will expire in 10 minutes.'."\n", - ], - 'DescribeGuestApplications' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteCdsFile', + 'changeSet' => [ + ['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCdsFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DeleteCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD31****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteCenterPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- app: cloud applications.'."\n" + ."\n" + .'- desktop: cloud computers.', + 'enumValueTitles' => ['app' => '', 'desktop' => ''], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'docRequired' => false, + 'example' => 'desktop'."\n", + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', + 'description' => 'The business type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- 1: public cloud.'."\n" + ."\n" + .'- 8: commercial edition.', + 'enumValueTitles' => [1 => '', 8 => ''], + 'type' => 'integer', + 'format' => 'int32', 'required' => true, - 'docRequired' => true, - 'example' => 'ecd-asw3giklqvfqe****', + 'docRequired' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'EndUserId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', + 'description' => 'The policy IDs.', + 'type' => 'array', + 'items' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'demo001', + 'docRequired' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '272CF39E-B5DE-5BE3-A09B-B43F1026****', - ], - 'Applications' => [ - 'description' => 'The applications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The application.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplicationName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'Google Chrome', - ], - 'ApplicationVersion' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'example' => '115.0.5790.110', - ], - 'ProcessPath' => [ - 'description' => 'The path to the process.'."\n", - 'type' => 'string', - 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\ch****.exe', - ], - 'Pid' => [ - 'description' => 'The process ID (PID).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1357', - ], - 'CpuPercent' => [ - 'description' => 'The CPU utilization (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '89', - ], - 'MemPercent' => [ - 'description' => 'The memory utilization (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '34', - ], - 'GpuPercent' => [ - 'description' => 'The GPU utilization (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '15', - ], - 'IoSpeed' => [ - 'description' => 'The I/O read and write performance. Unit: byte/s.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '124906.0', - ], - 'IconUrl' => [ - 'description' => 'The icon URL of the application.'."\n", - 'type' => 'string', - 'example' => 'https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png', - ], - 'Status' => [ - 'description' => 'The status of the application.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Idle: The application is installed in the cloud computer but is not running.'."\n" - .'* Running: The application has been installed in the cloud computer and is running.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Idle' => '', - 'Running' => '', - ], - 'example' => 'Running', - ], - 'ProcessData' => [ - 'description' => 'The processes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplicationName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'Google Chrome', - ], - 'ApplicationVersion' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'example' => '115.0.5790.110', - ], - 'ProcessPath' => [ - 'description' => 'The path to the process.'."\n", - 'type' => 'string', - 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\ch****.exe', - ], - 'Pid' => [ - 'description' => 'The PID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1357', - ], - 'CpuPercent' => [ - 'description' => 'The CPU utilization (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '89', - ], - 'MemPercent' => [ - 'description' => 'The memory usage (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '34', - ], - 'GpuPercent' => [ - 'description' => 'The GPU usage (%).'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '15', - ], - 'Iospeed' => [ - 'description' => 'The I/O read and write performance. Unit: byte/s.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '124906.0', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"272CF39E-B5DE-5BE3-A09B-B43F1026****\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationName\\": \\"Google Chrome\\",\\n \\"ApplicationVersion\\": \\"115.0.5790.110\\",\\n \\"ProcessPath\\": \\"C:\\\\\\\\\\\\\\\\Program Files\\\\\\\\\\\\\\\\Google\\\\\\\\\\\\\\\\Chrome\\\\\\\\\\\\\\\\Application\\\\\\\\\\\\\\\\chrome.exe\\",\\n \\"Pid\\": 1357,\\n \\"CpuPercent\\": 0,\\n \\"MemPercent\\": 1.8368155,\\n \\"GpuPercent\\": 0,\\n \\"IoSpeed\\": 8919266,\\n \\"IconUrl\\": \\"https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png\\",\\n \\"Status\\": \\"Running\\",\\n \\"ProcessData\\": [\\n {\\n \\"ApplicationName\\": \\"Google Chrome\\",\\n \\"ApplicationVersion\\": \\"115.0.5790.110\\",\\n \\"ProcessPath\\": \\"C:\\\\\\\\\\\\\\\\Program Files\\\\\\\\\\\\\\\\Google\\\\\\\\\\\\\\\\Chrome\\\\\\\\\\\\\\\\Application\\\\\\\\\\\\\\\\chrome.exe\\",\\n \\"Pid\\": 1357,\\n \\"CpuPercent\\": 0,\\n \\"MemPercent\\": 1.8368155,\\n \\"GpuPercent\\": 0,\\n \\"Iospeed\\": 8919266\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeGuestApplications', - 'summary' => 'Queries the applications and their processes of an end user.', - ], - 'ModifyUserEntitlement' => [ - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DeleteCenterPolicy', + 'summary' => 'Deletes a global policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DeleteCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\"\\n}","type":"json"}]', + ], + 'DeleteCloudDriveGroups' => [ + 'summary' => 'Deletes team spaces.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AuthorizeDesktopId', + 'name' => 'CdsId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers to which you want to add end users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer to which you want to add end users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****', 'title' => ''], ], [ - 'name' => 'RevokeDesktopId', + 'name' => 'GroupId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers whose end users you want to remove.'."\n", + 'description' => 'The IDs of the teams that you want to delete. You can delete multiple teams at a time.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer whose end users you want to remove.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-j45qtb0eh91yg****', - ], + 'items' => ['description' => 'The ID of the team.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], 'required' => false, 'docRequired' => true, - 'maxItems' => 100, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Code' => ['description' => 'The result of the operation. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true: The request is successful. false: The request fails.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'title' => '', ], + 'Data' => ['description' => 'The data information.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'Message' => ['description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyUserEntitlement', - 'summary' => 'Grants permissions on cloud desktops to end users, or revokes the permissions from the end users.', - 'description' => 'You can modify end users only for cloud computers that are in the Running state.'."\n", - ], - 'ModifyEntitlement' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DeleteCloudDriveGroups', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveGroups'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteCloudDriveUsers' => [ + 'summary' => 'Delete the personal drive of a user in WUYING Workspace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID. You can invoke [DescribeRegions](~~196646~~) to obtain the list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], + 'schema' => ['description' => 'WUYING Workspace ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-64326*****', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The username IDs. End users specified by this parameter become the end users of the cloud computer, and the original end users of the cloud computer are removed. You can specify 1 to 100 IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The username ID of an end user.'."\n" - ."\n" - .'* For a convenience user, set the value to the username of the convenience user.'."\n" - .'* For an Active Directory (AD) user, set the value to the sAMAccountName value of the AD user.'."\n" - ."\n" - .'> If you do not specify this parameter, all original end users of the cloud computer are removed and the cloud computer is not assigned to end users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ModifyEntitlement', - ], + 'items' => ['description' => 'End user ID.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'example' => 'alice', + 'docRequired' => true, 'maxItems' => 100, + 'description' => 'List of end user IDs.', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EAEFFE4B-E87B-5F76-B165-9248F377****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8F851208-C0EA-4CDD-9074-DBE70CB430DA\\n","errorExample":""}]', - 'title' => 'ModifyEntitlement', - 'summary' => 'Assigns a cloud computer to end users and removes all original end users of the cloud computer.', - 'description' => '* The cloud computer must be in the Running state.'."\n" - .'* After you call this operation, the assignment result is immediately returned. You can call the [DescribeDesktops](~~436815~~) operation to query the assignment of the cloud computer. The value of the `ManagementFlags` response parameter indicates the assignment of the cloud computer. A value of `ASSIGNING` indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.'."\n" - .'* We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'BatchModifyEntitlement' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAEFFE4B-E87B-5F76-B165-9248F377****\\"\\n}","type":"json"}]', + 'title' => 'Delete User Personal Drive', + 'changeSet' => [ + ['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveUsers'], + ], ], + 'ramActions' => [], + ], + 'DeleteConfigGroup' => [ + 'summary' => 'Deletes a configuration group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region. Call the DescribeRegions operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'description' => 'The ID of the region. Set the value to `cn-shanghai`.', + 'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'MaxUserPerDesktop', + 'name' => 'GroupIds', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of users assigned to each cloud computer.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of the configuration groups that you want to delete.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the configuration group that you want to delete.', 'type' => 'string', 'required' => false, 'example' => 'ccg-0cpaegmjioo7*****', 'title' => ''], 'required' => false, - 'docRequired' => true, - 'maximum' => '500', - 'example' => '1', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MaxDesktopPerUser', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of cloud computers allocated to each user.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '500', - 'example' => '0', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteConfigGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Strategy', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The disproportional assignment policy. Valid values:'."\n" - ."\n" - .'AVERAGE: The system preferentially guarantees that each user is assigned with at least a cloud computer. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned a cloud computer.'."\n" - ."\n" - .'CENTRAL: The system preferentially assigns the designated number of cloud computers to each user. If the number of selected cloud computers cannot be proportionally assigned to the selected users, ensure that each user is assigned the specified number of cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'AVERAGE' => 'AVERAGE', - 'CENTRAL' => 'CENTRAL', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DeleteConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'AVERAGE', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', + ], + 'DeleteDesktopGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ [ - 'name' => 'DesktopId', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers for which you want to modify end users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer for which you want to modify end users.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****'."\n", - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'Region ID. Call [DescribeRegions](~~196646~~) to query the list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice'."\n", - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'Shared desktop group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'Preview', + 'name' => 'ResellerOwnerUid', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Whether to preview the assign results instead of actually assigning cloud computers.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Collection of returned information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'Entitlements' => [ - 'description' => 'The results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The result.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FAILED'."\n" - .'* NOT_STARTED'."\n" - .'* STARTED'."\n" - .'* PROCESSING'."\n" - .'* FINISHED'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => 'FAILED', - 'NOT_STARTED' => 'NOT_STARTED', - 'STARTED' => 'STARTED', - 'PROCESSING' => 'PROCESSING', - 'FINISHED' => 'FINISHED', - ], - 'example' => 'FINISHED', - ], - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => 'B2F4F018-0EDF-159C-B285-117B5F1C****', - ], - 'AssignModels' => [ - 'description' => 'The assignment results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-e94kzikmpljjx99pl', - ], - 'InnerStatus' => [ - 'description' => 'The assign result for each cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FAILED'."\n" - .'* NOT_STARTED'."\n" - .'* STARTED'."\n" - .'* PROCESSING'."\n" - .'* FINISHED'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => 'FAILED', - 'NOT_STARTED' => 'NOT_STARTED', - 'STARTED' => 'STARTED', - 'PROCESSING' => 'PROCESSING', - 'FINISHED' => 'FINISHED', - ], - 'example' => 'FINISHED', - ], - 'EndUserIds' => [ - 'description' => 'The authorized user IDs for the cloud computer.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The authorized user ID for the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Entitlements\\": {\\n \\"Status\\": \\"FINISHED\\",\\n \\"TaskId\\": \\"B2F4F018-0EDF-159C-B285-117B5F1C****\\",\\n \\"AssignModels\\": [\\n {\\n \\"DesktopId\\": \\"ecd-e94kzikmpljjx99pl\\",\\n \\"InnerStatus\\": \\"FINISHED\\",\\n \\"EndUserIds\\": [\\n \\"Alice\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'BatchModifyEntitlement', - 'summary' => 'Assigns multiple cloud computers to users in a batch.', - 'description' => '* The cloud computers for which you want to change their policies must be in the Running state.'."\n" - .'* After you call this operation, the assignment result is immediately returned. You can call the [DescribeDesktops](~~436815~~) operation to query the assignment of the cloud computer. The value of the `ManagementFlags` response parameter indicates the assignment of the cloud computer. A value of `ASSIGNING` indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.'."\n" - .'* We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.'."\n", - ], - 'CreateDesktopGroup' => [ - 'summary' => 'Creates a shared group.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteDesktopGroup', + 'summary' => 'Release a shared cloud computer.', + 'description' => '- Before you call this operation, make sure that the shared desktop group contains no connected desktops or authorized users.'."\n" + ."\n" + .'- You cannot delete a subscription desktop group if the subscription desktops in the group have not expired.'."\n" + ."\n" + .'- If you delete a pay-as-you-go desktop group, the pay-as-you-go desktops in the group are also released.', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-07T09:08:49.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktopGroup'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14437,950 +10954,1249 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'BundleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'b-je9hani001wfn****', - ], + 'schema' => ['description' => 'The region ID. Call [](t2167755.xdita#)to get a list of regions that Elastic Desktop Service (EDS) supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', + 'description' => 'A list of 1 to 100 cloud computer IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'ResellerOwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'pg-9c2d6t2dwflqr****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - [ - 'name' => 'DesktopGroupName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the shared group. The name can be up to 30 characters in length and can contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-). It must start with a letter but cannot start with `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'desktopGroupName1', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the directory.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hide', - ], + ], + 'title' => 'DeleteDesktops', + 'summary' => 'Releases one or more pay-as-you-go or expired subscription cloud computers.', + 'changeSet' => [ + ['createdAt' => '2025-09-28T09:09:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktops'], ], + ], + 'ramActions' => [ [ - 'name' => 'ScaleStrategyId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scaling policy.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hide', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteDevices' => [ + 'summary' => 'Deletes trusted devices.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'VpcId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'hide', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'DefaultInitDesktopCount', + 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The default number of cloud computers that you want to create at the same time in the shared group. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", + 'type' => 'string', 'required' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '1', + 'enumValueTitles' => [], + 'example' => 'cn-hangzhou', + 'title' => '', ], ], [ - 'name' => 'KeepDuration', + 'name' => 'DeviceIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The duration for which each session remains active after disconnection. Valid values: 180000 (3 minutes) to 345600000 (4 days). Unit: milliseconds. If you set this parameter to 0, the session is permanently retained after disconnection.'."\n" - ."\n" - .'When a session is disconnected, take note of the following items: 1. If the end user does not resume the session within the specified duration, the session will close, and all unsaved data will be cleared. 2. If the end user resumes the session within the specified duration, the session data will remain accessible for continued use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '6000', + 'description' => 'The IDs of the devices. You can specify up to 200 IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The serial number (SN) of the hardware client or the UUID of the software client.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '5F52817BE267A43C608D245070D2****', + 'title' => '', + ], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ChargeType', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The billing method of the shared group.'."\n" + 'description' => 'The type of the client.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* PostPaid: pay-as-you-go.'."\n" - .'* PrePaid: subscription.'."\n", - 'type' => 'string', + .'* 1: hardware client.'."\n" + .'* 2: software client.'."\n", + 'type' => 'integer', + 'format' => 'int32', 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', + 'enumValueTitles' => [1 => '', ''], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'Period', + 'name' => 'Force', 'in' => 'query', 'schema' => [ - 'description' => 'The subscription duration of the shared group. This parameter is required if you set `ChargeType` to `PrePaid`. You must specify the subscription duration unit by using `PeriodUnit`.'."\n" - ."\n" - .'* If you set `PeriodUnit` to `Month`, valid values of this parameter:'."\n" - ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 6'."\n" + 'description' => 'Specifies whether to forcefully delete the device if the device is bound to a user.'."\n" ."\n" - .'* If you set `PeriodUnit` to `Year`, valid values of this parameter:'."\n" + .'Valid values:'."\n" ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 4'."\n" - .' * 5'."\n", + .'* 0: do not forcefully delete the device.'."\n" + .'* 1: forcefully delete the device.'."\n", 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + 'required' => true, + 'enumValueTitles' => ['', ''], + 'example' => '0', + 'title' => '', ], ], - [ - 'name' => 'PeriodUnit', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unit of the subscription duration.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', + 'title' => 'Schema of Response', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2AF861B4-0ECC-130C-B100-21A01E02****'], ], - 'example' => 'Month', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AF861B4-0ECC-130C-B100-21A01E02****\\"\\n}","type":"json"}]', + 'title' => 'DeleteDevices', + 'requestParamsDescription' => 'The clientType and DeviceIds parameters are required.'."\n", + 'responseParamsDescription' => 'No other special parameters are available.'."\n", + 'extraInfo' => 'None.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevices'], + ], + ], + 'ramActions' => [], + 'description' => 'You can call the operation to manage client devices.'."\n", + ], + 'DeleteDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OwnType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session type of the shared group.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: single-session.'."\n" - .'* 1: multi-session.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'AutoPay', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to automatically complete the payment for subscription orders.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Comments', + 'name' => 'DirectoryId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The remarks of the shared group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', + 'description' => 'The directory IDs. You can specify one or more directory IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The directory ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'required' => true, + 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'MinDesktopsCount', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The minimum number of subscription cloud computers that can be automatically provisioned at the same time in the shared group. This parameter is required if you set `ChargeType` to `PrePaid`. Default value: 1. Valid values: 0 to `MaxDesktopsCount`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '1', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '5CC5E450-FC43-4F5B-B540-9964BD313427', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD313427\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]', + 'title' => 'DeleteDirectories', + 'summary' => 'Deletes one or more directories.', + 'description' => 'You cannot delete a directory that has a cloud computer or is used by a cloud computer.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDirectories'], + ], + ], + 'ramActions' => [], + ], + 'DeleteDrive' => [ + 'summary' => 'Deletes a drive.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'MaxDesktopsCount', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of pay-as-you-go cloud computers that can be automatically provisioned at the same time in the shared group. Valid values: 0 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '50', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AllowAutoSetup', + 'name' => 'DriveId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the user-level storage resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dri-aaaa****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable batch-based automatic creation of subscription cloud computers for the shared group. This parameter is required if you set `ChargeType` to `PrePaid`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: enables batch-based automatic creation of subscription cloud computers.'."\n" - .'* 1: disables batch-based automatic creation of subscription cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1', - 'minimum' => '0', - 'enumValueTitles' => [ - '', - '', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B7AA****'], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code. The value 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the delete operation was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'example' => '1', + 'example' => '', ], ], + ], + 'title' => 'DeleteDrive', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDrive'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'DeleteImages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AllowBufferCount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of pay-as-you-go cloud computers that can be reserved in the shared group. This parameter is required if you set `ChargeType` to `PostPaid`. Valid values:'."\n" - ."\n" - .'* 0: does not reserve any cloud computers.'."\n" - .'* N: reserves N cloud computers (1≤ N ≤ 100).'."\n" - ."\n" - .'> Setting this parameter to 0 means no cloud computers will be reserved in the shared group. In this case, the system must create, start, and assign cloud computers to end users upon request, which can be time-consuming. To improve user experience, we recommend that you reserve a specific number of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '1', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token 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](~~25693~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserIds', + 'name' => 'ImageId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the end users.'."\n", + 'description' => 'The image IDs. You can specify 1 to 100 image IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => false, - 'maxItems' => 1000, + 'items' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResetType', + 'name' => 'DeleteCascadedBundle', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to delete the associated template.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The reset option of the shared group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: Reset is not required.'."\n" - .'* 1: Only the system disk is reset.'."\n" - .'* 2: Only the data disk is reset.'."\n" - .'* 3: Both the system disk and the data disk are reset.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - '', - '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => '0', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeleteImages', + 'summary' => 'Deletes one or more custom images.', + 'description' => '- Images include system images and custom images. System images cannot be deleted.'."\n" + ."\n" + .'- If an image that you want to delete is referenced by a cloud computer template, call the [DeleteBundles](~~436972~~) operation to delete the cloud computer template before you delete the image.', + 'changeSet' => [ + ['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteImages'], + ], + ], + 'ramActions' => [ [ - 'name' => 'LoadPolicy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The load balancing policy of the multi-session shared group.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: depth-first'."\n" - .'* 1: breadth first'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - '', - '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => '0', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteNASFileSystems' => [ + 'summary' => 'Deletes NAS file systems.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BindAmount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of concurrent sessions of the multi-session shared group.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Classify', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the cloud computers in the shared group.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* teacher: cloud computers designed for teachers.'."\n" - .'* student: cloud computers designed for students.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'teacher' => '', - 'student' => '', - ], - 'example' => 'teacher', - ], + 'schema' => ['description' => 'The region ID of the NAS file system that you want to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AllClassifyUsers', + 'name' => 'FileSystemId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The types of the users.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'Alice', + 'description' => 'The IDs of the NAS file systems that you want to delete.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the NAS file system that you want to delete.', 'type' => 'string', 'required' => false, 'example' => '04f314****', 'title' => ''], + 'required' => true, + 'example' => '04f314****', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'VolumeEncryptionEnabled', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'description' => 'The object that is returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeleteNASFileSystems', + 'description' => 'Before you delete a File Storage NAS (NAS) file system, make sure that the data you want to retain is backed up.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'If a NAS file system is deleted, data stored in the NAS file system cannot be restored. Proceed with caution when you delete NAS file systems.'."\n" + ."\n" + .'>', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNASFileSystems'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VolumeEncryptionKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that you want to use when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to obtain a list of KMS keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteNASFileSystems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteNetworkPackages' => [ + 'summary' => 'You can delete one or more public network premium bandwidth allocations.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RatioThreshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for the ratio of connected sessions. This parameter defines the condition that activates automatic scaling of cloud computers in a multi-session shared group. The ratio of connected sessions is calculated by using the following formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`.'."\n" - ."\n" - .'If the connected session ratio exceeds the specified threshold, new cloud computers are provisioned. If the ratio falls below the threshold, idle cloud computers are deleted.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ [ - 'name' => 'ConnectDuration', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration for which each session remains connected. The session is automatically disconnected once the specified maximum time limit is reached. Unit: milliseconds. Valid values: 900000 to 345600000. That is, the session can be connected for 15 to 5,760 minutes (4 days).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300000', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to obtain a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'IdleDisconnectDuration', + 'name' => 'NetworkPackageId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The duration after which a session is terminated if no keyboard or mouse activity is detected. When an end user connects to a cloud computer, a session is initiated. If no input from the keyboard or mouse is detected within this specified timeframe, the session is automatically closed. Unit: milliseconds. Valid values: 360000 to 3600000 (6 minutes to 60 minutes)'."\n" - ."\n" - .'The system prompts end users to save their data 30 seconds before a session is disconnected. To avoid data loss, end users must save their session data upon receiving the prompt.'."\n" - ."\n" - .'> This parameter is suitable only for cloud computers whose image version is v1.0.2 or later.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300000', + 'description' => 'List of public network premium bandwidth IDs. You can specify one or more IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Internet premium bandwidth.', 'type' => 'string', 'required' => false, 'example' => 'np-amtp8e8q1o9e4****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StopDuration', + 'name' => 'ResellerOwnerUid', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum period of inactivity allowed before a cloud computer is automatically stopped. If the idle duration reaches the specified limit, the system stops the cloud computer. When an end user reconnects to the stopped cloud computer, it automatically restarts. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300000', + 'description' => 'The returned object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeleteNetworkPackages', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPackages'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteOfficeSiteAccelerator' => [ + 'summary' => 'Deletes a Global Accelerator (GA) configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ProfileFollowSwitch', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable user data roaming.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ [ - 'name' => 'FileSystemId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the File Storage NAS (NAS) file system for the user data roaming feature.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04f314****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'BuyDesktopsCount', + 'name' => 'OfficeSiteId', 'in' => 'query', + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-885351****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '* For shared subscription groups, this parameter defines the initial number of cloud computers to be created. Valid values: 0 to 200.'."\n" - .'* For shared pay-as-you-go groups, this parameter defines the minimum initial number of cloud computers to be created. Valid values: 0 to `MaxDesktopsCount`. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'EE9472BC-0B5D-5458-85CD-C52BDD******'], + ], + 'title' => '', + 'description' => 'The response elements.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteOfficeSiteAccelerator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE9472BC-0B5D-5458-85CD-C52BDD******\\"\\n}","type":"json"}]', + ], + 'DeleteOfficeSites' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the shared group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'AutoRenew', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto-renewal for the shared subscription group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'OfficeSiteId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags. You can specify up to 20 tags.'."\n", + 'description' => 'The IDs of the office networks. You can specify 1 to 100 office networks.', 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, + 'items' => ['description' => 'The ID of the office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'required' => true, + 'example' => 'cn-hangzhou+dir-363353****', 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'PromotionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the coupon.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'youhuiquan_promotion_option_id_*****', + 'description' => 'The information that is returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', - ], + ], + 'title' => 'DeleteOfficeSites', + 'summary' => 'Deletes office networks (formerly workspaces).', + 'description' => 'Before you delete an office network, make sure that the following operations are complete:'."\n" + ."\n" + .'- All cloud computers in the office network are released.'."\n" + ."\n" + .'- The data that you want to retain is backed up.'."\n" + ."\n" + .'> Resources and data on cloud computers in an office network cannot be restored after you delete it. Proceed with caution.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteOfficeSites'], ], + ], + 'ramActions' => [ [ - 'name' => 'SystemDiskCategory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the system disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the Enterprise SSD (ESSD).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cloud_auto' => '', - 'cloud_essd' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteOfficeSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'cloud_auto', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeletePolicyGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SystemDiskSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the system disk. Unit: GiB.'."\n" - ."\n" - .'> The system disk must be at least as large as the image.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'SystemDiskPerLevel', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The performance level (PL) of the system disk of the ESSD category. Default value: PL0.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - .'* PL0'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - ], - 'example' => 'PL0', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by EDS.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DataDiskCategory', + 'name' => 'PolicyGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The category of the data disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the ESSD.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cloud_auto' => '', - 'cloud_essd' => '', - ], - 'example' => 'cloud_auto', + 'description' => 'The cloud computer policy IDs. You can specify 1 to 100 policies.', + 'type' => 'array', + 'items' => ['description' => 'The cloud computer policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'required' => true, + 'example' => 'pg-gx2x1dhsmthe9****', + 'maxItems' => 100, + 'title' => '', ], ], - [ - 'name' => 'DataDiskSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The size of the data disk. Unit: GB. Valid values: 0 to 16380. The value must be an integral multiple of 20.'."\n" - ."\n" - .'* A value of 0 means no data disk is attached.'."\n" - .'* If the selected plan includes a standard SSD, the data disk size must be at least 20 GB.'."\n" - ."\n" - .'Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', + 'description' => 'The response parameter.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeletePolicyGroups', + 'summary' => 'Deletes one or more custom cloud computer policies.', + 'description' => '- You cannot delete the cloud computer policy created by the Elastic Desktop Service (EDS) system.'."\n" + ."\n" + .'- You cannot delete the cloud computer policies that are associated with cloud computers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyGroups'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DataDiskPerLevel', - 'in' => 'query', - 'schema' => [ - 'description' => 'The PL of the data disk of the ESSD category. Default value: PL0.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - .'* PL0'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeletePolicyGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'PL0', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DeleteQosRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DefaultLanguage', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'QosRuleId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The language of the OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: English.'."\n" - .'* zh-HK: Traditional Chinese.'."\n" - .'* zh-CN: Simplified Chinese'."\n" - .'* ja-JP: Japanese.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', + 'type' => 'array', + 'items' => ['description' => 'The ID of a QoS rule.', 'type' => 'string', 'required' => false, 'example' => 'qos-5605u0gelk200****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'description' => 'A list of QoS rule IDs.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******', 'title' => ''], ], - 'example' => 'zh-CN', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DeleteQosRules', + 'summary' => 'Delete a rate-limiting rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DesktopType', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteQosRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\"\\n}","type":"json"}]', + ], + 'DeleteSnapshot' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SnapshotId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The specifications of the cloud computer. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) operation to query all the supported specifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eds.enterprise_office.16c64g', + 'description' => 'The snapshot IDs. You can specify 1 to 100 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The snapshot ID. If the specified snapshot does not exist, the request is ignored.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****', 'title' => ''], + 'required' => true, + 'example' => 's-2ze81owrnv9pity4****', + 'maxItems' => 100, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The object that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]', + 'title' => 'DeleteSnapshot', + 'summary' => 'Deletes one or more snapshots.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'], + ], + ], + 'ramActions' => [], + 'description' => 'If the IDs of the snapshots that you specify do not exist, requests are ignored.'."\n", + ], + 'DeleteTemplates' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Hostname', - 'in' => 'query', + 'name' => 'TemplateIds', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The hostname series of the cloud computer. This parameter is supported exclusively when the office network operates on Active Directory (AD) and the cloud computer runs on a Windows operating system.'."\n" - ."\n" - .'Naming conventions:'."\n" - ."\n" - .'* A hostname must be 2 to 15 characters in length'."\n" - .'* and can contain only letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.'."\n" - ."\n" - .'If you want to create multiple cloud computers, specify their hostnames in the `name_prefix[begin_number,bits]name_suffix` format. For example, if you set Hostname to ecd-\\[1,4]-test, the hostnames of the cloud computers will be assigned sequentially as ecd-0001-test, ecd-0002-test, and so on.'."\n" - ."\n" - .'* `name_prefix`: the prefix of the hostname.'."\n" - .'* `[begin_number,bits]`: the sequential number in the hostname. The `begin_number` value is the starting number. Valid values of begin_number: 0 to 999999. Default value: 0. The `bits` value is the number of digits. Valid values: 1 to 6. Default value: 6.'."\n" - .'* `name_suffix`: the suffix of the hostname.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the templates that you want to delete.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the template that you want to delete.', 'type' => 'string', 'required' => false, 'example' => 'b-7ywwjrr50t1a*****', 'title' => ''], 'required' => false, - 'example' => 'testhost', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MultiResource', - 'in' => 'query', + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether the shared group is a multi-cloud computer type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: a multi-cloud computer type.'."\n" - .'* false: a single-cloud computer type.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'title' => 'BaseResult', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true: The request is successful.'."\n" + ."\n" + .'- false: The request failed.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'Code' => ['description' => 'The modification result. If the request was successful, `success` is returned. If the request failed, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The description of the error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', 'title' => ''], + 'AccessDeniedDetail' => ['description' => 'The information about the request denial..', 'type' => 'string', 'example' => 'None', 'title' => ''], ], - 'example' => 'false', + 'example' => '', ], ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'DeleteTemplates', + 'summary' => 'Deletes custom cloud computer templates.', + 'description' => 'Deleting a template does not affect cloud computers created from it or the associated resources.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ExclusiveType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the shared group is exclusive. You must set this parameter to `Exclusive` when `SessionType` is set to `MultipleSession`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exclusive', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', + ], + 'DeleteVirtualMFADevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupAmount', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SerialNumber', 'in' => 'query', + 'schema' => ['description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" + ."\n" + .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device that is bound by AD users.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of shared groups for the single-cloud computer type. You must specify this parameter if you set `MultiResource` to `false`. Valid values: 1 to 5. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DeleteVirtualMFADevice', + 'summary' => 'Removes a virtual multi-factor authentication (MFA) device that is associated with an Active Directory (AD) account.', + 'description' => 'If an MFA device is deleted, the device is unbound, reset, and disabled. When an Active Directory (AD) user wants to connect to the cloud desktop that is bound to the MFA device, the AD user must bind a new MFA device.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteVirtualMFADevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'DescribeAclEntries' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'SessionType', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'- Maximum value: 1600.'."\n" + ."\n" + .'- Default value: 1600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kRxd1mKkNnHlUy14zdjl/I', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-631324****', 'title' => ''], + ], + [ + 'name' => 'SourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the session.'."\n" + 'description' => 'The granularity of the ACL.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* SingleSession'."\n" - .'* MultipleSession'."\n", + .'- desktop: cloud computer'."\n" + ."\n" + .'- vpc: office network', + 'enumValueTitles' => ['desktop' => '', 'vpc' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SingleSession' => '', - 'MultipleSession' => '', - ], - 'example' => 'SingleSession', + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'TimerGroupId', + 'name' => 'SourceId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the instance to which the ACL applies. You can specify an office network ID or a cloud computer ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-22poqua477xo4****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the timer group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0caoeogrk9m5****', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that is used to start the next query. If the value of this parameter is empty, all results are returned.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'AclEntries' => [ + 'description' => 'The ACL entries.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ACL entry.', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => 'The ACL type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- allow: whitelist'."\n" + ."\n" + .'- disable: blacklist', + 'enumValueTitles' => ['allow' => '', 'deny' => ''], + 'type' => 'string', + 'example' => 'allow', + 'title' => '', + ], + 'SourceType' => [ + 'description' => 'The granularity of the ACL.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- desktop: cloud computer'."\n" + ."\n" + .'- vpc: office network', + 'enumValueTitles' => ['desktop' => '', 'vpc' => ''], + 'type' => 'string', + 'example' => 'desktop', + 'title' => '', + ], + 'SourceId' => ['description' => 'The ID of the instance to which the ACL applies. You can specify an office network ID or a cloud computer ID.', 'type' => 'string', 'example' => 'ecd-22poqua477xo4****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeAclEntries', + 'summary' => 'Queries the details of an access control list (ACL) of an office network or a cloud computer.', + 'changeSet' => [ + ['createdAt' => '2025-01-20T07:27:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAclEntries'], + ], + ], + 'ramActions' => [ [ - 'name' => 'SnapshotPolicyId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-28mp6my0l6zow****', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeAclEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AclEntries\\": [\\n {\\n \\"Policy\\": \\"allow\\",\\n \\"SourceType\\": \\"desktop\\",\\n \\"SourceId\\": \\"ecd-22poqua477xo4****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeAutoSnapshotPolicy' => [ + 'summary' => 'Queries the details of automatic snapshot policies.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResellerOwnerUid', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The region ID. To query the regions supported by Elastic Desktop Service, call the [DescribeRegions](~~196646~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'UserOuPath', + 'name' => 'PolicyId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => false, 'example' => 'sp-c5tv9d64ebjnj****', 'title' => ''], ], [ - 'name' => 'UserGroupName', + 'name' => 'PolicyName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the automatic snapshot policy.', 'type' => 'string', 'example' => 'Test 1201', 'required' => false, 'title' => ''], ], [ - 'name' => 'SimpleUserGroupId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The maximum number of entries to return per page.'."\n" + ."\n" + .'- Maximum value: 50'."\n" + ."\n" + .'- Default value: 50', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10', 'title' => ''], ], [ - 'name' => 'DeleteDuration', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mqIGdPhID94rjhZFGsvpJo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'DesktopGroupId' => [ - 'description' => 'The ID of the shared group.'."\n", - 'type' => 'string', - 'example' => 'dg-2i8qxpv6t1a03****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983', - ], - 'OrderIds' => [ - 'description' => 'The IDs of the orders.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the order. This parameter is returned only if you set `ChargeType` to `PrePaid`.'."\n", - 'type' => 'string', - 'example' => '123456789', - ], - ], - 'DesktopGroupIds' => [ - 'description' => 'The IDs of the shared groups.'."\n", + 'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the return value is empty, no more results are returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A7F6612E-59CC-59F9-9DD1-91867FCC****', 'title' => ''], + 'AutoSnapshotPolicies' => [ + 'description' => 'The automatic snapshot policies.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the shared group.'."\n", - 'type' => 'string', - 'example' => '[\'dg-1np2yupx0uim****\']', + 'description' => 'An automatic snapshot policy.', + 'type' => 'object', + 'properties' => [ + 'TimePoints' => ['description' => 'The points in time when automatic snapshots are created.'."\n" + ."\n" + .'The value is a JSON array of integers. Example: `["0", "1", ... "23"]`. A maximum of 24 points in time can be specified.', 'type' => 'string', 'example' => '["17","18"]', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the policy was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-01-11T09:14:00Z', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the automatic snapshot policy.', + 'enumValueTitles' => ['Expire' => 'The policy cannot be used due to overdue payments.', 'Normal' => 'The policy is normal.'], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'DesktopNum' => ['description' => 'The number of cloud computers to which the automatic snapshot policy is applied.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CronExpression' => ['description' => 'The cron expression that is used to create snapshots.', 'type' => 'string', 'example' => '0 0 5,7 ? * 2/2', 'title' => ''], + 'RetentionDays' => ['description' => 'The retention period of automatic snapshots. Unit: days. Valid values: 1 to 180.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'PolicyName' => ['description' => 'The name of the automatic snapshot policy.', 'type' => 'string', 'example' => 'snapshot01', 'title' => ''], + 'PolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'example' => 'sp-3e3bmfcdkjfl1****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the automatic snapshot policy resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'DiskType' => ['description' => 'The disk type for which the automatic snapshot policy is created.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- SYSTEM: system disk'."\n" + ."\n" + .'- DATA: data disk', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopGroupId\\": \\"dg-2i8qxpv6t1a03****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\",\\n \\"OrderIds\\": [\\n \\"123456789\\"\\n ],\\n \\"DesktopGroupIds\\": [\\n \\"[\'dg-1np2yupx0uim****\']\\"\\n ]\\n}","type":"json"}]', - 'title' => 'CreateDesktopGroup', - 'description' => '* To learn about the features, application scenarios, usage limits, scaling policies, and other details of shared groups, refer to [Overview](~~290959~~).'."\n" - .'* Before you call this operation, make sure that the required resources, such as the office network, cloud computer template, and policies, are created.'."\n", - ], - 'GetDesktopGroupDetail' => [ - 'summary' => 'Queries the information about a cloud computer share.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"A7F6612E-59CC-59F9-9DD1-91867FCC****\\",\\n \\"AutoSnapshotPolicies\\": [\\n {\\n \\"TimePoints\\": \\"[\\\\\\"17\\\\\\",\\\\\\"18\\\\\\"]\\",\\n \\"CreationTime\\": \\"2023-01-11T09:14:00Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"DesktopNum\\": 1,\\n \\"CronExpression\\": \\"0 0 5,7 ? * 2/2\\",\\n \\"RetentionDays\\": \\"2\\",\\n \\"PolicyName\\": \\"snapshot01\\",\\n \\"PolicyId\\": \\"sp-3e3bmfcdkjfl1****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DiskType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAutoSnapshotPolicy', + 'changeSet' => [ + ['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-22T02:11:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-17T09:21:02.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoSnapshotPolicy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeBundles' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15388,1518 +12204,637 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'BundleType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The type of the cloud computer template.', + 'enumValueTitles' => ['SYSTEM' => 'System template', 'CUSTOM' => 'Custom template'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'SYSTEM', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'DesktopTypeFamily', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", + 'description' => 'The instance family of the cloud computers.', + 'enumValueTitles' => ['eds.graphics' => 'Graphical instance families', 'eds.hf' => 'Instance families with high clock speeds', 'eds.general' => 'General-purpose instance families'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', + 'required' => false, + 'example' => 'eds.general', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], + [ + 'name' => 'CpuCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of vCPUs contained in the cloud computer instance type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'MemorySize', + 'in' => 'query', + 'schema' => ['description' => 'The memory size of the cloud computer instance type. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'GpuCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of GPUs contained in the cloud computer instance type.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CheckStock', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the inventory status of the cloud computer instance type.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'FromDesktopGroup', + 'in' => 'query', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1B5268CE-5EB3-545F-9F38-A8BCF710****', - ], - 'Desktops' => [ - 'description' => 'The cloud computers within the share.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The cloud computer share is unpaid.'."\n" - .'* 1: The cloud computer share is normal.'."\n" - .'* 2: The cloud computer share expired, or your account has an overdue payment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - '', - ], - 'example' => '1', - ], - 'CreationTime' => [ - 'description' => 'The time when the desktop group was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-11-06T08:28Z', - ], - 'PayType' => [ - 'description' => 'The billing method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go.'."\n" - ."\n" - .'* PrePaid: subscription.', - 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], - 'ResetType' => [ - 'description' => 'The disk reset type of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: does not reset disks.'."\n" - .'* 1: resets only the system disk.'."\n" - .'* 2: resets only the user disk.'."\n" - .'* 3: resets the system disk and the user disk.', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - '', - '', - ], - 'example' => '0', - ], - 'LoadPolicy' => [ - 'description' => 'The load balancing policy for the multi-session many-to-many share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: depth-first.'."\n" - .'* 1: breadth-first.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'PolicyGroupName' => [ - 'description' => 'The name of the applied policy.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Creator' => [ - 'description' => 'The Alibaba Cloud account that creates the cloud computer pool.'."\n", - 'type' => 'string', - 'example' => '155177335370****', - ], - 'MaxDesktopsCount' => [ - 'description' => 'The maximum number of cloud computers allowed in the pay-as-you-go cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AllowAutoSetup' => [ - 'description' => 'Specifies whether to enable batch-based automatic creation of cloud computers in the subscription cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: enables batch-based automatic creation of cloud computers.'."\n" - .'* 1: disables batch-based automatic creation of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', + 'description' => 'Specifies whether the cloud computers in the template belong to a cloud computer pool.', + 'enumValueTitles' => ['true' => 'Belongs to a cloud computer pool.', 'false' => '(Default) Does not belong to a cloud computer pool.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'High-Definition Experience (HDX) protocol', 'ASP' => '(Recommended) In-house Adaptive Streaming Protocol (ASP)'], + 'type' => 'string', + 'required' => false, + 'example' => 'ASP', + 'title' => '', + ], + ], + [ + 'name' => 'BundleId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the cloud computer templates. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer template.', 'type' => 'string', 'required' => false, 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', 'title' => ''], + 'required' => false, + 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', + 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'SupportMultiSession', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return multi-session cloud computer templates. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'VolumeEncryptionEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable disk encryption.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'FotaChannel', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not available for public use.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + ], + [ + 'name' => 'SelectedBundle', + 'in' => 'query', + 'schema' => ['description' => 'The desktop template that is selected based on specific criteria.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SessionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the session.', + 'enumValueTitles' => ['SingleSession' => 'Single session', 'MultipleSession' => 'Multiple sessions'], + 'type' => 'string', + 'required' => false, + 'example' => 'SingleSession', + 'title' => '', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The image IDs.', + 'type' => 'array', + 'items' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-7by8d2m4kiicz****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'OsType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the OS.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'required' => false, + 'example' => 'Windows', + 'title' => '', + ], + ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => ['description' => 'The scenario to use the image.', 'type' => 'string', 'required' => false, 'example' => 'FastBuy', 'title' => ''], + ], + [ + 'name' => 'GpuDriverType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The GPU driver type.', + 'enumValueTitles' => ['T4' => 'T4', 'A10' => 'A10', 'G28' => 'G28', 'G39' => 'G39'], + 'type' => 'string', + 'required' => false, + 'example' => 'T4', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'BCC854D8-5D1E-46D3-96EF-797A5DD36789', 'title' => ''], + 'Bundles' => [ + 'description' => 'The cloud computer templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud computer template.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the cloud computer template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'BundleType' => [ + 'description' => 'The type of the cloud computer template.', + 'enumValueTitles' => ['SYSTEM' => 'System template', 'CUSTOM' => 'Custom template'], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', ], - 'example' => '1', - ], - 'ResType' => [ - 'description' => 'The type of the resource. Only Elastic Compute Service (ECS) instances are supported.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* 0: ECS', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 'ECS', + 'OsType' => [ + 'description' => 'The type of the OS.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', ], - 'example' => '0', - ], - 'SystemDiskSize' => [ - 'description' => 'The system disk capacity. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'PolicyGroupId' => [ - 'description' => 'The ID of the applied policy.'."\n", - 'type' => 'string', - 'example' => 'pg-9cktlowtxfl6****', - ], - 'OwnBundleId' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'b-1se9fb37r5tfq****', - ], - 'GpuCount' => [ - 'description' => 'The number of vGPUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '4', - ], - 'AllowBufferCount' => [ - 'description' => 'This parameter applies to pay-as-you-go cloud computer shares and specifies the number of standby cloud computers that can be reserved per cloud computer share. Valid values:'."\n" - ."\n" - .'* 0: does not reserve any cloud computers.'."\n" - .'* N: reserves N cloud computers (1≤ N ≤ 100).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Memory' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - ], - 'GpuSpec' => [ - 'description' => 'The GPU specifications.'."\n", - 'type' => 'string', - 'example' => 'NVIDIA T4', - ], - 'DirectoryId' => [ - 'description' => 'The ID of the directory or office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'OwnBundleName' => [ - 'description' => 'The name of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'BundleDemo', - ], - 'DataDiskCategory' => [ - 'description' => 'The category of the user disk.'."\n", - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'DesktopGroupDemo', - ], - 'BindAmount' => [ - 'description' => 'The maximum number of concurrent sessions allowed per cloud computer within the multi-session many-to-many share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OwnType' => [ - 'description' => 'The type of the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: a one-to-many share.'."\n" - .'* 1: a many-to-many share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', + 'StockState' => ['description' => 'The inventory status of the cloud computer instance type. This parameter is returned only if you set the `CheckStock` parameter to `true`.', 'type' => 'string', 'example' => 'Sufficient', 'title' => ''], + 'DesktopType' => ['description' => 'The instance type of the cloud computer.', 'type' => 'string', 'example' => 'ecd.graphics.2xlarge', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'In-house ASP protocol'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', ], - 'example' => '0', - ], - 'SystemDiskCategory' => [ - 'description' => 'The category of the system disk.'."\n", - 'type' => 'string', - 'example' => 'cloud_essd', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-990541****', - ], - 'KeepDuration' => [ - 'description' => 'The amount of time to retain a session after it is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5760 minutes (4 days). If you specify the value to 0, the session is permanently retained.'."\n" - ."\n" - .'When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can still access data of the session.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180000', - ], - 'MinDesktopsCount' => [ - 'description' => 'The number of cloud computers created in the initial batch within the subscription cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataDiskSize' => [ - 'description' => 'The user disk capacity. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '80', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'dg-3uiojcc0j4kh7****', - ], - 'OfficeSiteName' => [ - 'description' => 'The name of the office network in which the cloud computer resides.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DirectoryType' => [ - 'description' => 'The type of the directory.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'SIMPLE', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Comments' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'for students', - ], - 'OfficeSiteType' => [ - 'description' => 'The office network type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PERSONAL: individual office network'."\n" - .'* SIMPLE: convenience office network'."\n" - .'* AD_CONNECTOR: enterprise Active Directory (AD) office network'."\n" - .'* RAM: Resource Access Management (RAM)-based office network', - 'type' => 'string', - 'enumValueTitles' => [ - 'PERSONAL' => '', - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - 'RAM' => '', + 'BundleId' => ['description' => 'The ID of the cloud computer template.', 'type' => 'string', 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', 'title' => ''], + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'desktopimage-windows-server-2019-64-ch-vgpu', 'title' => ''], + 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'Windows server 2019 Chinese', 'title' => ''], + 'Language' => [ + 'description' => 'The OS language of the image.', + 'enumValueTitles' => ['en-US' => 'English', 'zh-HK' => 'Chinese, Traditional (Hong Kong, China)', 'zh-CN' => 'Simplified Chinese', 'ja-JP' => 'Japanese'], + 'type' => 'string', + 'example' => 'en-US', + 'title' => '', ], - 'example' => 'SIMPLE', - ], - 'TimerInfos' => [ - 'description' => 'The list of scheduled points in time for desktop group tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The time when the desktop group task is scheduled to run.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the cloud computer pool.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: enabled'."\n" - .'* 2: disabled'."\n" - .'* 3: deleted', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 1 => '', - '', - '', + 'BundleName' => ['description' => 'The name of the cloud computer template.', 'type' => 'string', 'example' => 'Advanced graphics with Windows 2019', 'title' => ''], + 'Disks' => [ + 'description' => 'Details of the disks.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the disk.', + 'type' => 'object', + 'properties' => [ + 'DiskType' => [ + 'description' => 'The type of the disk.', + 'enumValueTitles' => ['SYSTEM' => 'System disk', 'DATA' => 'Data disk'], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', ], - 'example' => '1', - ], - 'CronExpression' => [ - 'description' => 'The cron expression.'."\n", - 'type' => 'string', - 'example' => '0 58 11 ? * 2', - ], - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: scheduled reset'."\n" - .'* 2: scheduled startup'."\n" - .'* 3: scheduled stop'."\n" - .'* 4: scheduled restart', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', + 'DiskSize' => ['description' => 'The size of the disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'DiskPerformanceLevel' => [ + 'description' => 'The PL of the disk.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], + 'type' => 'string', + 'example' => 'PL0', + 'title' => '', ], - 'example' => '1', - ], - 'Forced' => [ - 'description' => 'Indicates whether the scheduled task is forcibly executed.'."\n", - 'type' => 'boolean', - 'example' => 'false', ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - 'RatioThreshold' => [ - 'description' => 'The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`.'."\n" - ."\n" - .'If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'ConnectDuration' => [ - 'description' => 'The maximum period of time during which the session is connected. When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60000', - ], - 'IdleDisconnectDuration' => [ - 'description' => 'After an end user connects to a cloud computer, the session is established. If the system does not detect any inputs from the keyboard or mouse within the specified period of time, the session is closed. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '900000', - ], - 'Version' => [ - 'description' => 'The version number of the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StopDuration' => [ - 'description' => 'The period of time before the idle cloud computer enters the Stopped state. If the specified value is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer automatically starts. Unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '180000', - ], - 'ProfileFollowSwitch' => [ - 'description' => 'Indicates whether user data roaming is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NasFileSystemID' => [ - 'description' => 'The ID of the File Storage NAS (NAS) file system for the user data roaming feature.', - 'type' => 'string', - 'example' => '0783b4****', - ], - 'NasFileSystemName' => [ - 'description' => 'The name of the NAS file system for the user data roaming feature.'."\n", - 'type' => 'string', - 'example' => 'abcd', - ], - 'TimingStrategyInfo' => [ - 'description' => 'The information about the scheduling policy.'."\n", - 'type' => 'string', - 'example' => 'abcd', - ], - 'ScaleTimerInfos' => [ - 'description' => 'The scheduled tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduled task.'."\n", + 'DesktopTypeAttribute' => [ + 'description' => 'The details of the cloud computer instance type.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: decline policy'."\n" - .'* normal: normal policy'."\n" - .'* peak: peak hour policy'."\n" - .'* rise: rise policy', - 'type' => 'string', - 'enumValueTitles' => [ - 'drop' => '', - 'normal' => '', - 'peak' => '', - 'rise' => '', - ], - 'example' => 'rise', - ], - 'Cron' => [ - 'description' => 'The cron expression for the scheduled task.'."\n", - 'type' => 'string', - 'example' => '0 0 0 * * ? ', - ], - 'LoadPolicy' => [ - 'description' => 'The load balancing policy for the multi-session many-to-many share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: depth-first.'."\n" - .'* 1: breadth-first.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - 'BuyResAmount' => [ - 'description' => 'The number of cloud computers that you purchase in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'MinResAmount' => [ - 'description' => 'The minimum number of cloud computers in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'MaxResAmount' => [ - 'description' => 'The maximum number of cloud computers in the cloud computer pool. This parameter is one of the auto scaling parameters. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'KeepDuration' => [ - 'description' => 'The duration that is retained after the session is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5760 minutes (4 days). If you specify the value to 0, the session is permanently retained.'."\n" - ."\n" - .'When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can still access data of the session.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600000', - ], - 'RatioThreshold' => [ - 'description' => 'The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`.'."\n" - ."\n" - .'If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], + 'CpuCount' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'GpuCount' => ['description' => 'The number of GPUs.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU type.', 'type' => 'string', 'example' => 'NVIDIA T4', 'title' => ''], + 'MemorySize' => ['description' => 'The memory size. Unit: MiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '4096', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'PolicyGroupIds' => [ - 'description' => 'The IDs of the applied policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the policy.'."\n", + 'DesktopTypeFamily' => [ + 'description' => 'The instance family of the cloud computer.', + 'enumValueTitles' => ['eds.graphics' => 'Graphical instance family', 'eds.hf' => 'Instance family with a high clock speed', 'eds.general' => 'General-purpose instance family'], 'type' => 'string', - 'example' => 'pd-abcd***', + 'example' => 'eds.general', + 'title' => '', ], - ], - 'PolicyGroupNames' => [ - 'description' => 'The names of the applied policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the applied policy.'."\n", + 'CreationTime' => ['description' => 'The time when the cloud computer template was created.', 'type' => 'string', 'example' => '2021-09-30T06:09Z', 'title' => ''], + 'SessionType' => [ + 'description' => 'The session type.', + 'enumValueTitles' => ['Single-session', 'Multi-session'], 'type' => 'string', - 'example' => 'abcd', + 'example' => '0', + 'title' => '', ], - ], - 'BuyDesktopsCount' => [ - 'description' => '* The number of purchased cloud computers in the subscription share. Valid values: 0 to 200.'."\n" - .'* The minimum initial number of cloud computers created in the pay-as-you-go share. Default value: 1. Valid values: 0 to `MaxDesktopsCount`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ImageId' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'example' => 'm-4zfb6zj728hhr****', - ], - 'ExpiredTime' => [ - 'description' => 'The expiration date of the subscription cloud computer share.'."\n", - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], - 'OsType' => [ - 'type' => 'string', - ], - 'ProtocolType' => [ - 'type' => 'string', - ], - 'ExpiredTimes' => [ - 'type' => 'array', - 'items' => [ + 'VolumeEncryptionEnabled' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled.', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + 'Platform' => [ + 'description' => 'The OS.', + 'enumValueTitles' => ['Ubuntu' => 'Ubuntu', 'Windows Server 2022' => 'Windows Server 2022', 'UOS' => 'UOS', 'CentOS' => 'CentOS', 'Windows Server 2019' => 'Windows Server 2019', 'Windows Server 2016' => 'Windows Server 2016'], + 'type' => 'string', + 'example' => 'Windows Server 2019', + 'title' => '', + ], + 'ImageStatus' => ['description' => 'The status of the image.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'SystemDiskCategory' => [ + 'description' => 'The category of the system disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'The ultra disk.', 'cloud_auto' => 'The standard SSD.', 'cloud_essd' => 'The Enterprise SSD (ESSD). Take note that only specific cloud computer types support ESSDs.'], + 'type' => 'string', + 'example' => 'cloud_efficiency', + 'title' => '', + ], + 'DataDiskCategory' => [ + 'description' => 'The category of the data disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'The ultra disk.', 'cloud_auto' => 'The standard SSD.', 'cloud_essd' => 'The ESSD. Take note that only specific cloud computer types support ESSDs.'], 'type' => 'string', + 'example' => 'cloud_efficiency', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B5268CE-5EB3-545F-9F38-A8BCF710****\\",\\n \\"Desktops\\": {\\n \\"Status\\": 1,\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"PayType\\": \\"PrePaid\\",\\n \\"ResetType\\": 0,\\n \\"LoadPolicy\\": 0,\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"Creator\\": \\"155177335370****\\",\\n \\"MaxDesktopsCount\\": 3,\\n \\"AllowAutoSetup\\": 1,\\n \\"ResType\\": 0,\\n \\"SystemDiskSize\\": 80,\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"OwnBundleId\\": \\"b-1se9fb37r5tfq****\\",\\n \\"GpuCount\\": 4,\\n \\"AllowBufferCount\\": 1,\\n \\"Memory\\": 4096,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"OwnBundleName\\": \\"BundleDemo\\",\\n \\"DataDiskCategory\\": \\"cloud_essd\\",\\n \\"DesktopGroupName\\": \\"CloudComputerPool01\\\\n\\",\\n \\"BindAmount\\": 2,\\n \\"OwnType\\": 0,\\n \\"SystemDiskCategory\\": \\"cloud_essd\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-990541****\\",\\n \\"KeepDuration\\": 180000,\\n \\"MinDesktopsCount\\": 1,\\n \\"DataDiskSize\\": \\"80\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"Cpu\\": 4,\\n \\"Comments\\": \\"comment\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"TimerInfos\\": [\\n {\\n \\"Status\\": 1,\\n \\"CronExpression\\": \\"0 58 11 ? * 2\\",\\n \\"TimerType\\": 1,\\n \\"Forced\\": false\\n }\\n ],\\n \\"RatioThreshold\\": 0.85,\\n \\"ConnectDuration\\": 3600000,\\n \\"IdleDisconnectDuration\\": 900000,\\n \\"Version\\": 2,\\n \\"StopDuration\\": 180000,\\n \\"ProfileFollowSwitch\\": false,\\n \\"NasFileSystemID\\": \\"0783b4****\\",\\n \\"NasFileSystemName\\": \\"abcd\\",\\n \\"TimingStrategyInfo\\": \\"abcd\\",\\n \\"ScaleTimerInfos\\": [\\n {\\n \\"Type\\": \\"rise\\",\\n \\"Cron\\": \\"0 0 0 * * ? \\",\\n \\"LoadPolicy\\": 1,\\n \\"BuyResAmount\\": 5,\\n \\"MinResAmount\\": 1,\\n \\"MaxResAmount\\": 100,\\n \\"KeepDuration\\": 180000,\\n \\"RatioThreshold\\": 0.85\\n }\\n ],\\n \\"PolicyGroupIds\\": [\\n \\"pd-abcd***\\"\\n ],\\n \\"PolicyGroupNames\\": [\\n \\"All enabled policy\\"\\n ],\\n \\"BuyDesktopsCount\\": 5,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"OsType\\": \\"\\",\\n \\"ProtocolType\\": \\"\\",\\n \\"ExpiredTimes\\": [\\n \\"\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1B5268CE-5EB3-545F-9F38-A8BCF7105777\\n \\n 2022-02-17T14:51:07Z\\n PrePaid\\n test-policy\\n 1007214305******\\n 10\\n 1\\n 0\\n 80\\n pg-53iyi2aar0nd6****\\n bundle_eds_general_4c8g_s8d5_win2019\\n 1\\n 0\\n 16384\\n 16 GiB\\n cn-hangzhou+dir-adde******\\n test\\n cloud_ssd\\n test1\\n cloud_ssd\\n cn-hangzhou+dir-467671****\\n 1000\\n 1\\n 50\\n dg-2i8qxpv6t1a03****\\n testName\\n SIMPLE\\n 4\\n 2022-03-17T16:00:00Z\\n test\\n SIMPLE\\n 1\\n 0\\n \\n","errorExample":""}]', - 'title' => 'GetDesktopGroupDetail', - ], - 'DescribeDesktopGroups' => [ - 'summary' => 'Queries cloud computer shares.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeBundles', + 'summary' => 'Queries the details of cloud computer templates.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-15T03:18:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-19T04:01:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-10T09:38:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-27T14:07:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-05T11:05:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-13T02:35:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-13T02:35:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBundles'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeBundles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8\\",\\n \\"RequestId\\": \\"BCC854D8-5D1E-46D3-96EF-797A5DD36789\\",\\n \\"Bundles\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"BundleType\\": \\"SYSTEM\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"StockState\\": \\"Sufficient\\",\\n \\"DesktopType\\": \\"ecd.graphics.2xlarge\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BundleId\\": \\"bundle_ecd_graphics.2xlarge_s15d15_win2019\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-vgpu\\",\\n \\"ImageName\\": \\"Windows server 2019 Chinese\\",\\n \\"Language\\": \\"en-US\\",\\n \\"BundleName\\": \\"Advanced graphics with Windows 2019\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 150,\\n \\"DiskPerformanceLevel\\": \\"PL0\\"\\n }\\n ],\\n \\"DesktopTypeAttribute\\": {\\n \\"CpuCount\\": 10,\\n \\"GpuCount\\": 0.5,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"MemorySize\\": 4096\\n },\\n \\"DesktopTypeFamily\\": \\"eds.general\\",\\n \\"CreationTime\\": \\"2021-09-30T06:09Z\\",\\n \\"SessionType\\": \\"0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"Platform\\": \\"Windows Server 2019\\",\\n \\"ImageStatus\\": \\"Available\\",\\n \\"SystemDiskCategory\\": \\"cloud_efficiency\\",\\n \\"DataDiskCategory\\": \\"cloud_efficiency\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCdsFileShareLinks' => [ + 'summary' => 'Queries file sharing links of a cloud disk in Cloud Drive Service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'OfficeSiteId', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the office network in which the cloud computer share resides.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-467671****', - ], + 'schema' => ['description' => 'The ID of the cloud disk.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****', 'title' => ''], ], [ - 'name' => 'DesktopGroupName', + 'name' => 'ShareId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer share that you want to query. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testName', - ], + 'schema' => ['description' => 'The ID of the file sharing link.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7JQX1Fs****'."\n", 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'Creators', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', + 'description' => 'The users that create the file sharing links.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The user that creates the file sharing link.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, 'docRequired' => false, - 'example' => 'dg-2i8qxpv6t1a03****', + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Period', + 'name' => 'ShareName', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration of the cloud computer share. The unit is specified by `PeriodUnit`.'."\n" - ."\n" - .'* Valid values if you set `PeriodUnit` to `Month`:'."\n" - ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 6'."\n" - ."\n" - .'* Valid values if you set `PeriodUnit` to `Year`:'."\n" - ."\n" - .' * 1'."\n" - .' * 2'."\n" - .' * 3'."\n" - .' * 4'."\n" - .' * 5'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The sharing name for fuzzy search.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'user', 'title' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The unit of the subscription duration.'."\n", + 'description' => 'The file sharing status. Valid values: ● disabled: canceled ● enabled: valid'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', + 'example' => 'enabled', + 'enum' => ['enabled', 'disabled'], + 'enumValueTitles' => ['disabled' => '已取消', 'enabled' => '有效'], + 'title' => '', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The maximum number of resources to return. Valid values: 1 to 100. Default value: 100. The number of returned resources must be less than or equal to the specified number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'Specifies the marker after which the returned list begins. If this parameter is not specified, all results are returned. Default value: null.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data information.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The file sharing entity.'."\n", '$ref' => '#/components/schemas/CdsFileShareLinkModel', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'title' => '', + ], + 'Code' => ['description' => 'The operation result. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeCdsFileShareLinks', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCdsFileShareLinks'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"newDescription\\",\\n \\"SaveLimit\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DescribeCens' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the applied policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-53iyi2aar0nd6****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Status', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The cloud computer share is unpaid.'."\n" - .'* 1: The cloud computer share is normal.'."\n" - .'* 2: The cloud computer share expired, or your account has an overdue payment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OwnType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the cloud computer share.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: a single-session many-to-many share.'."\n" - .'* 1: a multi-session many-to-many share.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page.
Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'EndUserIds', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The page number.
Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IDs of the users who can access the cloud computer share.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user who can access the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], - 'required' => false, - 'maxItems' => 1000, - ], - ], - [ - 'name' => 'ExcludedEndUserIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The authorized users that you want to exclude.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The authorized user that you want to exclude.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Tony', - ], - 'required' => false, - 'maxItems' => 1000, - ], - ], - [ - 'name' => 'ProtocolType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* High-definition Experience (HDX)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Adaptive Streaming Protocol (ASP)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the images.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-eeuo9qab4b0****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'BundleId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b-4w5nk44znm6****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to add to the cloud computer share. You can specify 1 to 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that you want to add to the cloud computer share.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. It cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'MultiResource', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the cloud computer share is a many-to-many share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: The cloud computer share is a many-to-many share.'."\n" - .'* false: The cloud computer share is a one-to-many share.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], - [ - 'name' => 'DesktopGroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer shares.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-2i8qxpv6t1a03****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'DesktopType', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'DesktopGroups' => [ - 'description' => 'The cloud computer shares.'."\n", + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of CEN instances returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Cens' => [ + 'description' => 'Details of the CEN instances.', 'type' => 'array', 'items' => [ - 'description' => 'The cloud computer share.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the cloud computer pool was created.'."\n", - 'type' => 'string', - 'example' => '2022-02-17T14:51:07Z', - ], - 'PayType' => [ - 'description' => 'The billing method of the cloud computer pool.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go'."\n" - .'* PrePaid: subscription', - 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], - 'PolicyGroupName' => [ - 'description' => 'The name of the applied policy.'."\n", - 'type' => 'string', - 'example' => 'test-policy', - ], - 'Creator' => [ - 'description' => 'The Alibaba Cloud account that creates the cloud computer pool.'."\n", - 'type' => 'string', - 'example' => '1007214305******', - ], - 'MaxDesktopsCount' => [ - 'description' => '* For pay-as-you-go cloud computer shares, this parameter defines the maximum number of cloud computers allowed.'."\n" - .'* For subscription cloud computer shares, this parameter defines the total number of cloud computers, including both the initially purchased cloud computers (`BuyDesktopsCount`) and those that can be auto-created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'SystemDiskSize' => [ - 'description' => 'The system disk capacity. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'PolicyGroupId' => [ - 'description' => 'The ID of the applied policy.'."\n", - 'type' => 'string', - 'example' => 'pg-53iyi2aar0nd6c8qj', - ], - 'OwnBundleId' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'bundle_eds_general_4c8g_s8d5_win2019', - ], - 'GpuCount' => [ - 'description' => 'The number of GPUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Memory' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16384', - ], - 'GpuSpec' => [ - 'description' => 'The GPU memory.'."\n", - 'type' => 'string', - 'example' => '16 GiB', - ], - 'OwnBundleName' => [ - 'description' => 'The name of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DataDiskCategory' => [ - 'description' => 'The category of the user disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: ultra disk'."\n" - .'* cloud_ssd: standard SSD'."\n" - .'* cloud_essd: enhanced SSD (ESSD)', - 'type' => 'string', - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_ssd' => '', - 'cloud_essd' => '', - ], - 'example' => 'cloud_ssd', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'SystemDiskCategory' => [ - 'description' => 'The category of the system disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: ultra disk'."\n" - .'* cloud_ssd: standard SSD'."\n" - .'* cloud_essd: enhanced SSD (ESSD)', - 'type' => 'string', - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_ssd' => '', - 'cloud_essd' => '', - ], - 'example' => 'cloud_ssd', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network in which the cloud computer network resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-467671****', - ], - 'KeepDuration' => [ - 'description' => 'The keep-alive duration of a session after the session is disconnected. Valid values: 180000 (3 minutes) to 345600000 (4 days). Unit: milliseconds. If you set this parameter to 0, the session is permanently retained after it is disconnected.'."\n" - ."\n" - .'When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can continue to access data of the session.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'MinDesktopsCount' => [ - 'description' => '* For pay-as-you-go cloud computer shares, this parameter defines the minimum number of cloud computers allowed.'."\n" - .'* For subscription cloud computer shares, this parameter defines the number of cloud computers that are initially purchased (`BuyDesktopsCount`).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EndUserCount' => [ - 'description' => 'The number of users who can access the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataDiskSize' => [ - 'description' => 'The user disk capacity. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '50', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'dg-2i8qxpv6t1a03****', - ], - 'OfficeSiteName' => [ - 'description' => 'The ID of the office network in which the cloud computer share resides.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ExpiredTime' => [ - 'description' => 'The expiration date of the subscription cloud computer share.'."\n", - 'type' => 'string', - 'example' => '2022-03-17T16:00:00Z', - ], - 'Comments' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'OfficeSiteType' => [ - 'description' => 'The account type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PERSONAL: individual office network'."\n" - .'* SIMPLE: convenience office network'."\n" - .'* AD_CONNECTOR: enterprise Active Directory (AD) office network'."\n" - .'* RAM: Resource Access Management (RAM)-based office network', - 'type' => 'string', - 'enumValueTitles' => [ - 'PERSONAL' => '', - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - 'RAM' => '', - ], - 'example' => 'SIMPLE', - ], 'Status' => [ - 'description' => 'The status of the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The cloud computer share is unpaid.'."\n" - .'* 1: The cloud computer share is normal.'."\n" - .'* 2: The cloud computer share expired, or your account has an overdue payment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - '', - ], - 'example' => '1', - ], - 'ResetType' => [ - 'description' => 'The reset option for the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: does not reset any disk.'."\n" - .'* 1: resets only the system disk.'."\n" - .'* 2: resets only the data disk.'."\n" - .'* 3: resets the system disk and data disk.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - '', - '', - ], - 'example' => '0', - ], - 'LoadPolicy' => [ - 'description' => 'The load balancing policy for the multi-session many-to-many share.'."\n" + 'description' => 'The status of the CEN instance.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* 0: depth-first'."\n" - .'* 1: breadth-first'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - 'BindAmount' => [ - 'description' => 'The number of concurrent sessions allowed for each cloud computer within the multi-session many-to-many share.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'OwnType' => [ - 'description' => 'The type of the cloud computer share.'."\n" + .'- Creating'."\n" ."\n" - .'Valid values:'."\n" + .'- Active'."\n" ."\n" - .'* 0: a single-session many-to-many share.'."\n" - .'* 1: a multi-session many-to-many share.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'ImageId' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'example' => 'm-gq15cq5ydlvwn****', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key for disk encryption.'."\n", + .'- Deleting', + 'enumValueTitles' => ['Creating' => '', 'Active' => '', 'Deleting' => ''], 'type' => 'string', - 'example' => 'e5409ada-xxxx-xxxx-xxxx-89e31e23e993', - ], - 'RatioThreshold' => [ - 'description' => 'The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`'."\n" - ."\n" - .'When the specified threshold is reached, new cloud computers are automatically created. When the specified threshold is not reached, idle cloud computers are released.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.85', - ], - 'ConnectDuration' => [ - 'description' => 'The maximum period of time during which a session is connected. When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90000', - ], - 'IdleDisconnectDuration' => [ - 'description' => 'The period of time after which a session is closed. After an end user connects to a cloud computer, the session is established. If the system does not detect inputs from the keyboard or mouse within the specified period of time, the session is closed. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90000', - ], - 'Version' => [ - 'description' => 'The version number of the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'StopDuration' => [ - 'description' => 'The period of time after which an idle cloud computer is stopped. When the specified period of time is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer is automatically started. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '900000', + 'example' => 'Active', + 'title' => '', ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ASP'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" + 'CreationTime' => ['description' => 'The time when the CEN instance was created.', 'type' => 'string', 'example' => '2021-06-16T08:46Z', 'title' => ''], + 'Ipv6Level' => [ + 'description' => 'The IPv6 level.'."\n" ."\n" - .' '."\n", + .'> IPv6 is not supported.', + 'enumValueTitles' => ['DISABLED' => 'IPv6 is disabled.'], 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', + 'example' => 'DISABLED', + 'title' => '', ], - 'OsType' => [ - 'description' => 'The OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" + 'Description' => ['description' => 'The description of the CEN instance.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CenId' => ['description' => 'The ID of the CEN instance.', 'type' => 'string', 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], + 'ProtectionLevel' => [ + 'description' => 'The tolerated level of CIDR block conflict.'."\n" ."\n" - .' '."\n" + .'Valid value:'."\n" ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], - 'BuyDesktopsCount' => [ - 'description' => 'This parameter is applicable only to subscription cloud computer shares. It defines the initial number of cloud computers that are purchased. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'DesktopCount' => [ - 'description' => 'The number of cloud computers that are created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'DesktopType' => [ - 'description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of the cloud computer types supported by WUYING Workspace.'."\n", + .'- REDUCED: CIDR block conflicts are allowed, but the conflicting CIDR blocks cannot be identical.', + 'enumValueTitles' => ['REDUCED' => ''], 'type' => 'string', - 'example' => 'eds.enterprise_office.4c4g', + 'example' => 'REDUCED', + 'title' => '', ], - 'CountPerStatus' => [ - 'description' => 'The number of cloud computers in each state.'."\n", + 'Name' => ['description' => 'The name of the CEN instance.', 'type' => 'string', 'example' => 'testCen', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags of the CEN instance.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Starting'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Rebuilding'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Stopping'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Expired'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Deleted'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Pending'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Running', - ], - 'Count' => [ - 'description' => 'The total number of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'testKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'testValue', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'GpuDriverVersion' => [ - 'description' => 'The version of the GPU driver.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'SubnetId' => [ - 'description' => 'The ID of the subnet.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf63bb6*****8gfytm', - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", + 'PackageIds' => [ + 'description' => 'The bandwidth plans that are bound to the CEN instance.', 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'desktop_group_name', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'ds-dq2mybjr23yw*****', - ], + 'PackageId' => ['description' => 'The ID of the bandwidth plan that is bound to the CEN instance.', 'type' => 'string', 'example' => 'cenbwp-4c2zaavbvh5f42****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'UserOuPath' => [ - 'description' => 'The user\'s organizational unit path.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - 'IsLdap' => [ - 'type' => 'boolean', - ], - 'UserGroupName' => [ - 'type' => 'string', - ], - 'PolicyGroupIdList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'PolicyGroupNameList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'SimpleUserGroupId' => [ - 'type' => 'string', - ], - 'ExpiredTimes' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'AccountType' => [ - 'type' => 'string', - ], - 'EntraDomainName' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopGroups\\": [\\n {\\n \\"CreateTime\\": \\"2022-02-17T14:51:07Z\\",\\n \\"PayType\\": \\"PrePaid\\",\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"Creator\\": \\"1007214305******\\",\\n \\"MaxDesktopsCount\\": 3,\\n \\"SystemDiskSize\\": 80,\\n \\"PolicyGroupId\\": \\"pg-53iyi2aar0nd6c8qj\\",\\n \\"OwnBundleId\\": \\"bundle_eds_general_4c8g_s8d5_win2019\\",\\n \\"GpuCount\\": 1,\\n \\"Memory\\": 16384,\\n \\"GpuSpec\\": \\"16 GiB\\",\\n \\"OwnBundleName\\": \\"test\\",\\n \\"DataDiskCategory\\": \\"cloud_ssd\\",\\n \\"DesktopGroupName\\": \\"CloudComputerPool01\\",\\n \\"SystemDiskCategory\\": \\"cloud_ssd\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-467671****\\",\\n \\"KeepDuration\\": 180000,\\n \\"MinDesktopsCount\\": 1,\\n \\"EndUserCount\\": 1,\\n \\"DataDiskSize\\": \\"50\\",\\n \\"DesktopGroupId\\": \\"dg-2i8qxpv6t1a03****\\",\\n \\"OfficeSiteName\\": \\"cn-hangzhou+os-c5cy7q578s8jc****\\",\\n \\"Cpu\\": 4,\\n \\"ExpiredTime\\": \\"2022-03-17T16:00:00Z\\",\\n \\"Comments\\": \\"comment\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"Status\\": 1,\\n \\"ResetType\\": 0,\\n \\"LoadPolicy\\": 1,\\n \\"BindAmount\\": 2,\\n \\"OwnType\\": 0,\\n \\"ImageId\\": \\"m-gq15cq5ydlvwn****\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"e5409ada-xxxx-xxxx-xxxx-89e31e23e993\\",\\n \\"RatioThreshold\\": 0.85,\\n \\"ConnectDuration\\": 3600000,\\n \\"IdleDisconnectDuration\\": 90000,\\n \\"Version\\": 2,\\n \\"StopDuration\\": 900000,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"BuyDesktopsCount\\": 5,\\n \\"DesktopCount\\": 2,\\n \\"DesktopType\\": \\"eds.enterprise_office.4c4g\\",\\n \\"CountPerStatus\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"GpuDriverVersion\\": \\"12\\",\\n \\"SubnetId\\": \\"vsw-uf63bb6*****8gfytm\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"desktop_group_name\\",\\n \\"Value\\": \\"ds-dq2mybjr23yw*****\\"\\n }\\n ],\\n \\"UserOuPath\\": \\"example.com\\",\\n \\"IsLdap\\": true,\\n \\"UserGroupName\\": \\"\\",\\n \\"PolicyGroupIdList\\": [\\n \\"\\"\\n ],\\n \\"PolicyGroupNameList\\": [\\n \\"\\"\\n ],\\n \\"SimpleUserGroupId\\": \\"\\",\\n \\"ExpiredTimes\\": [\\n \\"\\"\\n ],\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n String\\tcaeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n \\n 2022-02-17T14:51:07Z\\n PrePaid\\n test-policy\\n 1007214305******\\n 10\\n 80\\n pg-53iyi2aar0nd6c8qj\\n bundle_eds_general_4c8g_s8d5_win2019\\n 1\\n 16384\\n 16 GiB\\n cn-hangzhou+dir-adde******\\n test\\n cloud_ssd\\n test1\\n cloud_ssd\\n cn-hangzhou+dir-467671****\\n 1000\\n 1\\n 1\\n 50\\n dg-2i8qxpv6t1a03****\\n testName\\n SIMPLE\\n 4\\n 2022-03-17T16:00:00Z\\n test\\n SIMPLE\\n 1\\n 0\\n \\n","errorExample":""}]', - 'title' => 'DescribeDesktopGroups', - ], - 'ExportDesktopGroupInfo' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeCens', + 'summary' => 'Queries the details of all Cloud Enterprise Network (CEN) instances within an Alibaba Cloud account.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCens'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCens', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cens\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"CreationTime\\": \\"2021-06-16T08:46Z\\",\\n \\"Ipv6Level\\": \\"DISABLED\\",\\n \\"Description\\": \\"test\\",\\n \\"CenId\\": \\"cen-3gwy16dojz1m65****\\",\\n \\"ProtectionLevel\\": \\"REDUCED\\",\\n \\"Name\\": \\"testCen\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ],\\n \\"PackageIds\\": [\\n {\\n \\"PackageId\\": \\"cenbwp-4c2zaavbvh5f42****\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCenterPolicyList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16908,3587 +12843,4540 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259955', + 'abilityTreeNodes' => ['FEATUREgwsN6S2WW'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number of the current page in a paged query. Paging starts from page 1. '."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries per page in a paged query. Paging is used to return results in batches.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', + 'description' => 'The list of cloud desktop policy IDs.', + 'type' => 'array', + 'items' => ['description' => 'The cloud desktop policy ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-467671****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopGroupName', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the cloud computer share.'."\n", + 'description' => 'The effective scope of the cloud desktop policy.', + 'enumValueTitles' => ['IP' => 'effective for specified IP addresses.', 'GLOBAL' => 'effective globally.'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'test', + 'example' => 'GLOBAL', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", + 'description' => 'The business type.', + 'enumValueTitles' => [1 => 'public cloud.', 8 => 'commercial edition.'], 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'required' => true, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['app' => 'cloud application.', 'desktop' => 'cloud desktop.'], 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'required' => true, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'PortProxy', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the security policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-53iyi2aar0nd6****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ChargeType', + 'name' => 'ModelLibrary', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AcademicProxy', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The billing method of the cloud computer share.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go.'."\n" - .'* PrePaid: subscription.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'DescribePolicyGroups' => [ + 'description' => 'The details of the cloud desktop policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the cloud desktop policies.', + 'type' => 'object', + 'properties' => [ + 'PolicyStatus' => ['description' => 'The cloud desktop policy status.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''], + 'Html5Access' => ['description' => 'The web client access policy.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'WatermarkType' => ['description' => 'The watermark type.', 'type' => 'string', 'example' => 'EndUserId', 'title' => ''], + 'WatermarkCustomText' => ['description' => 'If the `WatermarkType` parameter is set to `custom`, you must also specify the custom text content by using the `WatermarkCustomText` parameter.', 'type' => 'string', 'example' => 'custom-watermark', 'title' => ''], + 'Clipboard' => ['description' => 'The clipboard permission.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'PolicyGroupId' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'PrinterRedirection' => ['description' => 'The printer redirection policy.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'Html5FileTransfer' => ['description' => 'The web client file transfer policy.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'UsbRedirect' => ['description' => 'The USB redirection setting.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'PolicyGroupType' => ['description' => 'The policy type.', 'type' => 'string', 'example' => 'SYSTEM', 'title' => ''], + 'Watermark' => ['description' => 'The watermark setting.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'VisualQuality' => ['description' => 'The image display quality policy.', 'type' => 'string', 'example' => 'medium', 'title' => ''], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'testPolicyGroupName', 'title' => ''], + 'LocalDrive' => ['description' => 'The local drive mapping permission.', 'type' => 'string', 'example' => 'readwrite', 'title' => ''], + 'AuthorizeSecurityPolicyRules' => [ + 'description' => 'The list of security group control rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of security group control rules.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The direction of the security group control rule.', 'type' => 'string', 'example' => 'inflow', 'title' => ''], + 'Policy' => ['description' => 'The authorization policy of the security group control rule.', 'type' => 'string', 'example' => 'accept', 'title' => ''], + 'Description' => ['description' => 'The description of the security group control rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'PortRange' => ['description' => 'The port range of the security group control rule.', 'type' => 'string', 'example' => '22/22', 'title' => ''], + 'IpProtocol' => ['description' => 'The protocol type of the security group control rule.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'Priority' => ['description' => 'The priority of the security group control rule. A smaller value indicates a higher priority.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'The target of the security group control rule, which is an IPv4 CIDR block.', 'type' => 'string', 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AuthorizeAccessPolicyRules' => [ + 'description' => 'The client access IP whitelist.', + 'type' => 'array', + 'items' => [ + 'description' => 'The client access IP whitelist.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the client access IP CIDR block.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'The client access IP CIDR block, in IPv4 CIDR notation.', 'type' => 'string', 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ClientTypes' => [ + 'description' => 'The logon method control rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The logon method control rules.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether a specific type of client is allowed to log on to the cloud desktop.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'ClientType' => ['description' => 'The client type.', 'type' => 'string', 'example' => 'windows', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GpuAcceleration' => ['description' => 'Indicates whether the image quality policy is enabled for GPU-accelerated cloud desktops. Enable this policy when high performance and user experience are required, such as in professional design scenarios.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'UsbSupplyRedirectRule' => [ + 'description' => 'The USB redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The USB redirection rules.', + 'type' => 'object', + 'properties' => [ + 'VendorId' => ['description' => 'The vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'example' => '04**', 'title' => ''], + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '08**', 'title' => ''], + 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'example' => 'Test rule', 'title' => ''], + 'UsbRedirectType' => ['description' => 'The USB redirection type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'UsbRuleType' => ['description' => 'The USB redirection rule type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DomainResolveRuleType' => ['description' => 'The domain name resolution policy switch.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'DomainResolveRule' => [ + 'description' => 'The domain name resolution policy details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name resolution policy details.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => '*.example.com', 'title' => ''], + 'Policy' => ['description' => 'The resolution policy.', 'type' => 'string', 'example' => 'allow', 'title' => ''], + 'Description' => ['description' => 'The policy description.', 'type' => 'string', 'example' => '测试规则', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NetRedirectRule' => [ + 'description' => 'The network redirection policy details.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.'."\n" + .'>.', + 'type' => 'array', + 'items' => [ + 'description' => 'The network redirection policy details.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.'."\n" + .'>.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => '*.example.com', 'title' => ''], + 'RuleType' => ['description' => 'The rule type.', 'type' => 'string', 'example' => 'domain', 'title' => ''], + 'Policy' => ['description' => 'The redirection policy.', 'type' => 'string', 'example' => 'allow', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Recording' => ['description' => 'Indicates whether screen recording is enabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'RecordingStartTime' => ['description' => 'The screen recording start time, in the format of HH:MM:SS. This value is meaningful only when Recording is set to period.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'RecordingEndTime' => ['description' => 'The screen recording end time, in the format of HH:MM:SS. This value is meaningful only when Recording is set to period.', 'type' => 'string', 'example' => '08:59:00', 'title' => ''], + 'RecordingFps' => ['description' => 'The screen recording frame rate. Unit: FPS (frames per second).', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'RecordingExpires' => ['description' => 'The retention period of screen recording files. Valid values: 1 to 180. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'CameraRedirect' => ['description' => 'Indicates whether local camera redirection is enabled.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'NetRedirect' => ['description' => 'The network redirection setting.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'AppContentProtection' => ['description' => 'Indicates whether the screenshot prevention feature is enabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'RecordContent' => ['description' => 'Indicates whether custom screen recording is enabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'RecordContentExpires' => ['description' => 'The expiration period of custom screen recording files. Default value: 30. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'RemoteCoordinate' => ['description' => 'The keyboard and mouse control permission for remote assistance.', 'type' => 'string', 'example' => 'fullControl', 'title' => ''], + 'RecordingDuration' => ['description' => 'The duration of each screen recording file. Unit: minutes. Recording files are automatically split and uploaded to the storage space based on the specified duration. Files are rolled over when they reach 300 MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Scope' => ['description' => 'The effective scope of the policy.', 'type' => 'string', 'example' => 'GLOBAL', 'title' => ''], + 'ScopeValue' => [ + 'description' => 'The effective CIDR block.', + 'type' => 'array', + 'items' => ['description' => 'The effective CIDR block.', 'type' => 'string', 'example' => '47.100.XX.XX/24', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RecordingAudio' => ['description' => 'The option for recording cloud desktop audio.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'InternetCommunicationProtocol' => ['description' => 'The network communication protocol.', 'type' => 'string', 'example' => 'tcp', 'title' => ''], + 'VideoRedirect' => ['description' => 'The multimedia redirection setting.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'WatermarkTransparencyValue' => ['description' => 'The watermark transparency. A larger value indicates lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'WatermarkColor' => ['description' => 'The watermark font color. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WatermarkFontSize' => ['description' => 'The watermark font size. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'WatermarkFontStyle' => ['description' => 'The watermark font style.', 'type' => 'string', 'example' => 'plain', 'title' => ''], + 'WatermarkDegree' => ['description' => 'The watermark tilt angle. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'example' => '-10', 'title' => ''], + 'WatermarkRowAmount' => ['description' => 'The number of watermark rows.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'EndUserApplyAdminCoordinate' => ['description' => 'Indicates whether users can request administrator assistance.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'EndUserGroupCoordinate' => ['description' => 'Indicates whether users within the same office network can share cloud desktops.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'CpuProtectedMode' => ['description' => 'The CPU protection mode switch.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'CpuRateLimit' => ['description' => 'The overall CPU usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'CpuSampleDuration' => ['description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CpuSingleRateLimit' => ['description' => 'The single-core CPU usage percentage. Valid values: 70 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'CpuDownGradeDuration' => ['description' => 'The CPU throttling duration. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'CpuProcessors' => [ + 'description' => 'The process name.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'chrome.exe', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MemoryProtectedMode' => ['description' => 'The memory protection mode switch.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'MemoryRateLimit' => ['description' => 'The overall memory usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'MemorySampleDuration' => ['description' => 'The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemorySingleRateLimit' => ['description' => 'The memory usage percentage of a single process. Valid values: 30 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemoryDownGradeDuration' => ['description' => 'The memory throttling duration of a single process. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemoryProcessors' => [ + 'description' => 'The process name.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'notepad.exe', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WatermarkSecurity' => ['description' => 'The invisible watermark security priority rule.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'WatermarkAntiCam' => ['description' => 'The invisible watermark anti-photography feature.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'WatermarkPower' => ['description' => 'The invisible watermark enhancement feature.', 'type' => 'string', 'example' => 'medium', 'title' => ''], + 'RecordingUserNotify' => ['description' => 'Indicates whether end users are notified that screen recording is enabled.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'RecordingUserNotifyMessage' => ['description' => 'The notification message displayed to end users about screen recording.', 'type' => 'string', 'example' => 'Screen recording is enabled.', 'title' => ''], + 'AdminAccess' => ['description' => 'Indicates whether the user has administrator permissions after connecting to the cloud desktop.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'MaxReconnectTime' => ['description' => 'The maximum reconnection retry time when the cloud desktop is disconnected due to external reasons. Valid values: 30 to 7200. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'DisplayMode' => ['description' => 'The display mode.', 'type' => 'string', 'example' => 'adminCustom', 'title' => ''], + 'StreamingMode' => ['description' => 'The streaming mode adaptation scenario.', 'type' => 'string', 'example' => 'smooth', 'title' => ''], + 'ColorEnhancement' => ['description' => 'Indicates whether color enhancement is enabled. Common scenarios: design and 3D applications.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'SmoothEnhancement' => ['description' => 'Indicates whether smoothness enhancement is enabled for daily office scenarios.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'QualityEnhancement' => ['description' => 'Indicates whether image quality enhancement is enabled. Common scenarios: design and 3D applications.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'VideoEncPolicy' => ['description' => 'The video encoding policy.', 'type' => 'string', 'example' => 'qualityFirst', 'title' => ''], + 'TargetFps' => ['description' => 'The target frame rate. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'VideoEncMinQP' => ['description' => 'The minimum QP for video encoding, which represents the highest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'VideoEncMaxQP' => ['description' => 'The maximum QP for video encoding, which represents the lowest image quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'VideoEncAvgKbps' => ['description' => 'The average bitrate for video encoding. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'VideoEncPeakKbps' => ['description' => 'The peak bitrate for video encoding. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000', 'title' => ''], + 'DeviceRedirects' => [ + 'description' => 'The device redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The device redirection rules.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => ['description' => 'The peripheral device type.', 'type' => 'string', 'example' => 'camera', 'title' => ''], + 'RedirectType' => ['description' => 'The redirection type.', 'type' => 'string', 'example' => 'usbRedirect', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DeviceRules' => [ + 'description' => 'The custom peripheral device rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom peripheral device rules.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => ['description' => 'The peripheral device type.', 'type' => 'string', 'example' => 'storage', 'title' => ''], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'sandisk', 'title' => ''], + 'DeviceVid' => ['description' => 'The vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'example' => '0x0781', 'title' => ''], + 'DevicePid' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '0x55b1', 'title' => ''], + 'RedirectType' => ['description' => 'The redirection type.', 'type' => 'string', 'example' => 'usbRedirect', 'title' => ''], + 'OptCommand' => ['description' => 'The link optimization instruction.', 'type' => 'string', 'example' => '2:0', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WyAssistant' => ['description' => 'Indicates whether the WUYING AI Assistant entry is provided in the cloud desktop floating ball.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'StatusMonitor' => ['description' => 'Indicates whether the status monitoring entry is provided in the cloud desktop floating ball.', 'type' => 'string', 'example' => 'on', 'title' => ''], + 'MobileRestart' => ['description' => 'Indicates whether the restart button is provided in the cloud desktop floating ball when connecting through a mobile client (Android client and iOS client).'."\n" + ."\n" + .'> Applicable only to mobile clients V7.4 or later.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'MobileShutdown' => ['description' => 'Indicates whether the shutdown button is provided in the cloud desktop floating ball when connecting through a mobile client (Android client and iOS client).'."\n" + ."\n" + .'> Applicable only to mobile clients V7.4 or later.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'DesktopCount' => ['description' => 'The number of cloud desktops associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DesktopGroupCount' => ['description' => 'The number of cloud desktop pools associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ResourceGroupCount' => ['description' => 'The number of resource groups associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ResolutionModel' => ['description' => 'The resolution type.', 'type' => 'string', 'example' => 'adaptive', 'title' => ''], + 'ResolutionWidth' => ['description' => 'The resolution width. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], + 'ResolutionHeight' => ['description' => 'The resolution height. Unit: pixels.', 'type' => 'integer', 'format' => 'int32', 'example' => '1280', 'title' => ''], + 'Taskbar' => ['description' => 'The application taskbar.'."\n" + .'> Applicable only to cloud application policies.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'NoOperationDisconnect' => ['description' => 'The no-operation disconnect setting.'."\n" + .'> Applicable only to cloud application policies.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'NoOperationDisconnectTime' => ['description' => 'The no-operation disconnect duration. Unit: seconds.'."\n" + .'> Applicable only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'DisconnectKeepSession' => ['description' => 'The session retention on disconnect setting.'."\n" + .'> Applicable only to cloud application policies.', 'type' => 'string', 'example' => 'persistent', 'title' => ''], + 'DisconnectKeepSessionTime' => ['description' => 'The session retention duration on disconnect. Unit: seconds.'."\n" + .'> Applicable only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'DomainRegisterValue' => ['description' => 'The effective field for domain name resolution.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RecordEventFilePaths' => [ + 'description' => 'The absolute paths for file monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'The absolute paths for file monitoring in screen recording audit.', 'type' => 'string', 'example' => 'd:/data', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RecordEventRegisters' => [ + 'description' => 'The absolute paths for registry monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'The absolute paths for registry monitoring in screen recording audit.', 'type' => 'string', 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', 'title' => ''], + 'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', + 'title' => '', + ], + 'RecordEventDuration' => ['description' => 'The screen recording duration after an event is detected in screen recording audit. Unit: minutes. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'InternetPrinter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SafeMenu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ScreenDisplayMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientControlMenu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferSpeedLocation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferSpeed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpdDriveClipboard' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UseTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResolutionDpi' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'HoverConfigMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientHibernate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientRestart' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientShutdown' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverHibernate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverRestart' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverShutdown' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MultiScreen' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AcademicProxy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ModelLibrary' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PortProxy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WatermarkShadow' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MobileWyAssistant' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MobileSafeMenu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MobileWuyingKeeper' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExternalDrive' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'KmsServerConfig' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'KmsServer' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientCreateSnapshot' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DiskOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpuOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemoryOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AdminMonitor' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'KeyboardControl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AdminKeyboardOnWindows' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AdminKeyboardOnFullScreen' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NetworkPrinter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndUserCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResetDesktop' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DeviceConnectHint' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileMigrate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WuyingKeeper' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AutoReconnect' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'PrePaid', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query region-free policies', + 'summary' => 'Queries the details of region-free policies.', + 'changeSet' => [ + ['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DescribePolicyGroups\\": [\\n {\\n \\"PolicyStatus\\": \\"AVAILABLE\\",\\n \\"Html5Access\\": \\"off\\",\\n \\"WatermarkType\\": \\"EndUserId\\",\\n \\"WatermarkCustomText\\": \\"custom-watermark\\",\\n \\"Clipboard\\": \\"off\\",\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"PrinterRedirection\\": \\"off\\",\\n \\"Html5FileTransfer\\": \\"off\\",\\n \\"UsbRedirect\\": \\"off\\",\\n \\"PolicyGroupType\\": \\"SYSTEM\\",\\n \\"Watermark\\": \\"on\\",\\n \\"VisualQuality\\": \\"medium\\",\\n \\"Name\\": \\"testPolicyGroupName\\",\\n \\"LocalDrive\\": \\"readwrite\\",\\n \\"AuthorizeSecurityPolicyRules\\": [\\n {\\n \\"Type\\": \\"inflow\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Description\\": \\"test\\",\\n \\"PortRange\\": \\"22/22\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Priority\\": \\"1\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"AuthorizeAccessPolicyRules\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"ClientTypes\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"GpuAcceleration\\": \\"off\\",\\n \\"UsbSupplyRedirectRule\\": [\\n {\\n \\"VendorId\\": \\"04**\\",\\n \\"ProductId\\": \\"08**\\",\\n \\"Description\\": \\"Test rule\\",\\n \\"UsbRedirectType\\": 1,\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"off\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"tcp\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 3,\\n \\"EndUserApplyAdminCoordinate\\": \\"off\\",\\n \\"EndUserGroupCoordinate\\": \\"off\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"off\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"Screen recording is enabled.\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 2000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"ResolutionModel\\": \\"adaptive\\",\\n \\"ResolutionWidth\\": 1920,\\n \\"ResolutionHeight\\": 1280,\\n \\"Taskbar\\": \\"off\\",\\n \\"NoOperationDisconnect\\": \\"off\\",\\n \\"NoOperationDisconnectTime\\": 120,\\n \\"DisconnectKeepSession\\": \\"persistent\\",\\n \\"DisconnectKeepSessionTime\\": 120,\\n \\"DomainRegisterValue\\": \\"xxxx\\",\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"MobileWyAssistant\\": \\"\\",\\n \\"MobileSafeMenu\\": \\"\\",\\n \\"MobileWuyingKeeper\\": \\"\\",\\n \\"ExternalDrive\\": \\"\\",\\n \\"KmsServerConfig\\": \\"\\",\\n \\"KmsServer\\": \\"\\",\\n \\"ClientCreateSnapshot\\": \\"\\",\\n \\"DiskOverload\\": \\"\\",\\n \\"CpuOverload\\": \\"\\",\\n \\"MemoryOverload\\": \\"\\",\\n \\"AdminMonitor\\": 0,\\n \\"KeyboardControl\\": \\"\\",\\n \\"AdminKeyboardOnWindows\\": \\"\\",\\n \\"AdminKeyboardOnFullScreen\\": \\"\\",\\n \\"NetworkPrinter\\": \\"\\",\\n \\"EndUserCount\\": \\"\\",\\n \\"OrganizationCount\\": \\"\\",\\n \\"ResetDesktop\\": \\"\\",\\n \\"DeviceConnectHint\\": \\"\\",\\n \\"FileMigrate\\": \\"\\",\\n \\"WuyingKeeper\\": \\"\\",\\n \\"AutoReconnect\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeClientEvents' => [ + 'summary' => 'Query end-user operation logs for events such as starting and stopping a WUYING Workspace, and disconnecting from sessions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ExpiredTime', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the end user, which can be a RAM user ID or an AD username. If you omit this parameter, the operation returns events for all users in the region.', 'type' => 'string', 'required' => false, 'example' => '28961708130834****', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud desktop. If you omit this parameter, the operation returns events for all cloud desktops in the region.', 'type' => 'string', 'required' => false, 'example' => 'ecd-8fupvkhg0aayu****', 'title' => ''], + ], + [ + 'name' => 'DesktopIp', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the cloud desktop. If you omit this parameter, the operation returns events for all cloud desktops in the region.', 'type' => 'string', 'required' => false, 'example' => '10.10.*.*', 'title' => ''], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not in use.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'To be hidden.', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the office network to which the cloud desktop belongs. If you omit this parameter, the operation returns events for users in all office networks in the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', 'title' => ''], + ], + [ + 'name' => 'EventType', 'in' => 'query', 'schema' => [ - 'description' => 'The expiration date of the subscription cloud computer share.'."\n", + 'description' => 'The event type to query. If EventTypes is specified, this parameter is ignored. If you omit both this parameter and EventTypes, the operation returns all events.', + 'enumValueTitles' => ['DESKTOP_STOP' => 'stop', 'GET_LITE_CONNECTION_TICKET' => 'automatic reconnection ticket request', 'DESKTOP_DISCONNECT' => 'session disconnection', 'GET_CONNECTION_TICKET' => 'cloud desktop connection request', 'CLIENT_LOGIN' => 'user login', 'DESKTOP_REBOOT' => 'reboot', 'DESKTOP_CONNECT' => 'session establishment', 'DESKTOP_START' => 'start'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '2022-12-31T15:59Z', + 'example' => 'DESKTOP_DISCONNECT', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.
'."\n" + .'If you omit this parameter, the query returns events that occurred before the time specified by `EndTime`.
', 'type' => 'string', 'required' => false, 'example' => '2020-11-30T06:32:31Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.
'."\n" + .'If you omit this parameter, the operation uses the current time.
', 'type' => 'string', 'required' => false, 'example' => '2020-11-31T06:32:31Z', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on each page.
'."\n" + .'Default value: 100.
', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous response to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the office network.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'EventTypes', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer shares.'."\n", + 'description' => 'An array of event types to query. The operation returns events that match any of the specified types.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the cloud computer share. You can specify 1 to 100 IDs of cloud computer shares.'."\n", + 'description' => 'The event type.', + 'enumValueTitles' => ['DESKTOP_STOP' => 'stop', 'GET_LITE_CONNECTION_TICKET' => 'automatic reconnection ticket request', 'DESKTOP_DISCONNECT' => 'session disconnection', 'GET_CONNECTION_TICKET' => 'cloud desktop connection request', 'CLIENT_LOGIN' => 'user login', 'DESKTOP_REBOOT' => 'reboot', 'DESKTOP_CONNECT' => 'session establishment', 'DESKTOP_START' => 'start'], 'type' => 'string', 'required' => false, - 'example' => 'dg-2i8qxpv6t1a03****', + 'example' => 'DESKTOP_START', + 'title' => '', ], 'required' => false, - 'maxItems' => 100, + 'docRequired' => true, + 'maxItems' => 50, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EndUserId', + 'name' => 'Language', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FillHardwareInfo', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The IDs of the users to be authorized.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user to be authorized. You can specify 1 to 100 user IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The pagination token. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '28A40F12-F340-442B-A35F-46EF6A03227B', 'title' => ''], + 'Events' => [ + 'description' => 'The list of user events.', + 'type' => 'array', + 'items' => [ + 'description' => 'A user event.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the event. This parameter is returned for `DESKTOP_DISCONNECT` and `GET_CONNECTION_TICKET` events. Valid values:'."\n" + ."\n" + .'- `200`: Success.'."\n" + ."\n" + .'- An error message, such as `FailedToGetConnectionTicket`.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'BytesReceived' => ['description' => 'The number of bytes received.', 'type' => 'string', 'example' => '8665', 'title' => ''], + 'DesktopIp' => ['description' => 'The IP address of the cloud desktop.', 'type' => 'string', 'example' => '10.10.XX.XX', 'title' => ''], + 'EventTime' => ['description' => 'The time the event occurred.', 'type' => 'string', 'example' => '2020-11-30T06:32:31Z', 'title' => ''], + 'BytesSend' => ['description' => 'The number of bytes sent.', 'type' => 'string', 'example' => '2345', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the cloud desktop\'s office site.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', 'title' => ''], + 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account associated with the event.', 'type' => 'string', 'example' => '112259558861****', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-8fupvkhg0aayu****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'EventId' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '5651188b-3070-d1cc-5311-75753d59****', 'title' => ''], + 'DirectoryType' => ['description' => 'The directory type.', 'type' => 'string', 'example' => 'RAM', 'title' => ''], + 'EventType' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'DESKTOP_DISCONNECT', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the end user. The value can be the ID of a RAM user or the username of an AD user.', 'type' => 'string', 'example' => '28961708130834****', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => '100.68.*.*', 'title' => ''], + 'ClientOS' => ['description' => 'The operating system of the client.', 'type' => 'string', 'example' => 'Darwin 17.7.0 x64', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The type of account system for the office site.', + 'enumValueTitles' => ['SIMPLE' => 'convenience account', 'AD_CONNECTOR' => 'enterprise AD account'], + 'type' => 'string', + 'example' => 'SIMPLE', + 'title' => '', + ], + 'DirectoryId' => ['description' => 'The ID of the cloud desktop\'s directory.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', 'title' => ''], + 'ClientVersion' => ['description' => 'The client version.', 'type' => 'string', 'example' => '1.0.4 202012021700', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The name of the office site.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'example' => 'dg-kadkdfaf****', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the desktop group.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'Description' => ['description' => 'The description of the event.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TerminalInfo' => [ + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SerialNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Model' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'required' => false, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeClientEvents', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-19T06:25:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-11T09:27:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-08T08:41:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClientEvents'], + ], + ], + 'ramActions' => [ [ - 'name' => 'LangType', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeClientEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03227B\\",\\n \\"Events\\": [\\n {\\n \\"Status\\": \\"200\\",\\n \\"BytesReceived\\": \\"8665\\",\\n \\"DesktopIp\\": \\"10.10.XX.XX\\",\\n \\"EventTime\\": \\"2020-11-30T06:32:31Z\\",\\n \\"BytesSend\\": \\"2345\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"AliUid\\": \\"112259558861****\\",\\n \\"DesktopId\\": \\"ecd-8fupvkhg0aayu****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EventId\\": \\"5651188b-3070-d1cc-5311-75753d59****\\",\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"EventType\\": \\"DESKTOP_DISCONNECT\\",\\n \\"EndUserId\\": \\"28961708130834****\\",\\n \\"ClientIp\\": \\"100.68.*.*\\",\\n \\"ClientOS\\": \\"Darwin 17.7.0 x64\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"ClientVersion\\": \\"1.0.4 202012021700\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"DesktopName\\": \\"test\\",\\n \\"DesktopGroupId\\": \\"dg-kadkdfaf****\\",\\n \\"DesktopGroupName\\": \\"testName\\",\\n \\"Description\\": \\"test\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"Model\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeCloudDiskGroupDrives' => [ + 'summary' => 'Lists cloud disk group drives.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise cloud disk ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-6805637***', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The team drive name.', 'type' => 'string', 'example' => 'Team 1', 'required' => false, 'docRequired' => false, 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page for paged queries.'."\n" + ."\n" + .'- Maximum: 100'."\n" + ."\n" + .'- Default: 20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', 'in' => 'query', + 'schema' => ['description' => 'The token that marks the start of the next query. An empty NextToken means no more results.', 'type' => 'string', 'required' => false, 'example' => 'MTA0MjA=', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The language of the response.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'zh-CN' => '', - 'en-GB' => '', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that marks the start of the next query. An empty NextToken means no more results.', 'type' => 'string', 'example' => 'MTA0MjA=', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B9F9CBBE-8A9F-5FE5-8A72-0E81C2401A91', 'title' => ''], + 'Count' => ['description' => 'The total number of results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'CloudDriveGroups' => [ + 'description' => 'The list of cloud disk team drives.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of cloud disk team drives.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the team drive.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GroupId' => ['description' => 'The team drive ID.', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****', 'title' => ''], + 'GroupName' => ['description' => 'The team drive name.', 'type' => 'string', 'example' => 'Test team 1', 'title' => ''], + 'DirectoryId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****', 'title' => ''], + 'DriveId' => ['description' => 'The drive ID.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'CreateTime' => ['description' => 'The time the drive was created.', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z', 'title' => ''], + 'TotalSize' => ['description' => 'The total capacity of the cloud disk team drive.', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120', 'title' => ''], + 'UsedSize' => ['description' => 'The used space size, in bytes.', 'type' => 'string', 'example' => '1024000000', 'title' => ''], + 'OrgId' => ['description' => 'The organization ID of the team.', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'zh-CN', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"MTA0MjA=\\",\\n \\"RequestId\\": \\"B9F9CBBE-8A9F-5FE5-8A72-0E81C2401A91\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query cloud drive group spaces', + 'description' => 'Cloud disk team drives are synced from the Alibaba Cloud Workspace client to User Management > organization chart. To use a team drive, you can move users to the target organization in the User Management interface. Users then see the team drive menu bar in the cloud disk client.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Tag', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDiskGroupDrives', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'DescribeCloudDiskGroups' => [ + 'summary' => 'Lists cloud disk groups.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise cloud drive that you created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-0456357992', 'title' => ''], + ], + [ + 'name' => 'GroupId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags. You can specify up to 20 tags.'."\n", + 'description' => 'The group ID.', 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'A list of team space IDs.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], 'required' => false, + 'docRequired' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The team space name.', 'type' => 'string', 'example' => 'Test team 1', 'required' => false, 'docRequired' => false, 'title' => ''], + ], + [ + 'name' => 'ParentOrgId', + 'in' => 'query', + 'schema' => ['description' => 'The parent organization ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'root', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The download URL of the XLSX file that contains cloud computer shares. The XLSX file provides the following information:'."\n" - ."\n" - .'* Cloud computer share ID/name'."\n" - .'* Office network ID/name'."\n" - .'* Cloud computer share template'."\n" - .'* vCPUs/Memory size'."\n" - .'* System disk/Data disk'."\n" - .'* Security policy name'."\n" - .'* Number of authorized users'."\n" - .'* Billing method'."\n" - .'* Creation time'."\n" - .'* Expiration time'."\n", - 'type' => 'string', - 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC', + 'NextToken' => ['description' => 'The token used to start the next query. If NextToken is empty, no more results are available.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D648DBF7-9476-53D6-98AB-674836021DFB', 'title' => ''], + 'Count' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation succeeded. Valid values: true and false.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'CloudDriveGroups' => [ + 'description' => 'A list of cloud drive team spaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'A list of cloud drive team spaces.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the team space.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'GroupId' => ['description' => 'The team space ID.', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****', 'title' => ''], + 'GroupName' => ['description' => 'The team space name.', 'type' => 'string', 'example' => 'Test team 1', 'title' => ''], + 'DirectoryId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****', 'title' => ''], + 'DriveId' => ['description' => 'The space ID.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the resource was created.', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z', 'title' => ''], + 'TotalSize' => ['description' => 'The total capacity of the cloud drive team space, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120', 'title' => ''], + 'UsedSize' => ['description' => 'The amount of space used, in bytes.', 'type' => 'string', 'example' => '1024000000', 'title' => ''], + 'OrgId' => ['description' => 'The organization ID of the team.', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ExportDesktopGroup.UnknowError', - 'errorMessage' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"D648DBF7-9476-53D6-98AB-674836021DFB\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query cloud drive groups', + 'description' => 'After you enable security protection, the system automatically scans Cloud Desktop for system vulnerabilities once a day.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDiskGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********\\",\\n \\"RequestId\\": \\"24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********\\n 24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC\\n","errorExample":""}]', - 'title' => 'ExportDesktopGroupInfo', - 'summary' => 'Exports cloud computer shares and saves the list as an XLSX file. Each entry includes the ID and name of the cloud computer share, the ID and name of the office network, the cloud computer share template, and the name of the security policy.', + 'translator' => 'machine', ], - 'DescribeDesktopsInGroup' => [ - 'summary' => 'Queries the cloud computers in a share by billing method.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeCloudDriveGroups' => [ + 'summary' => 'Query the list and basic information of all team shared drives in the enterprise cloud drive.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', - ], + 'schema' => ['description' => 'The ID of the cloud disk in Cloud Drive Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****', 'title' => ''], ], [ - 'name' => 'PayType', + 'name' => 'GroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The billing method of the cloud computer share.', - 'type' => 'string', + 'description' => 'The team ID.', + 'type' => 'array', + 'items' => ['description' => 'The team ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', + 'docRequired' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The team name for fuzzy search.', 'type' => 'string', 'example' => 'Test team 1', 'required' => false, 'docRequired' => true, 'title' => ''], + ], + [ + 'name' => 'ParentGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent node. If a parent node ID is specified, the subnodes are queried. If you set the value of this parameter to root, the root node is queried.'."\n" + ."\n" + .'Default value: null. The default value indicates that all nodes are queried.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cg-e70ga4ixp30ur****', 'title' => ''], + ], + [ + 'name' => 'DriveStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of entries per page.'."\n" + 'description' => 'The team space status. Valid values:'."\n" ."\n" - .'* Default value: 10.'."\n" - .'* Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'- enabled'."\n" + ."\n" + .'- disabled'."\n" + ."\n" + .'Default value: enabled.', + 'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '可用 \\[默认值]'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', + 'docRequired' => true, + 'example' => 'enabled', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'GroupType', 'in' => 'query', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.', + 'description' => 'The team type.'."\n" + ."\n" + .'- org: organizational structure'."\n" + ."\n" + .'- directory: workspace'."\n" + ."\n" + .'Default value: null. The default value indicates that all types of teams are queried.', + 'enumValueTitles' => ['org' => '组织架构', 'directory' => '办公网络'], 'type' => 'string', 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'docRequired' => true, + 'example' => 'org', + 'title' => '', ], ], [ - 'name' => 'IgnoreDeleted', + 'name' => 'DriveType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'Specifies whether to ignore deletion flags.'."\n" + 'description' => 'Specifies whether the space is increased.'."\n" ."\n" - .'Default value: true. Valid values:'."\n" + .'- binding: increased'."\n" ."\n" - .'* true: ignores deletion flags. The cloud computers that were deleted are returned.'."\n" - .'* false: does not ignore deletion flags. The cloud computers that were deleted are not returned.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + .'- unbound: not increased'."\n" + ."\n" + .'Default value: null. The default value indicates that all spaces are queried.', + 'enumValueTitles' => ['unbound' => '没有添加空间', 'binding' => '添加了空间'], + 'type' => 'string', + 'docRequired' => true, + 'required' => true, + 'example' => 'binding', + 'title' => '', ], ], [ - 'name' => 'CustomStartTimePeriod', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], ], [ - 'name' => 'CustomEndTimePeriod', + 'name' => 'DirectoryName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDirectoryName ', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Valid values: 1 to 100'."\n" + ."\n" + .'- Default value: 20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lY3I2VNHLwy+nIoSXh****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PostPaidDesktopsCount' => [ - 'description' => 'The total number of pay-as-you-go cloud computers.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n" - .'If NextToken is empty, no next page exists.', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'PaidDesktopsCount' => [ - 'description' => 'The total number of subscription cloud computers.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'PostPaidDesktopsTotalAmount' => [ - 'description' => 'The total amount of bills for pay-as-you-go cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', + 'NextToken' => ['description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EF015AE5-B30A-5189-B519-735CEE40****', 'title' => ''], + 'Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], - 'PaidDesktops' => [ - 'description' => 'The subscription cloud computers.', + 'CloudDriveGroups' => [ + 'description' => 'The list of team spaces.', 'type' => 'array', 'items' => [ - 'description' => 'The subscription cloud desktop.'."\n", 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the authorized user.', - 'type' => 'string', - 'example' => 'alice', - ], - 'DesktopStatus' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Starting'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Rebuilding'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Stopping'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Expired'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Deleted'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Pending'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Running', - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'ConnectionStatus' => [ - 'description' => 'The connection status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Unknown'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Connected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Disconnected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => '', - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ud-7ftf5b6yu77b0****', - ], - 'EndUserName' => [ - 'description' => 'The username of the authorized user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'ManagementFlag' => [ - 'description' => 'The flag that is used to manage the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Updating: The configurations of the cloud computer are being updated.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoFlag: No flags are attached to the cloud computer.'."\n" + 'Status' => [ + 'description' => 'The team space status. Valid values:'."\n" ."\n" - .' '."\n" + .'- enabled'."\n" ."\n" - .' '."\n" + .'- disabled'."\n" ."\n" - .' '."\n", + .'Default value: enabled.', + 'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '可用 \\[默认值]'], 'type' => 'string', - 'enumValueTitles' => [ - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', - ], - 'EndUserIds' => [ - 'description' => 'The IDs of the end users who are connected to the cloud computers in the cloud computer share. If no end users are connected, no values are returned for this parameter.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - ], - 'EndUserNames' => [ - 'description' => 'The usernames of the end users who are connected to the cloud computers in the cloud computer share. If no end users are connected, no values are returned for this parameter.', + 'example' => 'enabled', + 'title' => '', + ], + 'GroupId' => ['description' => 'The team ID.', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****', 'title' => ''], + 'GroupName' => ['description' => 'The name of the team space.', 'type' => 'string', 'example' => 'Test team 1', 'title' => ''], + 'DirectoryId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****', 'title' => ''], + 'DriveId' => ['description' => 'The team space ID.', 'type' => 'string', 'example' => 'sh1234', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the team space was created.', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z', 'title' => ''], + 'TotalSize' => ['description' => 'The total capacity of the team space.', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120', 'title' => ''], + 'UsedSize' => ['description' => 'The capacity of the used space. Unit: bytes.', 'type' => 'string', 'example' => '1024000000', 'title' => ''], + 'RecycleBinSize' => ['description' => 'Size of the recycle bin for the team space. Unit: Byte.', 'type' => 'string', 'example' => '1024000', 'title' => ''], + 'AdminUserIds' => ['description' => 'List of group administrators.', 'type' => 'string', 'example' => '["user01"]', 'title' => ''], + 'OrgId' => ['description' => 'Organization ID of the team.', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id', 'title' => ''], + 'AdminUserInfos' => [ + 'description' => 'Administrator information for the group space.', 'type' => 'array', 'items' => [ - 'description' => 'The username of the user.'."\n", - 'type' => 'string', - 'example' => 'alice', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'Administrator username (may be unreadable when imported from a third party).', 'type' => 'string', 'example' => 'user01', 'title' => ''], + 'NickName' => ['description' => 'Administrator nickname.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'RealNickName' => ['description' => 'Administrator nickname.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'Remark' => ['description' => 'Remark.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'Phone' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '12345678', 'title' => ''], + 'Email' => ['description' => 'Mailbox.', 'type' => 'string', 'example' => '123@aliyun.com', 'title' => ''], + 'JobNumber' => ['description' => 'Job number (DingTalk)', 'type' => 'string', 'example' => '12345', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ResetTime' => [ - 'description' => 'The time when the cloud computer was reset.'."\n", + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"EF015AE5-B30A-5189-B519-735CEE40****\\",\\n \\"Count\\": 0,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"enabled\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"sh1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"RecycleBinSize\\": \\"1024000\\",\\n \\"AdminUserIds\\": \\"[\\\\\\"user01\\\\\\"]\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\",\\n \\"AdminUserInfos\\": [\\n {\\n \\"EndUserId\\": \\"user01\\",\\n \\"NickName\\": \\"John Doe\\",\\n \\"RealNickName\\": \\"John Doe\\",\\n \\"Remark\\": \\"John Doe\\",\\n \\"Phone\\": \\"12345678\\",\\n \\"Email\\": \\"123@aliyun.com\\",\\n \\"JobNumber\\": \\"12345\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list of team shared drives ', + 'changeSet' => [ + ['createdAt' => '2024-12-02T02:36:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-23T12:37:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-11T14:21:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-27T02:25:40.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveGroups'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDriveGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'DescribeCloudDrivePermissions' => [ + 'summary' => 'Query the permission settings details of the enterprise cloud drive. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'ID of the created enterprise cloud drive. ', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-82414*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3', 'title' => ''], + 'CloudDrivePermissionModels' => [ + 'description' => 'List of enterprise cloud drive permission information. ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Permission' => [ + 'description' => 'File transfer permission between the enterprise cloud drive and on-premises devices for the user. ', 'type' => 'string', - 'example' => '2021-03-03 08:48:08', + 'example' => 'CDS_DOWNLOAD', + 'enumValueTitles' => ['CDS_CREATE_DOWNLOAD' => '同时具备上传和下载权限', 'CDS_DOWNLOAD' => '仅具备下载权限', 'CDS_CREATE' => '仅具备上传权限'], + 'title' => '', ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'm-hn5v2mmk0****', + 'EndUsers' => [ + 'description' => 'List of end user IDs. ', + 'type' => 'array', + 'items' => ['description' => 'End user ID. ', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ImageName' => [ - 'description' => 'The image name.'."\n", + ], + 'description' => 'Enterprise cloud drive permission information. ', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3\\",\\n \\"CloudDrivePermissionModels\\": [\\n {\\n \\"Permission\\": \\"CDS_DOWNLOAD\\",\\n \\"EndUsers\\": [\\n \\"alice\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the permission settings details of the enterprise cloud drive ', + 'changeSet' => [ + ['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDrivePermissions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDrivePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DescribeCloudDriveUsers' => [ + 'summary' => 'Retrieves a list of personal drives and their basic information for all users in an enterprise network drive.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. To obtain a list of supported regions, call [DescribeRegions](~~196646~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise network drive.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-066224****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The end user ID.'."\n" + ."\n" + .'If specified, the query returns only the personal drive of that user. If left empty, the query returns the personal drives of all users.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'- Maximum: 100.'."\n" + ."\n" + .'- Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results. This is the `NextToken` value from the previous response. Leave this parameter empty for the first request.', 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token for the next page of results. An empty value indicates that all results have been returned.', 'type' => 'string', 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F083AAE5-7AA9-53BB-9060-AFFB2C18****', 'title' => ''], + 'CloudDriveUsers' => [ + 'description' => 'A list of user personal drives.', + 'type' => 'array', + 'items' => [ + 'description' => 'A user personal drive.', + 'type' => 'object', + 'properties' => [ + 'UsedSize' => ['description' => 'The used storage space, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10485760', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the user personal drive.', + 'enumValueTitles' => ['disabled' => 'Disabled', 'enabled' => 'Enabled'], 'type' => 'string', - 'example' => 'Win10_ZC', - ], - 'SystemDiskSize' => [ - 'description' => 'The system disk size. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', + 'example' => 'enabled', + 'title' => '', ], - 'OsType' => [ - 'description' => 'The OS.'."\n" + 'DriveId' => ['description' => 'The ID of the user personal drive.', 'type' => 'string', 'example' => '8', 'title' => ''], + 'TotalSize' => ['description' => 'Maximum storage capacity for the user’s personal drive, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600', 'title' => ''], + 'UserId' => ['description' => 'The internal ID of the user.', 'type' => 'string', 'example' => 'alice@cn-shanghai.148875033399****', 'title' => ''], + 'UserName' => ['description' => 'The name of the end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'Query the list of user personal drives', + 'changeSet' => [ + ['createdAt' => '2023-06-30T08:54:18.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveUsers'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDriveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\",\\n \\"RequestId\\": \\"F083AAE5-7AA9-53BB-9060-AFFB2C18****\\",\\n \\"CloudDriveUsers\\": [\\n {\\n \\"UsedSize\\": 10485760,\\n \\"Status\\": \\"enabled\\",\\n \\"DriveId\\": \\"8\\",\\n \\"TotalSize\\": 104857600,\\n \\"UserId\\": \\"alice@cn-shanghai.148875033399****\\",\\n \\"UserName\\": \\"alice\\",\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeConfigGroup' => [ + 'summary' => 'Query the configuration group list information. ', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled task configuration', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the configuration group.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Timer: the scheduled task type.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Timer' => ''], + 'example' => 'Timer', + 'title' => '', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service type of the configuration group.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* CLOUD_DESKTOP: the cloud computer service.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['CLOUD_DESKTOP' => ''], + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The status of the configuration groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The state of the configuration group.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AVAILABLE: The configuration group is available.'."\n" + .'* UNAVAILABLE: The configuration group is deleted.'."\n" + .'* DELETING: The configuration group is being deleted.'."\n" + .'* UPDATING: The configuration group is being modified.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['AVAILABLE' => '', 'UNAVAILABLE' => '', 'DELETING' => '', 'UPDATING' => ''], + 'example' => 'AVAILABLE', + 'title' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the configuration groups.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ccg-0cwz8naid24v*****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Data' => [ + 'description' => 'The configuration groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration group.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'example' => 'ccg-0cid8v30an12****', 'title' => ''], + 'Name' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'example' => 'Scheduled task', 'title' => ''], + 'Description' => ['description' => 'The description of the configuration group.'."\n", 'type' => 'string', 'example' => 'Scheduled task information', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the configuration group.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], - 'GpuDriverVersion' => [ - 'description' => 'The version of the GPU driver.'."\n", + .'* Timer: the scheduled task type.'."\n", 'type' => 'string', - 'example' => '1.0', + 'enumValueTitles' => ['Timer' => ''], + 'example' => 'Timer', + 'title' => '', ], - 'DiskType' => [ - 'description' => 'The type of the disk.'."\n" + 'ProductType' => [ + 'description' => 'The service type of the configuration group.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* SYSTEM: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DATA: data disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'ManagementFlags' => [ - 'description' => 'The flags that are used to manage the cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The flag that is used to manage the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Updating: The configurations of the cloud computer are being updated.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoFlag: No flags are attached to the cloud computer.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', - ], - ], - 'MemberEniIp' => [ - 'description' => 'The IP address of the member network interface controller (NIC) of the instance.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'PrimaryEniIp' => [ - 'description' => 'The IP address of the primary NIC of the instance.'."\n", + .'* CLOUD_DESKTOP: the cloud computer service.'."\n", 'type' => 'string', - 'example' => '192.168.XX.XX', + 'enumValueTitles' => ['CLOUD_DESKTOP' => ''], + 'example' => 'CLOUD_DESKTOP', + 'title' => '', ], - 'ProtocolType' => [ - 'description' => 'The protocol.'."\n" + 'Status' => [ + 'description' => 'The state of the configuration group.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ASP: Adaptive Streaming Protocol (ASP) protocol provided by Alibaba Cloud'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'FotaVersion' => [ - 'description' => 'The image version.'."\n", + .'* AVAILABLE: The configuration group is available.'."\n" + .'* UNAVAILABLE: The configuration group is deleted.'."\n" + .'* DELETING: The configuration group is being deleted.'."\n" + .'* UPDATING: The configuration group is being modified.'."\n", 'type' => 'string', - 'example' => '0.1.0-R-20220914.17****', + 'enumValueTitles' => ['AVAILABLE' => '', 'UNAVAILABLE' => '', 'DELETING' => '', 'UPDATING' => ''], + 'example' => 'AVAILABLE', + 'title' => '', ], - 'ExpiredTime' => [ - 'type' => 'string', + 'BindCount' => ['description' => 'The number of resources that are bound to the configuration group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'BindCountMap' => [ + 'description' => 'The number of bound cloud computers.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of bound resources.'."\n", 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'IsUpdate' => ['description' => 'Used for system scheduled task checks. The current scheduled task does not support modification.', 'title' => 'Used for system scheduled task checks. The current scheduled task does not support modification.', 'type' => 'boolean', 'example' => ''], + 'IsBind' => ['description' => 'Used for system scheduled task checks. The current scheduled task does not support detach or attach operations.', 'title' => 'Used for system scheduled task checks. The current scheduled task does not support detach or attach operations.', 'type' => 'boolean', 'example' => ''], + 'InnerTimerName' => ['description' => 'Used for frontend display; maps the system scheduled task name to a code. ', 'title' => 'Used for frontend display; maps the system scheduled task name to a code. ', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE'], + 'InnerTimerDesc' => ['description' => 'Used for frontend display. The system scheduled task description uses a code.', 'title' => 'Used for frontend display. The system scheduled task description uses a code.', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC'], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'PostPaidDesktops' => [ - 'description' => 'The pay-as-you-go cloud computers.'."\n", + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": [\\n {\\n \\"GroupId\\": \\"ccg-0cid8v30an12****\\",\\n \\"Name\\": \\"Scheduled task\\",\\n \\"Description\\": \\"Scheduled task information\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCount\\": 4,\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsUpdate\\": false,\\n \\"IsBind\\": false,\\n \\"InnerTimerName\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE\\",\\n \\"InnerTimerDesc\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20\\n}","type":"json"}]', + 'title' => 'Query the configuration group list', + 'changeSet' => [ + ['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'DescribeCustomizedListHeaders' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can invoke [DescribeRegions](~~196646~~) to obtain the list of regions supported by WUYING Workspace. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ListType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The list type. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['desktop' => ''], + 'example' => 'desktop', + 'title' => '', + ], + ], + [ + 'name' => 'LangType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language type for exporting the WUYING Workspace list. ', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['zh-CN' => '', 'en-GB' => ''], + 'example' => 'zh-CN', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'A collection of returned information. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. ', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Headers' => [ + 'description' => 'The list of table headers. ', 'type' => 'array', 'items' => [ - 'description' => 'The pay-as-you-go cloud computer.'."\n", + 'description' => 'A table header. ', 'type' => 'object', 'properties' => [ - 'CreateDuration' => [ - 'description' => 'The retention period. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '4153958447', - ], - 'EndUserId' => [ - 'description' => 'The ID of the authorized user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'DesktopStatus' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Starting'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Rebuilding'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Stopping'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Expired'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Deleted'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Pending'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Stopped', - ], - 'CreateTime' => [ - 'description' => 'The time when the cloud computer was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-21T06:34:57Z', - ], - 'ReleaseTime' => [ - 'description' => 'The time when the cloud computer was released.'."\n", - 'type' => 'string', - 'example' => '2022-01-21T16:34:57Z', - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'ConnectionStatus' => [ - 'description' => 'The connection status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Unknown'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Connected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Disconnected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => '', - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ud-2i8qxpv6t1a07****', - ], - 'EndUserName' => [ - 'description' => 'The username of the authorized user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'ManagementFlag' => [ - 'description' => 'The flag that is used to manage the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Updating: The configurations of the cloud computer are being updated.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoFlag: No flags are attached to the cloud computer.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', - ], - 'EndUserIds' => [ - 'description' => 'The IDs of the end users who are connected to the cloud computers in the cloud computer pool. If no end users are connected, no values are returned for this parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - ], - 'EndUserNames' => [ - 'description' => 'The usernames of the end users who are connected to the cloud computers in the cloud computer pool. If no end users are connected, no values are returned for this parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username of the user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - ], - 'ResetTime' => [ - 'description' => 'The time when the cloud computer was reset.'."\n", - 'type' => 'string', - 'example' => '2021-03-03 08:48:08', - ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'm-hn5v2mmk0****', - ], - 'ImageName' => [ - 'description' => 'The image name.'."\n", - 'type' => 'string', - 'example' => 'Win10_ZC', - ], - 'SystemDiskSize' => [ - 'description' => 'The system disk size. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'OsType' => [ - 'description' => 'The OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], - 'GpuDriverVersion' => [ - 'description' => 'The version of the GPU driver.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'DiskType' => [ - 'description' => 'The type of the disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DATA: data disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'ManagementFlags' => [ - 'description' => 'The flags that are used to manage the cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The flag that is used to manage the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Updating: The configurations of the cloud computer are being updated.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NoFlag: No flags are attached to the cloud computer.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Updating' => '', - 'NoFlag' => '', - ], - 'example' => 'NoFlag', - ], - ], - 'MemberEniIp' => [ - 'description' => 'The IP address of the member NIC of the instance.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'PrimaryEniIp' => [ - 'description' => 'The IP address of the primary NIC of the instance.'."\n", - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'ProtocolType' => [ - 'description' => 'The protocol.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: HDX protocol'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ASP: ASP protocol provided by Alibaba Cloud'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'HDX', - ], - 'FotaVersion' => [ - 'description' => 'The image version.'."\n", + 'DisplayType' => [ + 'description' => 'The display type of the table header. You can invoke [ModifyCustomizedListHeaders](~~452324~~) to change it. ', 'type' => 'string', - 'example' => '0.1.0-R-20220914.17****', + 'enumValueTitles' => ['hide' => '', 'display' => '', 'required' => ''], + 'example' => 'display', + 'title' => '', ], + 'HeaderKey' => ['description' => 'The key of the table header. ', 'type' => 'string', 'example' => 'system_data_disk', 'title' => ''], + 'HeaderName' => ['description' => 'The name of the table header. ', 'type' => 'string', 'example' => 'System disk/Data disk', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'OnlinePrePaidDesktopsCount' => [ - 'description' => 'The number of subscription cloud computers that are in the Connected state.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'RunningPrePaidDesktopsCount' => [ - 'description' => 'The number of subscription cloud computers that are in the Running state.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'StopedPrePaidDesktopsCount' => [ - 'description' => 'The number of subscription cloud computers that are in the Stopped state.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'StoppedPrePaidDesktopsCount' => [ - 'description' => 'The number of subscription cloud computers that are in the Stopped state.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PostPaidDesktopsCount\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"PaidDesktopsCount\\": 10,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PostPaidDesktopsTotalAmount\\": 10000,\\n \\"PaidDesktops\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-7ftf5b6yu77b0****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\",\\n \\"ExpiredTime\\": \\"\\"\\n }\\n ],\\n \\"PostPaidDesktops\\": [\\n {\\n \\"CreateDuration\\": \\"4153958447\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Stopped\\",\\n \\"CreateTime\\": \\"2022-01-21T06:34:57Z\\",\\n \\"ReleaseTime\\": \\"2022-01-21T16:34:57Z\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-2i8qxpv6t1a07****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"HDX\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\"\\n }\\n ],\\n \\"OnlinePrePaidDesktopsCount\\": 100,\\n \\"RunningPrePaidDesktopsCount\\": 100,\\n \\"StopedPrePaidDesktopsCount\\": 100,\\n \\"StoppedPrePaidDesktopsCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n hx-test-3\\n ecd-2i8qxpv6t1a04qpu1\\n 0\\n Running\\n NoFlag\\n \\n 1\\n 5399F876-8F01-5767-A1FD-21F2EE3C3323\\n","errorExample":""}]', - 'title' => 'DescribeDesktopsInGroup', - ], - 'DisableDesktopsInGroup' => [ - 'summary' => 'Disables specific cloud computers in a cloud computer share. After you call this operation to disable specific cloud computers, they enter the unavailable state.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Headers\\": [\\n {\\n \\"DisplayType\\": \\"display\\",\\n \\"HeaderKey\\": \\"system_data_disk\\",\\n \\"HeaderName\\": \\"System disk/Data disk\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain the Table Headers of the WUYING Workspace List ', + 'summary' => 'Obtain the table header information of the WUYING Workspace list page. ', + 'changeSet' => [ + ['createdAt' => '2022-09-09T06:33:35.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCustomizedListHeaders'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCustomizedListHeaders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeDesktopGroupSessions' => [ + 'summary' => 'Queries cloud computer shares.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [](t2167755.xdita#)operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SessionStatus', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'description' => 'The status of the session.', + 'enumValueTitles' => ['Connected' => '', 'Disconnected' => ''], 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'Connected', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'OwnType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.', - 'type' => 'string', - 'required' => true, - 'example' => 'dg-2i8qxpv6t1a03****', + 'description' => 'The type of the session.', + 'enumValueTitles' => ['Single-session', 'Multi-session'], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'DesktopIds', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The user ID of the terminal that connects to the session.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2022-08-31T06:56:45Z"', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2022-08-31T06:56:45Z"', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ljnKKgSRjo8yXAIT5QSvkU', 'title' => ''], + ], + [ + 'name' => 'FillTerminalInfo', + 'in' => 'query', + 'schema' => ['description' => 'Whether to supplement terminal information.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The language of the response.', 'type' => 'string', 'example' => 'zh-CN', 'title' => '', 'required' => false], + ], + [ + 'name' => 'DesktopGroupIds', + 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The IDs of the cloud computers.'."\n", + 'title' => '', + 'description' => 'The IDs of shared desktop groups.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-84mztzatmipf2****', - ], - 'required' => true, - 'maxItems' => 1000, + 'items' => ['description' => 'The ID of the shared desktop group.', 'type' => 'string', 'example' => 'dg-4oyi32wmrctgx****', 'title' => '', 'required' => false], + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'DesktopGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the shared desktop.', 'type' => 'string', 'example' => 'ecd-4oyi32wmrctgx****', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Returns an object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34FB4D97-C0D9-5534-ABC6-90C7EBD5****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0920845-7359-59FC-9899-B****'], + 'TotalCount' => ['description' => 'The total number of sessions.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], + 'Sessions' => [ + 'description' => 'The sessions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session details.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The user ID of the terminal that connects to the session.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The ID of the shared cloud computer.', 'type' => 'string', 'example' => 'dg-iaqu3bi2xtie****', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the cloud computer share.', 'type' => 'string', 'example' => 'DemoCCGroup', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The office network name.', 'type' => 'string', 'example' => 'DemoOfficeNetwork', 'title' => ''], + 'OwnType' => [ + 'description' => 'The type of the session.', + 'enumValueTitles' => ['Single-session', 'Multi-session'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'SessionStatus' => [ + 'description' => 'The state of the session.', + 'enumValueTitles' => ['Connected' => '', 'Disconnected' => ''], + 'type' => 'string', + 'example' => 'Connected', + 'title' => '', + ], + 'DesktopId' => ['description' => 'If the session status is Connected, it indicates the ID of the cloud computer that is currently connected. If the session status is Disconnected, it indicates the ID of the cloud computer that was last connected.', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****', 'title' => ''], + 'ClientOS' => ['description' => 'The operating system of the client.', 'type' => 'string', 'example' => 'windows', 'title' => ''], + 'ClientVersion' => ['description' => 'The version of the client.', 'type' => 'string', 'example' => '7.8.0', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => '172.21.XX.XX', 'title' => ''], + 'LatestConnectionTime' => ['description' => 'The duration of the most recent session. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'TotalConnectionDuration' => ['description' => 'The total duration of the sessions. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'SessionIdleTime' => ['description' => 'The idle duration of the cloud computer. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type supported by the rule.', + 'enumValueTitles' => ['HDX' => 'High-definition Experience (HDX).', 'ASP' => 'ASP.'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'LastSessionStartTime' => ['description' => 'The start time of the most recent connection.', 'type' => 'string', 'example' => '2022-08-31 06:56:45', 'title' => ''], + 'LastSessionEndTime' => ['description' => 'The end time of the most recent connection.', 'type' => 'string', 'example' => '2022-08-31 07:56:45', 'title' => ''], + 'OsType' => [ + 'description' => 'The operating system type of the cloud computer.', + 'enumValueTitles' => ['linux' => '', 'windows' => ''], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', + ], + 'EndUserApplyCoordinateTime' => ['description' => 'The point in time when the end user applies for administrator assistance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1678794261000', 'title' => ''], + 'TerminalInfo' => [ + 'title' => '', + 'description' => 'Terminal Info', + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['description' => 'The terminal type.', 'type' => 'string', 'example' => 'Mac', 'title' => ''], + 'SerialNumber' => ['description' => 'Terminal Serial Number', 'type' => 'string', 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****', 'title' => ''], + 'Model' => ['description' => 'The type of the terminal.', 'type' => 'string', 'example' => 'wuying_mac_x86_64', 'title' => ''], + 'Uuid' => ['description' => 'The terminal UUID.', 'type' => 'string', 'example' => 'EBFDC7773BEBAD418A9F89429652****', 'title' => ''], + ], + 'example' => '', + ], + 'DirectoryType' => ['title' => '办公网络类型', 'description' => 'The office network type.', 'type' => 'string', 'example' => 'SIMPLE'], + 'AccountType' => ['title' => '账号类型', 'description' => 'The account type.', 'type' => 'string', 'example' => 'SIMPLE'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'caeba0bbb2', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34FB4D97-C0D9-5534-ABC6-90C7EBD5****\\"\\n}","type":"json"}]', - 'title' => 'DisableDesktopsInGroup', - ], - 'ModifyDesktopGroup' => [ - 'summary' => 'Modifies a cloud computer share.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeDesktopGroupSessions', + 'changeSet' => [ + ['createdAt' => '2025-10-17T12:21:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-15T04:00:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroupSessions'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0920845-7359-59FC-9899-B****\\",\\n \\"TotalCount\\": 15,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\",\\n \\"OwnType\\": 0,\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"ClientOS\\": \\"windows\\",\\n \\"ClientVersion\\": \\"7.8.0\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionDuration\\": 120,\\n \\"SessionIdleTime\\": 120,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LastSessionStartTime\\": \\"2022-08-31 06:56:45\\",\\n \\"LastSessionEndTime\\": \\"2022-08-31 07:56:45\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 1678794261000,\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"wuying_mac_x86_64\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"AccountType\\": \\"SIMPLE\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2\\"\\n}","type":"json"}]', + ], + 'DescribeDesktopGroups' => [ + 'summary' => 'Returns a detailed list of shared cloud desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-467671****', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer pool. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CloudComputerPool01', 'title' => ''], ], [ 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', - ], + 'schema' => ['description' => 'The ID of the cloud computer pool.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'OwnBundleId', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'b-7t275tpgjueeu****', - ], + 'schema' => ['description' => 'The subscription duration of the subscription cloud computer pool. The unit is specified by the `PeriodUnit` parameter.'."\n" + ."\n" + .'- Valid values when `PeriodUnit` is set to `Month`:'."\n" + ."\n" + .' - 1'."\n" + ."\n" + .' - 2'."\n" + ."\n" + .' - 3'."\n" + ."\n" + .' - 6'."\n" + ."\n" + .'- Valid values when `PeriodUnit` is set to `Year`:'."\n" + ."\n" + .' - 1'."\n" + ."\n" + .' - 2'."\n" + ."\n" + .' - 3'."\n" + ."\n" + .' - 4'."\n" + ."\n" + .' - 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the security policy.'."\n", + 'description' => 'The unit of the subscription duration.', + 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => 'pg-53iyi2aar0nd6****', + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupName', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'desktopGroupName1', - ], + 'schema' => ['description' => 'The number of entries to return on each page.
Maximum value: 100.
Default value: 10.

', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ScaleStrategyId', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. If NextToken is empty, no next page exists.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the policy that is associated with the cloud computer pool.', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the scaling policy group.'."\n" - ."\n" - .'> This parameter is unavailable.'."\n", - 'type' => 'string', + 'description' => 'The status of the cloud computer pool.', + 'enumValueTitles' => ['Unpaid', 'Normal', 'Overdue or expired'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'docRequired' => false, - 'example' => 's-kakowkdl****', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'KeepDuration', + 'name' => 'OwnType', 'in' => 'query', 'schema' => [ - 'description' => 'The retention period of a session after it is disconnected. Unit: milliseconds. Valid values: 180000 to 345600000. That is, the session can be retained for 3 to 5,760 minutes (4 days) after it is disconnected. If you set this parameter to 0, the session is permanently retained after it is disconnected.'."\n" + 'description' => 'The type of the cloud computer pool.'."\n" ."\n" - .'When a session is disconnected, take note of the following situations: If an end user does not resume the session within the specified duration, the session is closed and all unsaved data is cleared. If the end user resumes the session within the specified duration, the end user can continue to access data of the session.'."\n", + .'> This parameter is not publicly available.', + 'enumValueTitles' => ['Multiple single-session shared cloud desktops', 'Multiple multi-session shared cloud desktops'], 'type' => 'integer', 'format' => 'int64', 'required' => false, - 'docRequired' => false, - 'example' => '1000', + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'Comments', + 'name' => 'EndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the authorized users of the cloud computer pool.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the authorized user of the cloud computer pool.', 'type' => 'string', 'required' => false, 'example' => 'alice'."\n", 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'test', + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MinDesktopsCount', + 'name' => 'ExcludedEndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of auto-created cloud computers allowed in the subscription cloud computer share. You must specify this parameter when `ChargeType` is set to `PrePaid`. Default value: 1. Valid values: 0 to `MaxDesktopsCount`.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of the users that you want to exclude from the authorized user list.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the user that you want to exclude from the authorized user list.', 'type' => 'string', 'required' => false, 'example' => 'Tony', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '1', + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxDesktopsCount', + 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of cloud computers allowed in the pay-as-you-go cloud computer share. Valid values: 0 to 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud\'s proprietary ASP protocol'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '10', + 'example' => 'ASP', + 'title' => '', ], ], [ - 'name' => 'AllowAutoSetup', + 'name' => 'ImageId', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable auto-creation of cloud computers for the subscription cloud computer share. You must specify this parameter when `ChargeType` is set to `PrePaid`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: disable auto-creation of cloud computers.'."\n" - .'* 1: enables auto-creation of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The image IDs.', + 'type' => 'array', + 'items' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-eeuo9qab4b0****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'maximum' => '1', - 'minimum' => '0', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AllowBufferCount', + 'name' => 'BundleId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of standby cloud computers that can be reserved within the pay-as-you-go cloud computer share. You must specify this property only when `ChargeType` is set to `PostPaid`. Valid values:'."\n" - ."\n" - .'* 0: does not reserve any cloud computer.'."\n" - .'* N: reserves N cloud computers (1≤ N ≤ 100).'."\n" - ."\n" - .'> Setting this parameter to 0 means no cloud computers will be reserved within the cloud computer share. In this case, the system must create, start, and assign cloud computers to end users upon request, which can be time-consuming. To improve user experience, we recommend that you reserve a specific number of cloud computers.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The cloud computer template IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer template.', 'type' => 'string', 'required' => false, 'example' => 'b-4w5nk44znm6****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'maximum' => '1000', - 'minimum' => '0', - 'example' => '1', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResetType', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The disk reset type of cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: does not reset disks.'."\n" - ."\n" - .'* 1: resets only the system disks.'."\n" - ."\n" - .'* 2: resets only the user disks.'."\n" - ."\n" - .'* 3: resets the system disks and user disks.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - '', - '', + 'description' => 'The tags. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag. The key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag. The value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => '0', + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'LoadPolicy', + 'name' => 'MultiResource', 'in' => 'query', 'schema' => [ - 'description' => 'The load balancing policy for the multi-session many-to-many share.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: depth first.'."\n" - .'* 1: breadth first.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specifies whether to query multi-desktop cloud computer pools.', + 'enumValueTitles' => ['true' => 'Multiple shared cloud desktops', 'false' => 'Single shared cloud desktop'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'BindAmount', + 'name' => 'DesktopGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of concurrent sessions allowed for each cloud computer within the multi-session many-to-many share.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of cloud computer pools.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer pool.', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], 'required' => false, - 'example' => '1', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the images.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desktopimage-windows-server-2016-64-ch', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'Classify', + 'name' => 'QosRuleId', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the cloud computer share.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* teacher: teacher-oriented.'."\n" - .'* student: student-oriented.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'teacher' => 'teacher', - 'student' => 'student', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is not returned, it indicates that all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'DesktopGroups' => [ + 'description' => 'The details of the shared cloud desktop groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a shared cloud desktop group.', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The time when the shared cloud desktop group was created.', 'type' => 'string', 'example' => '2022-02-17T14:51:07Z', 'title' => ''], + 'PayType' => [ + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go', 'PrePaid' => 'subscription'], + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '', + ], + 'PolicyGroupName' => ['description' => 'The name of the policy associated with the shared cloud desktop group.', 'type' => 'string', 'example' => 'All enabled policy', 'title' => ''], + 'Creator' => ['description' => 'The ID of the Alibaba Cloud account that created the shared cloud desktop group.', 'type' => 'string', 'example' => '1007214305******', 'title' => ''], + 'MaxDesktopsCount' => ['description' => '- For a pay-as-you-go shared cloud desktop group, this parameter specifies the maximum number of cloud desktops that the group can contain.'."\n" + ."\n" + .'- For a subscription shared cloud desktop group, this parameter specifies the total number of cloud desktops, which is the sum of the initially purchased desktops (indicated by the `BuyDesktopsCount` parameter) and the desktops that can be automatically created.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'SystemDiskSize' => ['description' => 'The system disk size in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'PolicyGroupId' => ['description' => 'The ID of the policy associated with the shared cloud desktop group.', 'type' => 'string', 'example' => 'pg-53iyi2aar0nd6c8qj', 'title' => ''], + 'OwnBundleId' => ['description' => 'The ID of the cloud desktop template.', 'type' => 'string', 'example' => 'bundle_eds_general_4c8g_s8d5_win2019', 'title' => ''], + 'GpuCount' => ['description' => 'The number of vGPU cores.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Memory' => ['description' => 'The memory size in MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '16384', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU memory size.', 'type' => 'string', 'example' => '16 GiB', 'title' => ''], + 'OwnBundleName' => ['description' => 'The name of the cloud desktop template.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DataDiskCategory' => [ + 'description' => 'The type of the data disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'Ultra Disk', 'cloud_ssd' => 'Standard SSD', 'cloud_essd' => 'ESSD'], + 'type' => 'string', + 'example' => 'cloud_ssd', + 'title' => '', + ], + 'DesktopGroupName' => ['description' => 'The name of the shared cloud desktop group.', 'type' => 'string', 'example' => 'CloudComputerPool01', 'title' => ''], + 'SystemDiskCategory' => [ + 'description' => 'The type of the system disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'Ultra Disk', 'cloud_ssd' => 'Standard SSD', 'cloud_essd' => 'ESSD'], + 'type' => 'string', + 'example' => 'cloud_ssd', + 'title' => '', + ], + 'OfficeSiteId' => ['description' => 'The ID of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-467671****', 'title' => ''], + 'KeepDuration' => ['description' => 'The duration, in milliseconds, to retain a disconnected session. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session is always retained.'."\n" + ."\n" + .'When a session disconnects, the user can reconnect within this period to resume their work. If the user fails to reconnect in time, the session is terminated and unsaved data is lost.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000', 'title' => ''], + 'MinDesktopsCount' => ['description' => '- For a pay-as-you-go shared cloud desktop group, this specifies the minimum number of cloud desktops to maintain in the group.'."\n" + ."\n" + .'- For a subscription shared cloud desktop group, this parameter has the same value as `BuyDesktopsCount` and specifies the number of cloud desktops that you initially purchase.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EndUserCount' => ['description' => 'The number of authorized users of the shared cloud desktop group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataDiskSize' => ['description' => 'The data disk size in GiB.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The ID of the shared cloud desktop group.', 'type' => 'string', 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The name of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****', 'title' => ''], + 'Cpu' => ['description' => 'The number of vCPU cores.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'ExpiredTime' => ['description' => 'The time when the subscription shared cloud desktop group expires.', 'type' => 'string', 'example' => '2022-03-17T16:00:00Z', 'title' => ''], + 'Comments' => ['description' => 'The comments on the shared cloud desktop group.', 'type' => 'string', 'example' => 'comment', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The account type of the office network.', + 'enumValueTitles' => ['PERSONAL' => 'personal', 'SIMPLE' => 'convenience', 'AD_CONNECTOR' => 'AD', 'RAM' => 'RAM'], + 'type' => 'string', + 'example' => 'SIMPLE', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the shared cloud desktop group.', + 'enumValueTitles' => ['Unpaid', 'Normal', 'Overdue or expired'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ResetType' => [ + 'description' => 'The reset type of the shared cloud desktop group.', + 'enumValueTitles' => ['Cloud desktops are not reset.', 'Only system disks are reset.', 'Only data disks are reset.', 'The system and data disks are reset.'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'LoadPolicy' => [ + 'description' => 'The load balancing policy for the multi-session shared cloud desktop group.', + 'enumValueTitles' => ['Depth-first', 'Breadth-first'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'BindAmount' => ['description' => 'The number of concurrent sessions allowed per cloud desktop in a multi-session shared cloud desktop group.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'OwnType' => [ + 'description' => 'The type of the shared cloud desktop group.', + 'enumValueTitles' => ['A group of single-session cloud desktops', 'A group of multi-session cloud desktops'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + 'title' => '', + ], + 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'm-gq15cq5ydlvwn****', 'title' => ''], + 'VolumeEncryptionEnabled' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the KMS key used for disk encryption.', 'type' => 'string', 'example' => 'e5409ada-xxxx-xxxx-xxxx-89e31e23e993', 'title' => ''], + 'RatioThreshold' => ['description' => 'The session utilization threshold that triggers auto scaling for a multi-session shared cloud desktop group. Session utilization is calculated by using the following formula:'."\n" + ."\n" + .'`Session utilization = Number of active sessions / (Total number of cloud desktops × Maximum number of sessions per cloud desktop) × 100%`'."\n" + ."\n" + .'When the session utilization exceeds this threshold, the system scales out by creating new cloud desktops. When the utilization falls below this threshold, the system scales in by removing idle cloud desktops.', 'type' => 'number', 'format' => 'float', 'example' => '0.85', 'title' => ''], + 'ConnectDuration' => ['description' => 'The maximum session duration, in milliseconds. When this duration is reached, the session is automatically disconnected.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600000', 'title' => ''], + 'IdleDisconnectDuration' => ['description' => 'The amount of time, in milliseconds, that a session can remain idle. If a session remains idle for longer than this duration, it is automatically disconnected. A session is considered idle if there is no keyboard or mouse activity.', 'type' => 'integer', 'format' => 'int64', 'example' => '90000', 'title' => ''], + 'Version' => ['description' => 'The version number of the shared cloud desktop group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'StopDuration' => ['description' => 'The period of inactivity, in milliseconds, after which an idle cloud desktop is automatically stopped. If a user tries to connect to a stopped desktop, the desktop is automatically started.', 'type' => 'integer', 'format' => 'int64', 'example' => '900000', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud-proprietary ASP protocol'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'OsType' => [ + 'description' => 'The OS.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', + ], + 'BuyDesktopsCount' => ['description' => 'The number of cloud desktops that you purchase. This parameter applies only to subscription shared cloud desktop groups. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'DesktopCount' => ['description' => 'The number of cloud desktops created.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'DesktopType' => ['description' => 'The desktop type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the desktop types supported by WUYING Workspace.', 'type' => 'string', 'example' => 'eds.enterprise_office.4c4g', 'title' => ''], + 'CountPerStatus' => [ + 'description' => 'The number of cloud desktops in each status.', + 'type' => 'array', + 'items' => [ + 'description' => 'The number of cloud desktops in the current status.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the cloud desktop.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'Count' => ['description' => 'The number of cloud desktops in the specified status.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GpuDriverVersion' => ['description' => 'The GPU driver version.', 'type' => 'string', 'example' => '12', 'title' => ''], + 'SubnetId' => ['description' => 'The ID of the subnet.', 'type' => 'string', 'example' => 'vsw-uf63bb6*****8gfytm', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags attached to the shared cloud desktop group.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'desktop_group_name', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'ds-dq2mybjr23yw*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'UserOuPath' => ['description' => 'The path of the organizational unit (OU).', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'IsLdap' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'UserGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PolicyGroupIdList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'PolicyGroupNameList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SimpleUserGroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrgId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AccountType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntraDomainName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExpiredTimes' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'QosRuleId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'teacher', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeDesktopGroups', + 'changeSet' => [ + ['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-06-03T02:21:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-01T01:51:53.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-07T09:08:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-10T07:04:39.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroups'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopGroups\\": [\\n {\\n \\"CreateTime\\": \\"2022-02-17T14:51:07Z\\",\\n \\"PayType\\": \\"PrePaid\\",\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"Creator\\": \\"1007214305******\\",\\n \\"MaxDesktopsCount\\": 3,\\n \\"SystemDiskSize\\": 80,\\n \\"PolicyGroupId\\": \\"pg-53iyi2aar0nd6c8qj\\",\\n \\"OwnBundleId\\": \\"bundle_eds_general_4c8g_s8d5_win2019\\",\\n \\"GpuCount\\": 1,\\n \\"Memory\\": 16384,\\n \\"GpuSpec\\": \\"16 GiB\\",\\n \\"OwnBundleName\\": \\"test\\",\\n \\"DataDiskCategory\\": \\"cloud_ssd\\",\\n \\"DesktopGroupName\\": \\"CloudComputerPool01\\",\\n \\"SystemDiskCategory\\": \\"cloud_ssd\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-467671****\\",\\n \\"KeepDuration\\": 180000,\\n \\"MinDesktopsCount\\": 1,\\n \\"EndUserCount\\": 1,\\n \\"DataDiskSize\\": \\"50\\",\\n \\"DesktopGroupId\\": \\"dg-2i8qxpv6t1a03****\\",\\n \\"OfficeSiteName\\": \\"cn-hangzhou+os-c5cy7q578s8jc****\\",\\n \\"Cpu\\": 4,\\n \\"ExpiredTime\\": \\"2022-03-17T16:00:00Z\\",\\n \\"Comments\\": \\"comment\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"Status\\": 1,\\n \\"ResetType\\": 0,\\n \\"LoadPolicy\\": 1,\\n \\"BindAmount\\": 2,\\n \\"OwnType\\": 0,\\n \\"ImageId\\": \\"m-gq15cq5ydlvwn****\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"e5409ada-xxxx-xxxx-xxxx-89e31e23e993\\",\\n \\"RatioThreshold\\": 0.85,\\n \\"ConnectDuration\\": 3600000,\\n \\"IdleDisconnectDuration\\": 90000,\\n \\"Version\\": 2,\\n \\"StopDuration\\": 900000,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"BuyDesktopsCount\\": 5,\\n \\"DesktopCount\\": 2,\\n \\"DesktopType\\": \\"eds.enterprise_office.4c4g\\",\\n \\"CountPerStatus\\": [\\n {\\n \\"Status\\": \\"Running\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"GpuDriverVersion\\": \\"12\\",\\n \\"SubnetId\\": \\"vsw-uf63bb6*****8gfytm\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"desktop_group_name\\",\\n \\"Value\\": \\"ds-dq2mybjr23yw*****\\"\\n }\\n ],\\n \\"UserOuPath\\": \\"example.com\\",\\n \\"IsLdap\\": false,\\n \\"UserGroupName\\": \\"\\",\\n \\"PolicyGroupIdList\\": [\\n \\"\\"\\n ],\\n \\"PolicyGroupNameList\\": [\\n \\"\\"\\n ],\\n \\"SimpleUserGroupId\\": \\"\\",\\n \\"OrgId\\": \\"\\",\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\",\\n \\"ExpiredTimes\\": [\\n \\"\\"\\n ],\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\",\\n \\"QosRuleId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDesktopInfo' => [ + 'summary' => 'Describes basic information about cloud desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RatioThreshold', - 'in' => 'query', - 'schema' => [ - 'description' => 'The threshold for the ratio of connected sessions, which triggers automatic scaling of cloud computers within the multi-session many-to-many share. To calculate the ratio of connected sessions, use the following formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`'."\n" - ."\n" - .'If the session ratio exceeds the threshold, new cloud computers are provisioned. If it falls below the threshold, additional cloud computers are removed.'."\n" - ."\n" - .'> This parameter is not publicly available.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.5', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ConnectDuration', + 'name' => 'BusinessChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum period of time during which the session is connected. When the specified maximum period of time is reached, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 to 345600000. That is, the session can be connected for 15 to 5,760 minutes (4 days).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '600000', + 'type' => 'string', + 'enum' => ['Enterprise', 'Business'], + 'title' => '', + 'description' => '', + 'example' => '', ], ], [ - 'name' => 'IdleDisconnectDuration', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'After an end user connects to a cloud computer, the session is established. If the system does not detect inputs from the keyboard or mouse within the specified period of time, the session is closed. Unit: milliseconds. Valid values: 360000 to 3600000 (6 minutes to 60 minutes)'."\n" - ."\n" - .'End users can receive a prompt to save data before sessions are disconnected. The system sends the prompt 30 seconds before the specified period of time is reached. To prevent data loss, end users must save the data of the sessions.'."\n" - ."\n" - .'> This parameter is suitable only for cloud computers whose image version is v1.0.2 or later.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '120000', - ], + 'schema' => ['description' => 'Region ID. Call [](t2167755.xdita#)to get a list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DisableSessionConfig', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to disable session management.'."\n", - 'type' => 'boolean', + 'description' => 'Desktop ID. Set 1 to 100.', + 'type' => 'array', + 'items' => ['description' => 'Desktop ID.', 'type' => 'string', 'required' => false, 'example' => '["ecd-gx2x1dhsmucyy****"]', 'title' => ''], 'required' => false, - 'example' => 'true', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StopDuration', + 'name' => 'NeedExtraInfo', 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The period of time before the idle cloud computer enters the Stopped state. When the specified period of time is reached, the cloud computer is automatically stopped. If an end user connects to the stopped cloud computer, the cloud computer automatically starts. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '180000', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A1560565', 'title' => ''], + 'Desktops' => [ + 'description' => 'Basic desktop information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Basic desktop information.', + 'type' => 'object', + 'properties' => [ + 'CurrentAppVersion' => ['description' => 'Desktop image version number.', 'type' => 'string', 'example' => '1.4.0-R-***', 'title' => ''], + 'StartTime' => ['description' => 'Desktop first startup time.', 'type' => 'string', 'example' => '2020-11-06T08:31Z', 'title' => ''], + 'ConnectionStatus' => [ + 'description' => 'User connection status.', + 'enumValueTitles' => ['Connected' => 'Connected', 'Disconnected' => 'Disconnected'], + 'type' => 'string', + 'example' => 'Disconnected', + 'title' => '', + ], + 'DesktopId' => ['description' => 'Desktop ID.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'DesktopStatus' => [ + 'description' => 'The status of the cloud desktop.', + 'enumValueTitles' => ['Stopped' => 'The cloud desktop is stopped.', 'Failed' => 'The cloud desktop failed to be created.', 'Starting' => 'The cloud desktop is starting.', 'Running' => 'The cloud desktop is running.', 'Stopping' => 'The cloud desktop is stopping.', 'Expired' => 'The cloud desktop has expired.', 'Deleted' => 'The cloud desktop has been deleted.', 'Pending' => 'The cloud desktop is being created.'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'ManagementFlag' => [ + 'description' => 'The management flag.', + 'type' => 'array', + 'items' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Migrating' => 'Migrating', 'Updating' => 'Upgrading or downgrading', 'NoFlag' => 'No flag'], + 'type' => 'string', + 'example' => 'NoFlag', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NewAppVersion' => ['description' => 'Desktop upgradable image version number.', 'type' => 'string', 'example' => '1.6.0-R-***', 'title' => ''], + 'ReleaseNote' => ['description' => 'Description of the upgradable image version.', 'type' => 'string', 'example' => 'Test upgrade package 03-07', 'title' => ''], + 'NewAppSize' => ['description' => 'Upgrade package size, in KB.', 'type' => 'integer', 'format' => 'int64', 'example' => '568533470', 'title' => ''], + 'DesktopGroupId' => ['description' => 'Desktop group ID.', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A1560565\\",\\n \\"Desktops\\": [\\n {\\n \\"CurrentAppVersion\\": \\"1.4.0-R-***\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ManagementFlag\\": [\\n \\"NoFlag\\"\\n ],\\n \\"NewAppVersion\\": \\"1.6.0-R-***\\",\\n \\"ReleaseNote\\": \\"Test upgrade package 03-07\\",\\n \\"NewAppSize\\": 568533470,\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDesktopInfo', + 'changeSet' => [ + ['createdAt' => '2025-08-04T10:15:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-07T04:24:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-04T05:05:07.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopInfo'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ProfileFollowSwitch', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable user data roaming.'."\n" - ."\n" - .'> This parameter is unavailable.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'DescribeDesktopMetadata' => [ + 'summary' => 'Lists cloud computers and their metadata from all regions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileSystemId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the File Storage NAS (NAS) file system for the user data roaming feature.'."\n" - ."\n" - .'> This parameter is unavailable.', + 'description' => 'The region ID.', + 'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'], 'type' => 'string', 'required' => false, - 'example' => '04f314****', + 'docRequired' => true, + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'PolicyGroupIds', + 'name' => 'SearchRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region to search.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-778418****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer share.', 'type' => 'string', 'required' => false, 'example' => 'dg-i1ruuudp92qpj****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return per page. Maximum: 100. Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token returned from the previous call to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'maxLength' => 100, 'example' => 'ecd', 'title' => ''], + ], + [ + 'name' => 'CreationTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The creation time of the cloud computer. The time must be in the `yyyy-MM-dd\'T\'HH:mm:ss\'Z\'` format and in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01T12:00:00Z', 'title' => ''], + ], + [ + 'name' => 'OperationTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query for operations. The time must be in the `yyyy-MM-dd\'T\'HH:mm:ss\'Z\'` format and in UTC.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01T12:00:00Z', 'title' => ''], + ], + [ + 'name' => 'IncludeDesktopGroup', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include cloud computers in cloud computer shares in the response.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + ], + [ + 'name' => 'DesktopIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of policy groups.'."\n", + 'description' => 'A list of cloud computer IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the policy group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****', 'title' => ''], 'required' => false, - 'maxItems' => 5, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BuyDesktopsCount', + 'name' => 'HostName', 'in' => 'query', - 'schema' => [ - 'description' => '* For subscription cloud computer shares, this parameter specifies the number of purchased cloud computers. Valid values: 0 to 200.'."\n" - .'* For pay-as-you-go cloud computer shares, this parameter specifies the minimum number of cloud computers created in the initial batch. Default value: 1. Valid values: 0 to `MaxDesktopsCount`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The hostname.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ASW-2F-SRV-YXYZ-4.SHPTG'], ], [ - 'name' => 'DeleteDuration', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['description' => 'The ID of the end user.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test-user'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Desktops' => [ + 'description' => 'The details of the cloud desktops.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the cloud desktop.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => 'The creation time of the cloud desktop.', 'type' => 'string', 'example' => '2020-11-06T08:28Z', 'title' => ''], + 'LocalName' => ['description' => 'The name of the region.', 'type' => 'string', 'example' => '华东2（上海）', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method of the cloud desktop. Valid values:'."\n" + ."\n" + .'- `PostPaid`: pay-as-you-go'."\n" + ."\n" + .'- `PrePaid`: subscription', 'type' => 'string', 'example' => 'PostPaid', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'testDesktopName', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'StartTime' => ['description' => 'The time when the cloud desktop started.', 'type' => 'string', 'example' => '2020-11-06T08:31Z', 'title' => ''], + 'DesktopStatus' => ['description' => 'The status of the cloud desktop. Valid values:'."\n" + ."\n" + .'- `Stopped`'."\n" + ."\n" + .'- `Starting`'."\n" + ."\n" + .'- `Rebuilding`'."\n" + ."\n" + .'- `Running`'."\n" + ."\n" + .'- `Stopping`'."\n" + ."\n" + .'- `Expired`'."\n" + ."\n" + .'- `Deleted`'."\n" + ."\n" + .'- `Pending`', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time of the cloud desktop. This parameter is returned only for cloud desktops that use the subscription billing method.', 'type' => 'string', 'example' => '2021-12-31T15:59Z', 'title' => ''], + 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'serverless_new', 'title' => ''], + 'ManagementFlags' => [ + 'description' => 'The management flags for the cloud computer.', + 'type' => 'array', + 'items' => ['description' => 'The management flag. Valid values:'."\n" + ."\n" + .'- `NoFlag`: No special management status.'."\n" + ."\n" + .'- `Updating`: The cloud computer is being updated.'."\n" + ."\n" + .'- `Migrating`: The cloud computer is being migrated.'."\n" + ."\n" + .'- `UnderMaintenance`: The cloud computer is under maintenance.'."\n" + ."\n" + .'- `EnterMaintenance`: The cloud computer is entering maintenance mode.'."\n" + ."\n" + .'- `Hibernating`: The cloud computer is hibernating.'."\n" + ."\n" + .'- `Hibernated`: The cloud computer is hibernated.'."\n" + ."\n" + .'- `WakingUp`: The cloud computer is waking up.', 'type' => 'string', 'example' => '["NoFlag"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DesktopType' => ['description' => 'The instance type of the cloud desktop.', 'type' => 'string', 'example' => 'eds.general.2c8g', 'title' => ''], + 'MemberEniIp' => ['description' => 'The private IP address of the instance\'s network interface.', 'type' => 'string', 'example' => '192.168.2.1', 'title' => ''], + 'Platform' => ['description' => 'The operating system of the cloud desktop.', 'type' => 'string', 'example' => 'Ubuntu', 'title' => ''], + 'AgentProviderList' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'A supported agent.', 'type' => 'string', 'example' => 'OpenClaw', 'title' => ''], + 'description' => 'A list of agents that the cloud computer supports.', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n","errorExample":""}]', - 'title' => 'ModifyDesktopGroup', - 'description' => 'Once a cloud computer share is created, the system automatically provisions cloud computers according to the auto-scaling policy and user connections, all based on the same template and security policy. You can adjust the cloud computer share\'s configurations, including the share name, template, and policy, for different business scenarios.'."\n", - ], - 'ResetDesktops' => [ - 'summary' => 'Resets cloud computers of a cloud computer share.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"LocalName\\": \\"华东2（上海）\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"serverless_new\\",\\n \\"ManagementFlags\\": [\\n \\"[\\\\\\"NoFlag\\\\\\"]\\"\\n ],\\n \\"DesktopType\\": \\"eds.general.2c8g\\",\\n \\"MemberEniIp\\": \\"192.168.2.1\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"AgentProviderList\\": [\\n \\"OpenClaw\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query metadata of Cloud Desktops ', + 'description' => 'This operation is centralized, available only in the China (Shanghai) and Singapore regions.', + 'changeSet' => [ + ['createdAt' => '2025-12-27T14:56:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopMetadata'], + ], ], + 'ramActions' => [], + ], + 'DescribeDesktopSessions' => [ + 'summary' => 'Queries the detailed session information for cloud computers.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~436773~~) operation to query the most recent region list.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. Call [](t2167755.xdita#)to obtain a list of regions that Elastic Desktop Service (EDS) supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n" - ."\n" - .'* If you specify `DesktopId`, ignore `DesktopGroupId`.'."\n" - .'* If you leave `DesktopId` empty, the system obtains the IDs of all cloud computers within the share specified by `DesktopGroupId`.``'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dg-07if7qsxoxkb6****', - ], + 'schema' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'PayType', + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the end user.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'SessionStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The billing method of the cloud computer share.'."\n" - ."\n" - .'> This parameter takes effect when you reset a cloud computer share. If you leave this parameter empty, all cloud computers in that share are reset.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go.'."\n" - .'* PrePaid: subscription.'."\n", + 'description' => 'The connection status of the session.', + 'enumValueTitles' => ['Connected' => 'The session is connected.', 'Disconnected' => 'The session is disconnected.'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', + 'example' => 'Connected', + 'title' => '', ], ], [ - 'name' => 'ResetType', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The disk reset type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: does not reset disks.'."\n" - .'* 1: resets only the system disk.'."\n" - .'* 2: resets only the user disk.'."\n" - .'* 3: resets the system disk and the user disk.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - '', - '', - '', - '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The start time of the query.', 'type' => 'string', 'required' => false, 'example' => '2023-01-28T02:31:43Z', 'title' => ''], ], [ - 'name' => 'ImageId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'm-4zfb6zj728hhr****', - ], + 'schema' => ['description' => 'The end time of the query.', 'type' => 'string', 'required' => false, 'example' => '2023-02-13T02:51:43Z', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-07if7qsxoxkb3****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The page number for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DesktopGroupIds', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on each page for a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DesktopId', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer shares.'."\n", + 'description' => 'The ID of the cloud computer. You can specify 1 to 100 IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-kadkdfaf****', - ], + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****"', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResetScope', + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer', 'title' => ''], + ], + [ + 'name' => 'SubPayType', 'in' => 'query', 'schema' => [ - 'description' => 'The reset scope. You can configure this parameter to reset the image or cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALL (default): resets the image and cloud computer.'."\n" - .'* IMAGE: resets only the image.', + 'description' => 'The billing method of the cloud computer.', + 'enumValueTitles' => ['duration' => 'Duration package (whitelisted)', 'postPaid' => 'Pay-as-you-go', 'monthPackage' => 'Monthly subscription (120 hours/250 hours)', 'prePaid' => 'Monthly subscription (unlimited usage)'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '', - 'IMAGE' => '', - ], - 'example' => 'ALL', + 'example' => 'monthPackage', + 'title' => '', ], ], [ - 'name' => 'LastRetryTime', + 'name' => 'CheckOsSession', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['description' => 'Specifies whether to check the session status within the cloud computer.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'EndUserIdFilter', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the end user. This parameter is the same as the `EndUserId` parameter. Specify only one of them.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FillHardwareInfo', + 'in' => 'query', + 'schema' => ['title' => 'Whether to include terminal hardware information in the response.', 'description' => 'Specifies whether to return information about the terminal.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['title' => 'Language type for returned information. ', 'description' => 'The language of the returned information.', 'type' => 'string', 'example' => 'zh-CN', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'TotalCount' => ['description' => 'The total number of query results.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3EC4A6DB-EC8D-55B0-9038-543DE671****', 'title' => ''], + 'Sessions' => [ + 'description' => 'The session details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session details.', + 'type' => 'object', + 'properties' => [ + 'SessionStatus' => [ + 'description' => 'The connection status of the session.', + 'enumValueTitles' => ['Connected' => 'The session is connected.', 'Disconnected' => 'The session is disconnected.'], + 'type' => 'string', + 'example' => 'Connected', + 'title' => '', + ], + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****', 'title' => ''], + 'ClientIp' => ['description' => 'The IP address of the client.', 'type' => 'string', 'example' => '172.21.XX.XX', 'title' => ''], + 'ClientOS' => ['description' => 'The operating system of the client.', 'type' => 'string', 'example' => 'windows_\\"Windows10Enterprise\\"10.0(Build22000)', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud computer.', 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The name of the office site.', 'type' => 'string', 'example' => 'TestOfficeSite', 'title' => ''], + 'ClientVersion' => ['description' => 'The version of the client.', 'type' => 'string', 'example' => '2.0.0-R-20221030.08****', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Adaptive Streaming Protocol (ASP) developed by Alibaba Cloud'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'LatestConnectionTime' => ['description' => 'The duration of the last connection to the cloud computer. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'TotalConnectionTime' => ['description' => 'The total connection duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '240', 'title' => ''], + 'SessionStartTime' => ['description' => 'The time when the session started.', 'type' => 'string', 'example' => '2023-01-28T02:31:43Z'."\n", 'title' => ''], + 'SessionEndTime' => ['description' => 'The time when the session ended.', 'type' => 'string', 'example' => '2023-01-28T02:31:43Z', 'title' => ''], + 'SessionIdleTime' => ['description' => 'The duration for which the session was idle. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'OsType' => [ + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', + ], + 'EndUserApplyCoordinateTime' => ['description' => 'The duration of remote assistance initiated by the end user. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'SubPayType' => [ + 'description' => 'The billing method of the cloud computer.', + 'enumValueTitles' => ['duration' => 'Duration package (whitelisted)', 'postPaid' => 'Pay-as-you-go', 'monthPackage' => 'Monthly subscription (120 hours/250 hours)', 'prePaid' => 'Monthly subscription (unlimited usage)'], + 'type' => 'string', + 'example' => 'monthPackage', + 'title' => '', + ], + 'OsSessionStatus' => ['description' => 'Indicates the session status of the cloud desktop.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'TerminalInfo' => [ + 'description' => 'The description of the terminal device.', + 'title' => 'Description of terminal device information. ', + 'type' => 'object', + 'properties' => [ + 'ProductName' => ['title' => 'Terminal device type.', 'description' => 'The type of the terminal device.', 'type' => 'string', 'example' => 'Mac'], + 'SerialNumber' => ['title' => 'Serial Number of Terminal Device ', 'description' => 'The serial number of the terminal device.', 'type' => 'string', 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****'], + 'Model' => ['title' => 'Terminal Device Information ', 'description' => 'The model of the terminal device.', 'type' => 'string', 'example' => 'Mac'], + 'Uuid' => ['title' => 'UUID of the logon device. ', 'description' => 'The universally unique identifier (UUID) of the logon device.', 'type' => 'string', 'example' => 'EBFDC7773BEBAD418A9F89429652****'], + ], + 'example' => '', + ], + 'DirectoryType' => ['title' => 'Office network type', 'description' => 'The type of the office network.', 'type' => 'string', 'example' => 'SIMPLE'], + 'AccountType' => ['title' => 'Account type', 'description' => 'The type of the account.', 'type' => 'string', 'example' => 'SIMPLE'], + 'ResourceGroups' => [ + 'description' => 'The information about the resource group.', + 'title' => 'Resource Group Information ', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group.', + 'title' => 'Resource Group ', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'Resource Group ID ', 'description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-8whrmo2gtsb8bxxxx'], + 'Name' => ['title' => 'Resource Group Name ', 'description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'RgTest'], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ResetDesktops', - 'description' => '> You can call this operation to reset only cloud computers from a cloud computer share.'."\n", - ], - 'SetDesktopGroupScaleTimer' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query cloud desktop session details', + 'description' => 'You can retrieve data only from the last 30 days.', + 'responseParamsDescription' => 'The SessionIdleTime parameter is returned only when the operating system of the cloud computer is Windows.', + 'changeSet' => [ + ['createdAt' => '2025-10-17T12:21:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-15T04:00:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-07-07T05:42:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-09T12:03:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-21T01:35:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-08T12:43:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-07-01T02:32:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-04-15T06:38:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopSessions'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"3EC4A6DB-EC8D-55B0-9038-543DE671****\\",\\n \\"Sessions\\": [\\n {\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"ClientOS\\": \\"windows_\\\\\\\\\\\\\\"Windows10Enterprise\\\\\\\\\\\\\\"10.0(Build22000)\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ClientVersion\\": \\"2.0.0-R-20221030.08****\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"SessionStartTime\\": \\"2023-01-28T02:31:43Z\\\\n\\",\\n \\"SessionEndTime\\": \\"2023-01-28T02:31:43Z\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 120,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"OsSessionStatus\\": \\"true\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"Mac\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"AccountType\\": \\"SIMPLE\\",\\n \\"ResourceGroups\\": [\\n {\\n \\"Id\\": \\"rg-8whrmo2gtsb8bxxxx\\",\\n \\"Name\\": \\"RgTest\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDesktopTypes' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'BusinessChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['Enterprise', 'Business', 'Lincore_team'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions that Elastic Desktop Service supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ScaleTimerInfos', + 'name' => 'DesktopTypeId', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The information about the scheduled auto scaling task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the scheduled auto scaling task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the auto scaling policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* normal'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* peak'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* rise'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'normal' => '', - 'peak' => '', - 'rise' => '', - ], - 'example' => 'rise', - ], - 'RatioThreshold' => [ - 'description' => 'The threshold for the ratio of connected sessions. This parameter is the condition that triggers auto scaling in a multi-session cloud computer pool. Formula:'."\n" - ."\n" - .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`.'."\n" - ."\n" - .'When the specified threshold is reached, new cloud computers are automatically created. When the specified threshold is not reached, idle cloud computers are released.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.9', - ], - 'KeepDuration' => [ - 'description' => 'The keep-alive duration of a session after the session is disconnected. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session always keeps alive.'."\n" - ."\n" - .'If a session is disconnected by the end user or accidentally due to a factor and the end user does not re-establish a connection with the session within the keep-alive duration, the session expires and unsaved data is deleted. If the end user successfully re-establishes a connection with the session within the keep-alive duration, the end user returns to the session and can still access the original data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'BuyResAmount' => [ - 'description' => 'One option for the auto scaling policy. This option specifies the number of cloud computers that you want to create in the cloud computer pool. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'MinResAmount' => [ - 'description' => 'One option for the auto scaling policy. This option specifies the minimum number of cloud computers that you must create in the cloud computer pool. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'MaxResAmount' => [ - 'description' => 'One option for the auto scaling policy. This option specifies the maximum number of cloud computers that you can create in the cloud computer pool. Valid values: 0 to 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - ], - 'Cron' => [ - 'description' => 'The cron expression of the trigger time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 0 12 ? * 1', - ], - 'LoadPolicy' => [ - 'description' => 'The load balancing policy for the multi-session cloud computer pool.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: depth-first'."\n" - .'* 1: breadth first.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - ], - 'required' => false, + 'description' => 'The ID of the instance type.'."\n" + ."\n" + .'> If you omit both the `InstanceTypeFamily` and `DesktopTypeId` parameters, the operation returns all available WUYING Workspace instance types.', + 'enumValueTitles' => [ + 'eds.enterprise_office.4c8g' => 'eds.enterprise\\_office.4c8g', 'eds.hf.4c8g' => 'eds.hf.4c8g', 'ecd.basic.large' => 'ecd.basic.large', 'ecd.advanced.large' => 'ecd.advanced.large', 'eds.enterprise_office.8c16g' => 'eds.enterprise\\_office.8c16g', 'ecd.basic.small' => 'ecd.basic.small', 'ecd.graphics.2xlarge' => 'ecd.graphics.2xlarge', 'eds.hf.8c16g' => 'eds.hf.8c16g', 'eds.hf.12c24g' => 'eds.hf.12c24g', 'eds.general.8c16g' => 'eds.general.8c16g', + 'eds.general.16c32g' => 'eds.general.16c32g', 'ecd.advanced.xlarge' => 'ecd.advanced.xlarge', 'eds.graphics.16c1t4' => 'eds.graphics.16c1t4', 'ecd.graphics.xlarge' => 'ecd.graphics.xlarge', 'ecd.performance.2xlarge' => 'ecd.performance.2xlarge', 'eds.general.8c32g' => 'eds.general.8c32g', 'eds.general.2c2g' => 'eds.general.2c2g', 'eds.general.2c4g' => 'eds.general.2c4g', 'eds.graphics.24c1t4' => 'eds.graphics.24c1t4', 'eds.general.4c8g' => 'eds.general.4c8g', + 'eds.enterprise_office.2c4g' => 'eds.enterprise\\_office.2c4g', 'eds.general.4c16g' => 'eds.general.4c16g', 'eds.general.2c8g' => 'eds.general.2c8g', ], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'docRequired' => false, + 'example' => 'ecd.graphics.xlarge', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'InstanceTypeFamily', + 'in' => 'query', 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'The instance type family.'."\n" + ."\n" + .'> If you omit both the `InstanceTypeFamily` and `DesktopTypeId` parameters, the operation returns all available WUYING Workspace instance types.', + 'enumValueTitles' => ['ecd.advanced' => 'ecd.advanced', 'eds.graphics' => 'eds.graphics', 'ecd.basic' => 'ecd.basic', 'eds.enterprise_office' => 'eds.enterprise\\_office', 'eds.hf' => 'eds.hf', 'ecd.graphics' => 'ecd.graphics', 'eds.general' => 'eds.general', 'ecd.performance' => 'ecd.performance'], + 'type' => 'string', + 'required' => false, + 'example' => 'ecd.graphics', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'SetDesktopGroupScaleTimer', - 'summary' => 'Configures an auto scaling policy for a multi-session cloud computer. Elastic Desktop Service allows multiple end users to share a cloud computer in a multi-session cloud computer pool. This helps save costs.', - ], - 'SetDesktopGroupTimer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CpuCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MemorySize', + 'in' => 'query', + 'schema' => ['description' => 'The memory size, in MiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4096', 'title' => ''], + ], + [ + 'name' => 'GpuCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of vGPUs.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DesktopIdForModify', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the WUYING Workspace to reconfigure. If you specify this parameter, the response returns only the instance types that are compatible with the specified workspace.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + ], + [ + 'name' => 'OrderType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The order type.', + 'enumValueTitles' => ['DOWNGRADE' => 'Downgrade', 'UPGRADE' => 'Upgrade'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'DOWNGRADE', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'AppliedScope', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", + 'description' => 'The scope of the instance types to query. Default value: `Public`.', + 'enumValueTitles' => ['Public' => 'Instance types available to all users.', 'SavingPlan' => 'Instance types available only to users of savings plans.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-dbdkfmh883****', + 'required' => false, + 'example' => 'Public', + 'title' => '', ], ], [ - 'name' => 'TimerType', + 'name' => 'DesktopGroupIdForModify', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the desktop group to reconfigure. If you specify this parameter, the response returns only the instance types that are compatible with the specified group.', 'type' => 'string', 'required' => false, 'example' => 'dg-abcdefg****', 'title' => ''], + ], + [ + 'name' => 'GpuDriverType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: scheduled reset'."\n" - .'* 2: scheduled startup'."\n" - .'* 3: scheduled stop'."\n" - .'* 4: scheduled restart', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 1 => '1', - '2', - '3', - '4', - ], - 'example' => '1', + 'description' => 'The GPU driver type.', + 'enumValueTitles' => ['T4' => 'T4', 'A10' => 'A10', 'G28' => 'G28', 'G39' => 'G39'], + 'type' => 'string', + 'required' => false, + 'example' => 'A10', + 'title' => '', ], ], [ - 'name' => 'CronExpression', + 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => 'The cron expression for the scheduled task. This parameter is required when `TimerType` is set to 2, 3, or 4.'."\n", + 'description' => 'The property by which to sort the results. If you omit this parameter, the results are sorted by creation time in descending order.', + 'enumValueTitles' => ['Memory' => 'Sorts the results by memory size.', 'Cpu' => 'Sorts the results by the number of vCPUs.'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '0 0 2 ? * 1-7', + 'example' => 'Memory', + 'title' => '', ], ], [ - 'name' => 'ResetType', + 'name' => 'SortType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the disk that you want to reset.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- does not reset disks.'."\n" - .'- resets only the system disk.'."\n" - .'- resets only the user disk.'."\n" - .'- resets the system disk and the user disk.', - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The sort order.', + 'enumValueTitles' => ['ASC' => 'Ascending order (default)', 'DESC' => 'Descending order'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'does not reset disks.', - 'resets only the system disk.', - 'resets only the user disk.', - 'resets the system disk and the user disk.', - ], - 'example' => '1', + 'example' => 'ASC', + 'title' => '', ], ], [ - 'name' => 'Force', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to forcefully execute the scheduled task.', - 'type' => 'boolean', + 'description' => 'The billing method of the instance types.', + 'enumValueTitles' => ['MonthPackage' => 'Subscription', 'FastBuy' => 'Pay-as-you-go'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'true', + 'example' => 'FastBuy', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DesktopTypeIdList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '388CF76E-FFB3-5174-9F91-CDD****', - ], - ], + 'description' => 'An array of instance type IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the instance type.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise.4c8g', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"388CF76E-FFB3-5174-9F91-CDD****\\"\\n}","type":"json"}]', - 'title' => 'SetDesktopGroupTimer', - 'summary' => 'Configures a scheduled start, stop, restart, or reset task for a cloud computer share.', - ], - 'SetDesktopGroupTimerStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SupportMinSessionCount', + 'in' => 'query', + 'schema' => ['description' => 'Filters for instance types that support at least the specified number of concurrent sessions. This parameter applies only to multi-session instance types.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '> This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'GpuMemory', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-fgxsniu6at****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'TimerType', + 'name' => 'ScopeSet', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: scheduled reset'."\n" - .'* 2: scheduled startup'."\n" - .'* 3: scheduled stop'."\n" - .'* 4: scheduled restart', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - ], - 'example' => '1', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Status', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: enabled'."\n" - .'* 2: disabled'."\n" - .'* 3: deleted'."\n" - .'* 100: unknown', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 1 => '', - '', - '', - 100 => '', - ], - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DesktopScenario', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AC7912E7-8BDF-547F-BCAC****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'DesktopTypes' => [ + 'description' => 'The details of the specifications.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a specification.', + 'type' => 'object', + 'properties' => [ + 'SystemDiskSize' => ['description' => 'The size of the system disk, in GiB.', 'type' => 'string', 'example' => '150', 'title' => ''], + 'DesktopTypeId' => ['description' => 'The specification ID.', 'type' => 'string', 'example' => 'ecd.graphics.xlarge', 'title' => ''], + 'DataDiskSize' => ['description' => 'The size of the data disk, in GiB.', 'type' => 'string', 'example' => '150', 'title' => ''], + 'CpuCount' => ['description' => 'The number of vCPUs.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'GpuCount' => ['description' => 'The number of GPU cores.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU memory size.', 'type' => 'string', 'example' => '16 GiB', 'title' => ''], + 'InstanceTypeFamily' => ['description' => 'The instance type family.', 'type' => 'string', 'example' => 'ecd.graphics', 'title' => ''], + 'MemorySize' => ['description' => 'The memory size, in MiB.', 'type' => 'string', 'example' => '23552', 'title' => ''], + 'DesktopTypeStatus' => ['description' => 'The availability of the specification. A value of `SUFFICIENT` indicates that the specification is in stock.', 'type' => 'string', 'example' => 'SUFFICIENT', 'title' => ''], + 'Scopes' => [ + 'description' => 'The purchase options for the specification.', + 'type' => 'array', + 'items' => [ + 'description' => 'The purchase option.', + 'enumValueTitles' => ['MonthPackage' => 'subscription', 'FastBuy' => 'pay-as-you-go'], + 'type' => 'string', + 'example' => 'FastBuy', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'StockState' => [ + 'description' => 'The inventory status.', + 'enumValueTitles' => ['Insufficient' => 'The specification is out of stock.', 'Sufficient' => 'The specification is in stock.'], + 'type' => 'string', + 'example' => 'Sufficient', + 'title' => '', + ], + 'GpuMemory' => ['description' => 'The GPU memory size in MiB. This parameter is valid only for GPU-accelerated cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], + 'MaxSessionCount' => ['description' => 'The maximum number of concurrent sessions that is supported by the cloud desktop specification.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC7912E7-8BDF-547F-BCAC****\\"\\n}","type":"json"}]', - 'title' => 'SetDesktopGroupTimerStatus', - 'summary' => 'Sets the status of a scheduled task for a cloud computer share, such as enabling or disabling it.', - ], - 'RenewDesktopGroup' => [ - 'summary' => 'Renews a shared cloud computer.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeDesktopTypes', + 'summary' => 'Retrieves cloud computer specifications.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-27T14:56:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-10T08:12:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-25T03:26:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-11-09T02:21:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-07-19T04:01:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-01T01:51:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-31T07:06:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-16T06:34:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopTypes'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopTypes\\": [\\n {\\n \\"SystemDiskSize\\": \\"150\\",\\n \\"DesktopTypeId\\": \\"ecd.graphics.xlarge\\",\\n \\"DataDiskSize\\": \\"150\\",\\n \\"CpuCount\\": \\"2\\",\\n \\"GpuCount\\": 1,\\n \\"GpuSpec\\": \\"16 GiB\\",\\n \\"InstanceTypeFamily\\": \\"ecd.graphics\\",\\n \\"MemorySize\\": \\"23552\\",\\n \\"DesktopTypeStatus\\": \\"SUFFICIENT\\",\\n \\"Scopes\\": [\\n \\"FastBuy\\"\\n ],\\n \\"StockState\\": \\"Sufficient\\",\\n \\"GpuMemory\\": 2048,\\n \\"MaxSessionCount\\": 4,\\n \\"Description\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDesktops' => [ + 'summary' => 'Query the details of your cloud computers.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'high', - 'chargeType' => 'paid', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '52826', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'BusinessChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", + 'description' => 'The region ID. Call [](t2167755.xdita#)to list regions that support Elastic Desktop Service (EDS).', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['Enterprise', 'Business'], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the shared group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-7724r1jitbjzc****', - ], + 'schema' => ['description' => 'The cloud computer pool ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Period', + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud computer status.', 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5****', 'title' => ''], + ], + [ + 'name' => 'DesktopStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The renewal duration. Valid values of this parameter are determined by the value of the `PeriodUnit` parameter.'."\n" + 'description' => 'The number of entries to return on each page in a paged query.'."\n" ."\n" - .'* Valid values if you set the `PeriodUnit` parameter to `Month`: 1, 2, 3, and 6'."\n" - .'* Valid values if you set the `PeriodUnit` parameter to `Year`: 1, 2, 3, 4, and 5'."\n" + .'- Maximum value: 100.'."\n" ."\n" - .'Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'- Default value: 10', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '1', + 'example' => 'Running', + 'title' => '', ], ], [ - 'name' => 'PeriodUnit', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the renewal duration specified by the `Period` parameter.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Month (default)'."\n" - .'* Year'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', - ], + 'schema' => ['description' => 'The token that starts the next query. An empty NextToken means no more results.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the auto-payment feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default): enables the auto-payment feature. Make sure that your account balance is sufficient. Otherwise, an abnormal order is generated.'."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated but you need to make the payment manually. You can log on to the EDS console and complete the payment based on the order ID on the Orders page.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The user name.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'UserName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto-renewal.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The desktop name.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The directory ID. This is the same as the office site ID.', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E55E6732-2028-52FA-AB06-EA29C36B****', - ], - 'OrderId' => [ - 'description' => 'The order IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The order ID.'."\n", - 'type' => 'string', - 'example' => '21455206303****', - ], - ], - ], - 'description' => '', - ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The office site ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E55E6732-2028-52FA-AB06-EA29C36B****\\",\\n \\"OrderId\\": [\\n \\"21455206303****\\"\\n ]\\n}","type":"json"}]', - 'title' => 'RenewDesktopGroup', - ], - 'DeleteDesktopGroup' => [ - 'summary' => 'Releases a cloud computer share.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The name of the office network.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'OfficeSiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The desktop policy ID.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'PolicyGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', - ], + 'schema' => ['description' => 'The billing method for the desktop.', 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy', 'title' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The expiration time for subscription desktops.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go \\[default]', 'PrePaid' => 'Subscription'], + 'type' => 'string', 'required' => false, + 'docRequired' => false, + 'example' => 'PostPaid', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n","errorExample":""}]', - 'title' => 'DeleteDesktopGroup', - 'description' => '* Before releasing a cloud computer share, ensure that no cloud computers within it are in the Connected state and that no end users have access permissions to it.'."\n" - .'* You cannot delete a cloud computer share with an active subscription if it contains cloud computers that have not yet expired.'."\n" - .'* Deleting a pay-as-you-go cloud computer share will release all pay-as-you-go cloud computers within it.', - ], - 'AddUserToDesktopGroup' => [ - 'summary' => 'Adds authorized users for a cloud computer share. The system automatically assigns cloud computers from a share to authorized users based on administrator-configured rules.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ExpiredTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The protocol type.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59:59Z', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", + 'description' => 'The desktop IDs. You can specify 1 to 100 IDs.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud proprietary ASP protocol \\[recommended]'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', + 'example' => 'ASP', + 'title' => '', ], ], [ - 'name' => 'ClientToken', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure the idempotence of a request](~~25693~~).'."\n", - 'type' => 'string', + 'description' => 'The list of authorized users for the desktop. You can specify 1 to 100 users.'."\n" + ."\n" + .'> Only one user can connect to and use the desktop at a time.', + 'type' => 'array', + 'items' => ['description' => 'The authorized user for the desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', + 'example' => 'ecd-gx2x1dhsmucyy****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'EndUserIds', + 'name' => 'EndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the users to whom you want to grant permissions.'."\n", + 'description' => 'The list of authorized users to exclude from the desktop. You can specify 1 to 100 users.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user to whom you want to grant permissions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], + 'items' => ['description' => 'The authorized user to exclude from the desktop.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'maxItems' => 10000, + 'example' => 'alice', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'DesktopGroupIds', + 'name' => 'ExcludedEndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer shares.'."\n", + 'description' => 'Whether to exclude pooled desktops (desktops in a desktop pool).', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-kadkdfaf****', - ], + 'items' => ['description' => 'The authorized user to exclude from the desktop.', 'type' => 'string', 'required' => false, 'example' => 'andy', 'title' => ''], 'required' => false, - 'maxItems' => 100, + 'example' => 'andy', + 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'UserOuPath', + 'name' => 'FilterDesktopGroup', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The management flag.', + 'enumValueTitles' => ['true' => 'Exclude pooled desktops \\[default]', 'false' => 'Do not exclude pooled desktops'], + 'type' => 'boolean', 'required' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'UserGroupName', + 'name' => 'ManagementFlag', 'in' => 'query', 'schema' => [ + 'description' => 'Whether to query image version information for the desktop.', + 'enumValueTitles' => ['Migrating' => 'Migrating', 'Updating' => 'Upgrading or downgrading', 'NoFlag' => 'No flag'], 'type' => 'string', + 'required' => false, + 'example' => 'NoFlag', + 'title' => '', ], ], [ - 'name' => 'SimpleUserGroupId', + 'name' => 'QueryFotaUpdate', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The list of tags. Each tag is a key-value pair used to label resources. Use tags to group and manage desktops, making them easier to search and operate on in bulk. For more information, see [](t2042630.xdita#).', + 'enumValueTitles' => ['true' => 'Query image upgrade information', 'false' => 'Do not query image upgrade information \\[default]'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The object that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'description' => 'The snapshot policy ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag key-value pair. You can assign up to 20 key-value pairs per desktop. Each key must map to exactly one value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. If you specify `Tag`, then `Key` is required. The key can be up to 128 characters long. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. It cannot consist only of whitespace.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The value can be up to 128 characters long. It cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\n","errorExample":""}]', - 'title' => 'AddUserToDesktopGroup', - ], - 'DescribeUsersInGroup' => [ - 'summary' => 'Queries the information about authorized users of a cloud computer share, including the usernames, email addresses, mobile numbers, and cloud computer IDs.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SnapshotPolicyId', + 'in' => 'query', + 'schema' => ['description' => 'Whether to query only pooled desktops (desktops in a desktop pool).', 'type' => 'string', 'required' => false, 'example' => 'sp-hb12mclyne09xw***', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'OnlyDesktopGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The desktop pool ID. If you specify `DesktopId`, this parameter is ignored. If `DesktopId` is empty, the system uses `DesktopGroupId` to retrieve all desktop IDs in the pool.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-8ttn55ujj8nj8****', - ], + 'schema' => ['description' => 'The operating system type.', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'OsTypes', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The desktop instance type. Call [](t2167746.xdita#)to list supported instance types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'required' => false, + 'example' => 'Windows', + 'title' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The list of image IDs.', 'type' => 'string', 'required' => false, 'example' => 'eds.general.2c8g', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'ImageId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the authorized user.'."\n", - 'type' => 'string', + 'description' => 'The list of desktop statuses.', + 'type' => 'array', + 'items' => ['description' => 'The desktop status.', 'type' => 'string', 'required' => false, 'example' => 'm-2g65ljy3ynrdq****', 'title' => ''], 'required' => false, - 'example' => 'alice', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ConnectState', + 'name' => 'DesktopStatusList', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The status of the desktop connection for the end user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- 0: Disconnected.'."\n" - .'- 1: Connected.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - '', + 'description' => 'The elastic GPU pool ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'The desktop status.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], + 'type' => 'string', + 'required' => false, + 'example' => 'Stopped', + 'title' => '', ], - 'example' => '1', + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'QueryUserDetail', + 'name' => 'GpuInstanceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query user details.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['description' => 'The public network bandwidth throttling rule ID.', 'type' => 'string', 'required' => false, 'example' => 'gp-0bm2iz1v6m6nx****', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'QosRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The query string for fuzzy match. If you specify this parameter, the system returns all results that contain the string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], + 'schema' => ['description' => 'The purchase method for the desktop.', 'type' => 'string', 'required' => false, 'example' => 'qos-5605u0gelk200****', 'title' => ''], ], [ - 'name' => 'OrgId', + 'name' => 'SubPayType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the organization to which the end user belongs.'."\n", + 'description' => 'The enterprise resource group ID.', + 'enumValueTitles' => ['duration' => 'Duration package \\[whitelist]', 'postPaid' => 'Pay-as-you-go', 'monthPackage' => 'Monthly package (120 hours or 250 hours)', 'prePaid' => 'Monthly package (unlimited duration)'], 'type' => 'string', 'required' => false, - 'example' => 'org-d0fua2oyukw8j****', + 'example' => 'monthPackage', + 'title' => '', ], ], [ - 'name' => 'EndUserIds', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the authorized users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the authorized user. Only exact match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Whether to query enterprise resource group information.', 'type' => 'string', 'required' => false, 'example' => 'rg-4hsvzbbmqdzu3s****', 'title' => ''], + ], + [ + 'name' => 'FillResourceGroup', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the current page in a paged query.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on each page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Whether multiple resources exist.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'MultiResource', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'IncludeAutoSnapshotPolicy', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'UsersCount' => [ - 'description' => 'The total number of authorized users of the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OnlineUsersCount' => [ - 'description' => 'The total number of authorized users that are connected to cloud computers of the cloud computer share.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'UserOuPath' => [ - 'type' => 'string', - ], - 'UserGroupName' => [ - 'type' => 'string', - ], - 'EndUsers' => [ - 'description' => 'The authorized users.'."\n", + 'NextToken' => ['description' => 'The token that starts the next query. An empty NextToken means no more results.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Desktops' => [ + 'description' => 'Details about the desktops.', 'type' => 'array', 'items' => [ - 'description' => 'The authorized user.'."\n", + 'description' => 'Details about the desktops.', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the authorized user.'."\n", + 'CreationTime' => ['description' => 'The time when the desktop was created.', 'type' => 'string', 'example' => '2020-11-06T08:28Z', 'title' => ''], + 'ChargeType' => [ + 'description' => 'The billing method for the desktop.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go \\[default]', 'PrePaid' => 'Subscription'], 'type' => 'string', - 'example' => 'alice', - ], - 'EndUserEmail' => [ - 'description' => 'The email address of the authorized user.'."\n", + 'example' => 'PostPaid', + 'title' => '', + ], + 'DesktopName' => ['description' => 'The desktop name.', 'type' => 'string', 'example' => 'DemoComputer01', 'title' => ''], + 'PolicyGroupName' => ['description' => 'The policy name.', 'type' => 'string', 'example' => 'All enabled policy', 'title' => ''], + 'SystemDiskSize' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PolicyGroupId' => ['description' => 'The desktop policy ID.', 'type' => 'string', 'example' => 'system-all-enabled-policy', 'title' => ''], + 'DesktopStatus' => ['description' => 'The desktop status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DesktopType' => ['description' => 'The desktop instance type.', 'type' => 'string', 'example' => 'ecd.basic.large', 'title' => ''], + 'GpuCount' => ['description' => 'The number of GPUs.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud proprietary ASP protocol'], 'type' => 'string', - 'example' => 'alice@example.com', + 'example' => 'ASP', + 'title' => '', ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", + 'Memory' => ['description' => 'The memory size. Unit: MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU specification.', 'type' => 'string', 'example' => 'NVIDIA T4', 'title' => ''], + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], + 'DirectoryId' => ['description' => 'The directory ID. This is the same as the office site ID (OfficeSiteId).', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'ManagementFlag' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Migrating' => 'Migrating', 'Updating' => 'Upgrading or downgrading', 'NoFlag' => 'No flag'], 'type' => 'string', - 'example' => 'testName', - ], + 'example' => 'NoFlag', + 'title' => '', + ], + 'DataDiskCategory' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'SystemDiskCategory' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'NetworkInterfaceId' => ['description' => 'The ID of the secondary ENI created by the desktop service under a RAM or AD user. This value cannot be modified.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office site ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'DataDiskSize' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The desktop pool ID that the desktop belongs to. Default value: `null`.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DesktopId' => ['description' => 'The desktop ID.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The office site name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'StartTime' => ['description' => 'The first time the desktop started.', 'type' => 'string', 'example' => '2020-11-06T08:31Z', 'title' => ''], + 'DirectoryType' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'string', 'example' => 'SIMPLE', 'title' => ''], + 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'NetworkInterfaceIp' => ['description' => 'The IP address of the secondary ENI created by the desktop service under a RAM or AD user.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time for subscription desktops.', 'type' => 'string', 'example' => '2021-12-31T15:59Z', 'title' => ''], + 'OsType' => ['description' => 'The operating system type.', 'type' => 'string', 'example' => 'Windows', 'title' => ''], 'ConnectionStatus' => [ - 'description' => 'The connection status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: disconnected'."\n" - .'* 1: connecting', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", + 'description' => 'The connection status of the user.', + 'enumValueTitles' => ['Unknown' => 'Unknown', 'Connected' => 'Connected', 'Disconnected' => 'Disconnected'], 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', + 'example' => 'Disconnected', + 'title' => '', ], - 'EndUserType' => [ - 'description' => 'The user account type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience account'."\n" - .'* AD_CONNECTOR: enterprise Active Directory (AD) account', + 'BundleId' => ['description' => 'The desktop template ID used by the desktop.', 'type' => 'string', 'example' => 'b-2g65ljy4291vl****', 'title' => ''], + 'BundleName' => ['description' => 'The desktop template name used by the desktop.', 'type' => 'string', 'example' => 'TemplateName', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The account system type for the office site.', + 'enumValueTitles' => ['SIMPLE' => 'Convenience account', 'AD_CONNECTOR' => 'Enterprise AD account'], 'type' => 'string', - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], 'example' => 'SIMPLE', + 'title' => '', ], - 'EndUserPhone' => [ - 'description' => 'The mobile number of the authorized user.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'EndUserName' => [ - 'description' => 'The username of the authorized user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'ExternalInfo' => [ - 'description' => 'The appended information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExternalName' => [ - 'description' => 'The external name.'."\n", - 'type' => 'string', - 'example' => 'nameDemo', - ], - 'JobNumber' => [ - 'description' => 'The employee ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - ], - 'UserSetPropertiesModels' => [ - 'description' => 'Details about the seats of users.'."\n", + 'HostName' => ['description' => 'The host name.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'Disks' => [ + 'description' => 'Disk information.', 'type' => 'array', 'items' => [ - 'description' => 'The seat of the end user.'."\n", + 'description' => 'Disk information.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'UserName' => [ - 'description' => 'The username.'."\n", + 'DiskType' => [ + 'description' => 'The disk type.', + 'enumValueTitles' => ['SYSTEM' => 'System disk', 'DATA' => 'Data disk'], 'type' => 'string', - 'example' => 'nameDemo', - ], - 'PropertyId' => [ - 'description' => 'The property ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'example' => 'SYSTEM', + 'title' => '', ], - 'PropertyKey' => [ - 'description' => 'The property name.'."\n", + 'DiskId' => ['description' => 'The disk ID.', 'type' => 'string', 'example' => 'd-jedbpr4sl9l37****', 'title' => ''], + 'DiskSize' => ['description' => 'The disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'PerformanceLevel' => [ + 'description' => 'The performance level of ESSD disks, if the disk uses ESSD.'."\n" + ."\n" + .'For differences between performance levels, see [](t583241.xdita#).', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], 'type' => 'string', - 'example' => 'key', + 'example' => 'PL0', + 'title' => '', ], - 'PropertyType' => [ - 'description' => 'The property type.'."\n" + 'DiskCategory' => [ + 'description' => 'The disk type.'."\n" ."\n" - .'Valid values:'."\n" + .'- cloud\\_efficiency (ultra disk)'."\n" ."\n" - .'* 1: system property'."\n" - .'* 2: custom property', - 'type' => 'integer', - 'format' => 'int32', - 'exclusiveMinimum' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'PropertyValues' => [ - 'description' => 'Details about property values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The property values.'."\n", - 'type' => 'object', - 'properties' => [ - 'PropertyValueId' => [ - 'description' => 'The ID of the property value.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'PropertyValue' => [ - 'description' => 'The property value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], + .' - cloud\\_auto (extreme disk)'."\n" + ."\n" + .' - cloud\\_essd (enhanced SSD disk, supported only on select instance types)', + 'enumValueTitles' => ['cloud_efficiency' => 'Ultra disk', 'cloud_auto' => 'Extreme disk', 'cloud_essd' => 'Enhanced SSD disk, supported only on select instance types'], + 'type' => 'string', + 'example' => 'cloud_auto', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'UserDesktopId' => [ - 'description' => 'The ID of the cloud computer that is used by the user.'."\n", - 'type' => 'string', - 'example' => 'ud-i896ze8hazpvl****', + 'Tags' => [ + 'description' => 'Tag information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Tag information.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'EndUserRemark' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'example' => 'Note', + 'Sessions' => [ + 'description' => 'Session information for the desktop user.', + 'type' => 'array', + 'items' => [ + 'description' => 'Session information for the desktop user.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The user ID connected to the desktop.', 'type' => 'string', 'example' => '29615820929547****', 'title' => ''], + 'EstablishmentTime' => ['description' => 'The time when the desktop session was established.', 'type' => 'string', 'example' => '2021-03-07T08:23Z', 'title' => ''], + 'ExternalUserName' => ['description' => 'The external user name.', 'type' => 'string', 'example' => 'Testname', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EndUserIds' => [ + 'description' => 'The authorized user IDs for the desktop.', + 'type' => 'array', + 'items' => ['description' => 'The authorized user ID for the desktop.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DowngradeQuota' => ['description' => 'The number of times the desktop can be downgraded.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'DowngradedTimes' => ['description' => 'The number of times the desktop has been downgraded.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'GpuCategory' => ['description' => 'Whether the desktop is a GPU desktop.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'GpuDriverVersion' => ['description' => 'The GPU driver version for the desktop.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'ZoneType' => ['description' => 'The type of zone to query. Default value: `AvailabilityZone`, which refers to standard cloud availability zones.', 'type' => 'string', 'example' => 'AvailabilityZone', 'title' => ''], + 'FotaUpdate' => [ + 'description' => 'The image version information for the desktop.', + 'type' => 'object', + 'properties' => [ + 'CurrentAppVersion' => ['description' => 'The current image version number of the desktop.', 'type' => 'string', 'example' => '0.0.0-D-20220102.000000', 'title' => ''], + 'NewAppVersion' => ['description' => 'The image version number to which the desktop can be upgraded.', 'type' => 'string', 'example' => '0.0.0-R-20220307.190736', 'title' => ''], + 'ReleaseNote' => ['description' => 'The description of the upgradeable image version.', 'type' => 'string', 'example' => '测试升级包03-07', 'title' => ''], + 'Size' => ['description' => 'The size of the upgradeable version installation package. Unit: KB.', 'type' => 'integer', 'format' => 'int64', 'example' => '108815097', 'title' => ''], + 'ReleaseNoteEn' => ['description' => 'The English description of the upgradeable version.', 'type' => 'string', 'example' => 'What\'s new', 'title' => ''], + 'ReleaseNoteJp' => ['description' => 'The Japanese description of the upgradeable version.', 'type' => 'string', 'example' => 'リリースノート', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'DisplayName' => [ - 'description' => 'The display name of the enterprise AD account.'."\n", + 'Progress' => ['description' => 'The creation progress of the desktop.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'VolumeEncryptionEnabled' => ['description' => 'Whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the KMS key used when disk encryption is enabled. You can obtain it through the [](t22712.xdita#)interface.', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + 'OfficeSiteVpcType' => [ + 'description' => 'The VPC type of the office site.', + 'enumValueTitles' => ['standard' => 'Standard', 'customized' => 'Customized', 'basic' => 'Basic'], 'type' => 'string', - 'example' => 'alice', + 'example' => 'basic', + 'title' => '', ], - 'UserPrincipalName' => [ + 'Platform' => [ + 'description' => 'The operating system platform information.', + 'enumValueTitles' => ['Ubuntu' => 'Ubuntu', 'Windows Server 2022' => 'Windows Server 2022', 'UOS' => 'UOS', 'CentOS' => 'CentOS', 'Windows Server 2019' => 'Windows Server 2019', 'Windows Server 2016' => 'Windows Server 2016'], 'type' => 'string', + 'example' => 'Ubuntu', + 'title' => '', ], - 'DisplayNameNew' => [ + 'SessionType' => [ + 'description' => 'The session type.', + 'enumValueTitles' => ['SINGLE_SESSION' => 'Single-session', 'MULTIPLE_SESSION' => 'Multi-session'], 'type' => 'string', + 'example' => 'SINGLE_SESSION', + 'title' => '', ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UsersCount\\": 1,\\n \\"OnlineUsersCount\\": 0,\\n \\"UserOuPath\\": \\"\\",\\n \\"UserGroupName\\": \\"\\",\\n \\"EndUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EndUserEmail\\": \\"alice@example.com\\",\\n \\"DesktopName\\": \\"testName\\",\\n \\"ConnectionStatus\\": \\"1\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"EndUserType\\": \\"SIMPLE\\",\\n \\"EndUserPhone\\": \\"1381111****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"nameDemo\\",\\n \\"JobNumber\\": \\"123\\"\\n },\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 123,\\n \\"UserName\\": \\"nameDemo\\",\\n \\"PropertyId\\": 123,\\n \\"PropertyKey\\": \\"key\\",\\n \\"PropertyType\\": 1,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 123,\\n \\"PropertyValue\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"UserDesktopId\\": \\"ud-i896ze8hazpvl****\\",\\n \\"EndUserRemark\\": \\"Note\\",\\n \\"DisplayName\\": \\"alice\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 750E6E83-F9FC-528A-AE24-1FAE249B30FE\\n 1\\n 0\\n \\n alice\\n alice@example.com\\n testName\\n 1\\n ud-7ftf5b6yu77b0****\\n SIMPLE\\n 1871234****\\n alice\\n \\n","errorExample":""}]', - 'title' => 'DescribeUsersInGroup', - ], - 'DescribeUserConnectionRecords' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'ManagementFlags' => [ + 'description' => 'The management flags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The management status of the desktop.', + 'enumValueTitles' => ['Migrating' => 'Migrating office network', 'Hibernated' => 'Hibernated', 'UnderMaintenance' => 'In maintenance mode', 'MigratingProtocol' => 'Migrating protocol', 'EnterMaintenance' => 'Entering maintenance mode', 'WakingUp' => 'Waking up', 'Updating' => 'Upgrading', 'NoFlag' => 'Stateless', 'Assigning' => 'Assigning user', 'Hibernating' => 'Hibernating'], + 'type' => 'string', + 'example' => '["NoFlag"]', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SnapshotPolicyId' => ['description' => 'The snapshot policy ID.', 'type' => 'string', 'title' => '', 'example' => 'sp-gi007jgyc3kce****'], + 'SnapshotPolicyName' => ['description' => 'The snapshot policy name.', 'type' => 'string', 'title' => '', 'example' => 'testSnapshotName'], + 'BindAmount' => ['description' => 'The number of concurrent sessions allowed per desktop in a multi-session desktop pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'PolicyGroupIdList' => [ + 'description' => 'The collection of desktop policy IDs.', + 'type' => 'array', + 'items' => ['description' => 'The desktop policy ID.', 'type' => 'string', 'example' => 'pg-dasffjkdf*****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PolicyGroupNameList' => [ + 'description' => 'The list of desktop policy names.', + 'type' => 'array', + 'items' => ['description' => 'The desktop policy name.', 'type' => 'string', 'example' => '测试策略01', 'title' => ''], + 'title' => '', + 'example' => 'Test policy 01', + ], + 'HibernationOptionsConfigured' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SupportHibernation' => ['description' => 'Whether hibernation is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HibernationBeta' => ['description' => '> This parameter is in invitational preview and is not available for use.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ResourceGroups' => [ + 'description' => 'The list of enterprise resource group information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The enterprise resource group information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The enterprise resource group name.', 'type' => 'string', 'example' => 'Resource group 01', 'title' => ''], + 'Id' => ['description' => 'The enterprise resource group ID.', 'type' => 'string', 'example' => 'rg-4hsvzbbmqdzu3s****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'StandardStartTime' => ['description' => 'The standard start time.', 'type' => 'string', 'title' => '', 'example' => ''], + 'OsUpdate' => [ + 'type' => 'object', + 'properties' => [ + 'CheckId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PackageCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Packages' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Kb' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Title' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'IsLdap' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'DomainType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SerialNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AccountType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntraDomainName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AgentProviderList' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number of the current page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The maximum number of entries to return on each page in a paged query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TotalCount\\": 1,\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"DemoComputer01\\",\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"SystemDiskSize\\": 0,\\n \\"PolicyGroupId\\": \\"system-all-enabled-policy\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"GpuCount\\": 1,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"Memory\\": 4096,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"DataDiskCategory\\": \\"null\\",\\n \\"SystemDiskCategory\\": \\"null\\",\\n \\"NetworkInterfaceId\\": \\"123456\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"DataDiskSize\\": \\"null\\",\\n \\"DesktopGroupId\\": \\"null\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"OfficeSiteName\\": \\"default\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"Cpu\\": 2,\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"BundleId\\": \\"b-2g65ljy4291vl****\\",\\n \\"BundleName\\": \\"TemplateName\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"HostName\\": \\"testName\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80,\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"DiskCategory\\": \\"cloud_auto\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"29615820929547****\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\",\\n \\"ExternalUserName\\": \\"Testname\\"\\n }\\n ],\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"DowngradeQuota\\": 3,\\n \\"DowngradedTimes\\": 0,\\n \\"GpuCategory\\": 0,\\n \\"GpuDriverVersion\\": \\"null\\",\\n \\"ZoneType\\": \\"AvailabilityZone\\",\\n \\"FotaUpdate\\": {\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.000000\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.190736\\",\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": 108815097,\\n \\"ReleaseNoteEn\\": \\"What\'s new\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\"\\n },\\n \\"Progress\\": \\"100%\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"OfficeSiteVpcType\\": \\"basic\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ManagementFlags\\": [\\n \\"[\\\\\\"NoFlag\\\\\\"]\\"\\n ],\\n \\"SnapshotPolicyId\\": \\"sp-gi007jgyc3kce****\\",\\n \\"SnapshotPolicyName\\": \\"testSnapshotName\\",\\n \\"BindAmount\\": 2,\\n \\"PolicyGroupIdList\\": [\\n \\"pg-dasffjkdf*****\\"\\n ],\\n \\"PolicyGroupNameList\\": [\\n \\"测试策略01\\"\\n ],\\n \\"HibernationOptionsConfigured\\": true,\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"ResourceGroups\\": [\\n {\\n \\"Name\\": \\"Resource group 01\\",\\n \\"Id\\": \\"rg-4hsvzbbmqdzu3s****\\"\\n }\\n ],\\n \\"StandardStartTime\\": \\"\\",\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"\\",\\n \\"PackageCount\\": 0,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n },\\n \\"IsLdap\\": false,\\n \\"DomainType\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\",\\n \\"AgentProviderList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]', + 'title' => 'DescribeDesktops', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-29T08:05:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-28T03:28:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-21T07:30:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-17T12:02:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-24T02:43:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-29T05:29:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-07-04T13:58:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-06-17T11:57:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-22T09:14:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-11T08:23:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-29T02:24:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-19T09:17:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-03T09:44:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-18T06:09:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-06T07:41:37.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-14T02:36:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-04T09:33:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-07T06:26:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-09-26T03:59:24.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeDesktops'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'DescribeDesktopsInGroup' => [ + 'summary' => 'Find cloud computers in a shared cloud computer by billing method.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the authorized user.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alice', - ], + 'schema' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'EndUserType', + 'name' => 'PayType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the user account.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience account'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* AD_CONNECTOR: enterprise AD account'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go', 'PrePaid' => 'subscription'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'SIMPLE', + 'example' => 'PrePaid', + 'title' => '', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The maximum number of entries to return on a single page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'ConnectStartTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the cloud desktop starts to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1631239200000', - ], - ], - [ - 'name' => 'ConnectStartTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the cloud desktop starts to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1631241000000', - ], - ], - [ - 'name' => 'ConnectEndTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the cloud desktop stops to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1631266200000', - ], - ], - [ - 'name' => 'ConnectEndTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the cloud desktop stops to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1631268000000', - ], + 'schema' => ['description' => 'The token that is used to start the next query. If this parameter is empty, all results are returned.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'ConnectDurationFrom', + 'name' => 'IgnoreDeleted', 'in' => 'query', 'schema' => [ - 'description' => 'The duration when the cloud desktop is connected, which is the minimum value for condition filtering.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specifies whether to return deleted desktops.', + 'enumValueTitles' => ['true' => 'Returns deleted desktops. (Default)', 'false' => 'Does not return deleted desktops.'], + 'type' => 'boolean', 'required' => false, - 'example' => '100', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'ConnectDurationTo', + 'name' => 'CustomStartTimePeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration when the cloud desktop is connected, which is the maximum value for condition filtering.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'CustomEndTimePeriod', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-138dsptkrt00u****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03', + 'PostPaidDesktopsCount' => ['description' => 'The total number of pay-as-you-go cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'PaidDesktopsCount' => ['description' => 'The total number of subscription cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'PostPaidDesktopsTotalAmount' => ['description' => 'The total billed amount for the pay-as-you-go cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'PaidDesktops' => [ + 'description' => 'A list of subscription cloud desktops.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a subscription cloud desktop.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the authorized end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'DesktopStatus' => [ + 'description' => 'The status of the cloud desktop.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], + 'ConnectionStatus' => [ + 'description' => 'The connection status of the cloud desktop.', + 'enumValueTitles' => ['Unknown' => 'Unknown', 'Connected' => 'Connected', 'Disconnected' => 'Disconnected'], + 'type' => 'string', + 'example' => 'Connected', + 'title' => '', + ], + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ud-7ftf5b6yu77b0****', 'title' => ''], + 'EndUserName' => ['description' => 'The name of the authorized end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ManagementFlag' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Updating' => 'Updating', 'NoFlag' => 'No flag'], + 'type' => 'string', + 'example' => 'NoFlag', + 'title' => '', + ], + 'EndUserIds' => [ + 'description' => 'The IDs of end users connected to the cloud desktop. If no end user is connected, the array is empty.', + 'type' => 'array', + 'items' => ['description' => 'The end user ID.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'EndUserNames' => [ + 'description' => 'The usernames of end users connected to the cloud desktop. If no end user is connected, the array is empty.', + 'type' => 'array', + 'items' => ['description' => 'The end user name.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ResetTime' => ['description' => 'The time when the cloud desktop was last reset.', 'type' => 'string', 'example' => '2021-03-03 08:48:08', 'title' => ''], + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-hn5v2mmk0****', 'title' => ''], + 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'Win10_ZC', 'title' => ''], + 'SystemDiskSize' => ['description' => 'The size of the system disk, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'OsType' => [ + 'description' => 'The type of the operating system.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', + ], + 'GpuDriverVersion' => ['description' => 'The GPU driver version.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'DiskType' => [ + 'description' => 'The disk type.', + 'enumValueTitles' => ['SYSTEM' => 'system disk', 'DATA' => 'data disk'], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', + ], + 'ManagementFlags' => [ + 'description' => 'The management flags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Updating' => 'Updating', 'NoFlag' => 'No flag'], + 'type' => 'string', + 'example' => 'NoFlag', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MemberEniIp' => ['description' => 'The IP address of the secondary elastic network interface of the instance.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'PrimaryEniIp' => ['description' => 'The IP address of the primary network interface of the instance.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The session protocol.', + 'enumValueTitles' => ['HDX' => 'High-Definition Experience (HDX) protocol', 'ASP' => 'Adaptive Streaming Protocol (ASP), a proprietary protocol developed by Alibaba Cloud'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'FotaVersion' => ['description' => 'The image version.', 'type' => 'string', 'example' => '0.1.0-R-20220914.17****', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time of the subscription cloud desktop.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ConnectionRecords' => [ - 'description' => 'The connection records.'."\n", + 'PostPaidDesktops' => [ + 'description' => 'A list of pay-as-you-go cloud desktops.', 'type' => 'array', 'items' => [ - 'description' => 'The connection record.'."\n", + 'description' => 'The details of a pay-as-you-go cloud desktop.', 'type' => 'object', 'properties' => [ - 'ConnectionRecordId' => [ - 'description' => 'The ID of the connection record.'."\n", + 'CreateDuration' => ['description' => 'The retention period of the cloud desktop, in milliseconds.', 'type' => 'string', 'example' => '4153958447', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the authorized end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'DesktopStatus' => [ + 'description' => 'The status of the cloud desktop.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], 'type' => 'string', - 'example' => '528', + 'example' => 'Stopped', + 'title' => '', ], - 'ConnectStartTime' => [ - 'description' => 'The time when the end user connected to the cloud computer.'."\n", + 'CreateTime' => ['description' => 'The creation time of the cloud desktop.', 'type' => 'string', 'example' => '2022-01-21T06:34:57Z', 'title' => ''], + 'ReleaseTime' => ['description' => 'The release time of the cloud desktop.', 'type' => 'string', 'example' => '2022-01-21T16:34:57Z', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], + 'ConnectionStatus' => [ + 'description' => 'The connection status of the cloud desktop.', + 'enumValueTitles' => ['Unknown' => 'Unknown', 'Connected' => 'Connected', 'Disconnected' => 'Disconnected'], 'type' => 'string', - 'example' => '2022-01-19T10:12:38Z', + 'example' => 'Connected', + 'title' => '', ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer to which the end user connected.'."\n", + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ud-2i8qxpv6t1a07****', 'title' => ''], + 'EndUserName' => ['description' => 'The name of the authorized end user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ManagementFlag' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Updating' => 'Updating', 'NoFlag' => 'No flag'], 'type' => 'string', - 'example' => 'testName', + 'example' => 'NoFlag', + 'title' => '', + ], + 'EndUserIds' => [ + 'description' => 'The IDs of end users connected to the cloud desktop. If no end user is connected, the array is empty.', + 'type' => 'array', + 'items' => ['description' => 'The end user ID.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'EndUserNames' => [ + 'description' => 'The usernames of end users connected to the cloud desktop. If no end user is connected, the array is empty.', + 'type' => 'array', + 'items' => ['description' => 'The end user name.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'ConnectDuration' => [ - 'description' => 'The connection duration. Unit: milliseconds.'."\n", + 'ResetTime' => ['description' => 'The time when the cloud desktop was last reset.', 'type' => 'string', 'example' => '2021-03-03 08:48:08', 'title' => ''], + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-hn5v2mmk0****', 'title' => ''], + 'ImageName' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'Win10_ZC', 'title' => ''], + 'SystemDiskSize' => ['description' => 'The size of the system disk, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'OsType' => [ + 'description' => 'The type of the operating system.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], 'type' => 'string', - 'example' => '3405035000', + 'example' => 'Windows', + 'title' => '', ], - 'ConnectEndTime' => [ - 'description' => 'The time when the end user disconnected from the cloud computer.'."\n", + 'GpuDriverVersion' => ['description' => 'The GPU driver version.', 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'DiskType' => [ + 'description' => 'The disk type.', + 'enumValueTitles' => ['SYSTEM' => 'system disk', 'DATA' => 'data disk'], 'type' => 'string', - 'example' => '2022-02-27T20:03:13Z', + 'example' => 'SYSTEM', + 'title' => '', + ], + 'ManagementFlags' => [ + 'description' => 'The management flags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The management flag.', + 'enumValueTitles' => ['Updating' => 'Updating', 'NoFlag' => 'No flag'], + 'type' => 'string', + 'example' => 'NoFlag', + 'title' => '', + ], + 'title' => '', + 'example' => '', ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer to which the end user connected.'."\n", + 'MemberEniIp' => ['description' => 'The IP address of the secondary elastic network interface of the instance.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'PrimaryEniIp' => ['description' => 'The IP address of the primary network interface of the instance.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The session protocol.', + 'enumValueTitles' => ['HDX' => 'High-Definition Experience (HDX) protocol', 'ASP' => 'Adaptive Streaming Protocol (ASP), a proprietary protocol developed by Alibaba Cloud'], 'type' => 'string', - 'example' => 'ud-2hawufy3uedi1****', + 'example' => 'HDX', + 'title' => '', ], + 'FotaVersion' => ['description' => 'The image version.', 'type' => 'string', 'example' => '0.1.0-R-20220914.17****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'OnlinePrePaidDesktopsCount' => ['description' => 'The number of connected subscription cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'RunningPrePaidDesktopsCount' => ['description' => 'The number of running subscription cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'StopedPrePaidDesktopsCount' => ['description' => 'Deprecated. This parameter is misspelled. Use `StoppedPrePaidDesktopsCount` instead.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'StoppedPrePaidDesktopsCount' => ['description' => 'The number of stopped subscription cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\",\\n \\"ConnectionRecords\\": [\\n {\\n \\"ConnectionRecordId\\": \\"528\\",\\n \\"ConnectStartTime\\": \\"2022-01-19T10:12:38Z\\",\\n \\"DesktopName\\": \\"demoComputer\\",\\n \\"ConnectDuration\\": \\"1800000\\",\\n \\"ConnectEndTime\\": \\"2022-02-27T20:03:13Z\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\n \\n 528\\n 2022-01-19T10:12:38Z\\n testName\\n 3405035000\\n 2022-02-27T20:03:13Z\\n ud-2hawufy3uedi1****\\n \\n","errorExample":""}]', - 'title' => 'DescribeUserConnectionRecords', - 'summary' => 'Queries the connection records of an authorized user to cloud computers in a cloud computer pool.', - ], - 'ModifyUserToDesktopGroup' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeDesktopsInGroup', + 'changeSet' => [ + ['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-27T02:51:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-19T11:39:22.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-14T06:26:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-17T08:46:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopsInGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopsInGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PostPaidDesktopsCount\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"PaidDesktopsCount\\": 10,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PostPaidDesktopsTotalAmount\\": 10000,\\n \\"PaidDesktops\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-7ftf5b6yu77b0****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\",\\n \\"ExpiredTime\\": \\"\\"\\n }\\n ],\\n \\"PostPaidDesktops\\": [\\n {\\n \\"CreateDuration\\": \\"4153958447\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Stopped\\",\\n \\"CreateTime\\": \\"2022-01-21T06:34:57Z\\",\\n \\"ReleaseTime\\": \\"2022-01-21T16:34:57Z\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-2i8qxpv6t1a07****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"HDX\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\"\\n }\\n ],\\n \\"OnlinePrePaidDesktopsCount\\": 100,\\n \\"RunningPrePaidDesktopsCount\\": 100,\\n \\"StopedPrePaidDesktopsCount\\": 100,\\n \\"StoppedPrePaidDesktopsCount\\": 100\\n}","type":"json"}]', + ], + 'DescribeDevices' => [ + 'summary' => 'Queries the list of trusted devices.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the device. The serial number (SN) of the hardware client or the UUID of the software client.'."\n", 'type' => 'string', 'required' => false, 'example' => '5F52817BE267A43C608D245070D2****'."\n", 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the bound user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the convenient office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], + ], + [ + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => ['description' => 'The address of the Active Directory (AD) office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****', 'title' => ''], + ], + [ + 'name' => 'UserType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The account type of the user.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AD: enterprise AD account.'."\n" + .'* SIMPLE: convenience account'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'enumValueTitles' => ['AD' => '', 'SIMPLE' => ''], + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", + 'description' => 'The type of the client.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: hardware client.'."\n" + .'* 2: software client.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', + 'enumValueTitles' => [1 => '', ''], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'OldEndUserIds', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the end users that you want to remove. You can configure 1 to 500 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of an end user that you want to remove.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => true, - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NewEndUserIds', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the end users that you want to add. You can configure 1 to 500 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of an end user that you want to add.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jack', - ], - 'required' => true, - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****'], + 'Devices' => [ + 'description' => 'The information about devices that you queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the device that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DeviceId' => ['description' => 'The ID of the device. The serial number (SN) of the hardware client or the UUID of the software client.'."\n", 'type' => 'string', 'example' => '5F52817BE267A43C608D245070D2****'."\n", 'title' => ''], + 'EndUserList' => [ + 'description' => 'The users who are bound to the device.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The user who is bound to the device.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'UserType' => [ + 'description' => 'The account type of the user.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AD: enterprise AD account.'."\n" + .'* SIMPLE: convenience account'."\n", + 'type' => 'string', + 'enumValueTitles' => ['AD' => '', 'SIMPLE' => ''], + 'example' => 'SIMPLE', + 'title' => '', + ], + 'DirectoryId' => ['description' => 'The ID of the convenient office network.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'."\n", 'title' => ''], + 'AdDomain' => ['description' => 'The address of the AD office network.'."\n", 'type' => 'string', 'example' => 'xn--0zw****'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CFC74699-6F9C-5437-861A-D186E3347B7E\\n","errorExample":""}]', - 'title' => 'ModifyUserToDesktopGroup', - 'summary' => 'Replaces the existing authorized users of a cloud computer share with different users', - ], - 'RemoveUserFromDesktopGroup' => [ - 'summary' => 'Revokes user access permissions for a cloud computer share. Once access permissions for a cloud computer share are revoked from a user, the user can no longer access any cloud computers within that share.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEFE642-A383-4A18-8939-FB7DE452****\\",\\n \\"Devices\\": [\\n {\\n \\"DeviceId\\": \\"5F52817BE267A43C608D245070D2****\\\\n\\",\\n \\"EndUserList\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"UserType\\": \\"SIMPLE\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\n\\",\\n \\"AdDomain\\": \\"xn--0zw****\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDevices', + 'responseParamsDescription' => 'If no user is bound, \\[] is returned as the value of the endUserList parameter.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'], + ], ], + 'ramActions' => [], + ], + 'DescribeDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopGroupId', + 'name' => 'DirectoryType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer share.'."\n", + 'description' => 'The directory type.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* SIMPLE: the convenience directory.'."\n" + .'* AD_CONNECTOR: the Active Directory (AD) directory.'."\n", 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'dg-2i8qxpv6t1a03****', + 'docRequired' => false, + 'enumValueTitles' => ['SIMPLE' => '', 'AD_CONNECTOR' => ''], + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'EndUserIds', + 'name' => 'DirectoryStatus', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the authorized users that you want to remove.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the authorized user that you want to remove.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'required' => false, - 'maxItems' => 10000, - ], + 'schema' => ['description' => 'The directory status. This parameter is equivalent to `Status`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'REGISTERED', 'title' => ''], ], [ - 'name' => 'DesktopGroupIds', + 'name' => 'MaxResults', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer shares.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-kadkdfaf****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'UserOuPath', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'UserGroupName', + 'name' => 'DirectoryId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'Details of directory IDs. You can specify one or more directory IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the directory.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'required' => false, + 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'SimpleUserGroupId', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CFC74699-6F9C-5437-861A-D186E3347B7E\\n","errorExample":""}]', - 'title' => 'RemoveUserFromDesktopGroup', - ], - 'CreateNetworkPackage' => [ - 'summary' => 'Creates a premium bandwidth plan for an office network.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Bandwidth', - 'in' => 'query', - 'schema' => [ - 'description' => 'The bandwidth provided by the premium bandwidth plan. Unit: Mbit/s.'."\n" - ."\n" - .'* Valid values if the premium bandwidth plan is a subscription plan: 2 to 1000.'."\n" - .'* Valid values if the premium bandwidth plan is a pay-as-you-go plan that charges by data transfer (PayByTraffic): 2 to 200.'."\n" - .'* Valid values if the premium bandwidth plan is a pay-as-you-go plan that charges by fixed bandwidth (PayByBandwidth): 2 to 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '20000', - 'minimum' => '2', - 'example' => '10', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - [ - 'name' => 'PayType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the premium bandwidth plan.'."\n" + 'description' => 'The directory status.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* PostPaid: pay-as-you-go'."\n" - .'* PrePaid: subscription', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PrePaid', - ], - ], - [ - 'name' => 'InternetChargeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The charge type of the premium bandwidth plan.'."\n" + .'* REGISTERING: The directory is being registered.'."\n" ."\n" - .'* Valid value when the `PayType` parameter is set to `PrePaid`:'."\n" + .' '."\n" ."\n" - .' * PayByBandwidth: charges by fixed bandwidth.'."\n" + .' '."\n" ."\n" - .'* Valid values when the `PayType` parameter is set to `PostPaid`:'."\n" + .' '."\n" ."\n" - .' * PayByTraffic: charges by data transfer.'."\n" - .' * PayByBandwidth: charges by fixed bandwidth.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'PayByTraffic' => '', - 'PayByBandwidth' => '', - ], - 'example' => 'PayByTraffic', - ], - ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when the `PayType` parameter is set to `PrePaid`. The valid values of this parameter vary based on the `PeriodUnit` value.'."\n" + .'* DEREGISTERING: The directory is being deregistered.'."\n" ."\n" - .'* Valid value when the `PeriodUnit` parameter is set to `Week`: 1'."\n" - .'* Valid values when the `PeriodUnit` parameter is set to `Month`: 1, 2, 3, and 6'."\n" - .'* Valid values when the `PeriodUnit` parameter is set to `Year`: 1, 2, and 3'."\n" + .' '."\n" ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the subscription duration of the premium bandwidth plan. This parameter takes effect and is required only when the `PayType` parameter is set to `PrePaid`.'."\n" + .' '."\n" ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* Month'."\n" + .'* REGISTERED: The directory is registered.'."\n" ."\n" .' '."\n" ."\n" @@ -20496,7 +17384,7 @@ ."\n" .' '."\n" ."\n" - .'* Year'."\n" + .'* NEEDCONFIGTRUST: A trust relationship needs to be configured for the directory.'."\n" ."\n" .' '."\n" ."\n" @@ -20504,70 +17392,31 @@ ."\n" .' '."\n" ."\n" - .'* Week'."\n" + .'* CONFIGTRUSTFAILED: A trust relationship fails to be configured for the directory.'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => 'Month', - 'Year' => 'Year', - 'Week' => 'Week', - ], - 'example' => 'Month', - ], - ], - [ - 'name' => 'AutoPay', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the automatic payment feature.'."\n" - ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* true (default): enables the auto-payment feature.'."\n" + .'* DEREGISTERED: The directory is deregistered.'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' Make sure that your account has sufficient balance. Otherwise, no order is generated.'."\n" - ."\n" .' '."\n" ."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated but you need to make the payment manually.'."\n" + .'* ERROR: One or more configurations of the directory are invalid.'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' To make the payment, log on to the Elastic Desktop Service console, go to the Orders page, and find the order based on the order ID.'."\n" - ."\n" - .' ', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable auto-renewal for the premium bandwidth plan.'."\n" - ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* true'."\n" + .'* CONFIGTRUSTING: A trust relationship is being configured.'."\n" ."\n" .' '."\n" ."\n" @@ -20575,181 +17424,18 @@ ."\n" .' '."\n" ."\n" - .'* false'."\n" + .'* NEEDCONFIGUSER: Users need to be configured for the directory.'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'PromotionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the sales promotion.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23141', - ], - ], - [ - 'name' => 'ResellerOwnerUid', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - ], - [ - 'name' => 'ChannelCookie', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NetworkPackageId' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'example' => 'np-amtp8e8q1o9e4****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', - ], - 'OrderId' => [ - 'description' => 'The ID of the bill.'."\n", - 'type' => 'string', - 'example' => '234526262716724', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'RISK.RISK_CONTROL_REJECTION', - 'errorMessage' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OrderId\\": \\"234526262716724\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\n np-amtp8e8q1o9e4****\\n","errorExample":""}]', - 'title' => 'CreateNetworkPackage', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeNetworkPackages' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 100'."\n" - .'* Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The token that determines the start point of the next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'NetworkPackageId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of the premium bandwidth plan. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'np-amtp8e8q1o9e4****', - ], - 'required' => false, - 'example' => 'np-amtp8e8q1o9e4****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'InternetChargeType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The charge type of the pay-as-you-go premium bandwidth plan.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PayByTraffic: charges by data transfer.'."\n" - ."\n" - .'* PayByBandwidth: charges by fixed bandwidth.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'PayByTraffic' => 'PayByTraffic', - 'PayByBandwidth' => 'PayByBandwidth', - ], - 'example' => 'PayByBandwidth', + 'enumValueTitles' => ['REGISTERING' => '', 'DEREGISTERING' => '', 'REGISTERED' => '', 'NEEDCONFIGTRUST' => '', 'CONFIGTRUSTFAILED' => '', 'DEREGISTERED' => '', 'ERROR' => '', 'CONFIGTRUSTING' => '', 'NEEDCONFIGUSER' => ''], + 'example' => 'REGISTERED', + 'title' => '', ], ], ], @@ -20759,124 +17445,60 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query. If the value of this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'NetworkPackages' => [ - 'description' => 'The premium bandwidth plans.'."\n", + 'NextToken' => ['description' => 'The token that is used for the next query. If this parameter is empty, all results are returned.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F369A091-002F-49C8-AD55-02A776297C7B', 'title' => ''], + 'Directories' => [ + 'description' => 'The directories.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Details of the Internet access package.'."\n", + 'description' => 'Details of the directory.'."\n", 'type' => 'object', 'properties' => [ - 'NetworkPackageId' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'example' => 'np-amtp8e8q1o9e4****', - ], - 'Bandwidth' => [ - 'description' => 'The bandwidth provided by the premium bandwidth plan. Unit: Mbit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ExpiredTime' => [ - 'description' => 'The time when the premium bandwidth plan expires.'."\n" - ."\n" - .'* If the plan is a subscription one, the time when the plan expires is returned.'."\n" - .'* If the plan is a pay-as-you-go one, `2099-12-31T15:59:59Z` is returned.'."\n", - 'type' => 'string', - 'example' => '2099-12-31T15:59:59Z', - ], - 'CreateTime' => [ - 'description' => 'The time when the premium bandwidth plan was created.'."\n", - 'type' => 'string', - 'example' => '2021-05-10T02:35:26Z', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'PayType' => [ - 'description' => 'The billing method of the premium bandwidth plan.'."\n" + 'EnableInternetAccess' => ['description' => 'Indicates whether access over the Internet is enabled.'."\n" + ."\n" + .'> This parameter is unavailable.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the VPC to which the vSwitch belongs. This parameter is returned only when the directory type is AD office network.'."\n", 'type' => 'string', 'example' => 'vpc-uf6tz5k67puge5jn8****', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the directory was created.'."\n", 'type' => 'string', 'example' => '2020-11-02T01:44Z', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the AD directory.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* PostPaid: pay-as-you-go'."\n" - .'* PrePaid: subscription', - 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => 'PostPaid', - 'PrePaid' => 'PrePaid', - ], - 'example' => 'PostPaid', - ], - 'InternetChargeType' => [ - 'description' => 'The charge type of the premium bandwidth plan.'."\n" + .'* REGISTERING'."\n" ."\n" - .'* Valid value when the `PayType` parameter is set to `PrePaid`:'."\n" + .' '."\n" ."\n" - .' * PayByBandwidth: charges by fixed bandwidth.'."\n" + .' '."\n" ."\n" - .'* Valid values when the `PayType` parameter is set to `PostPaid`:'."\n" + .' '."\n" ."\n" - .' * PayByTraffic: charges by data transfer.'."\n" - .' * PayByBandwidth: charges by fixed bandwidth.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PayByTraffic' => 'PayByTraffic', - 'PayByBandwidth' => 'PayByBandwidth', - ], - 'example' => 'PayByTraffic', - ], - 'ReservationInternetChargeType' => [ - 'description' => 'The billing method of the reserved network bandwidth.'."\n" + .'* REGISTERED'."\n" ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* PayByTraffic: charges by data transfer.'."\n" + .' '."\n" ."\n" - .'* PayByBandwidth: charges by fixed bandwidth.', - 'type' => 'string', - 'enumValueTitles' => [ - 'PayByTraffic' => 'PayByTraffic', - 'PayByBandwidth' => 'PayByBandwidth', - ], - 'example' => 'PayByBandwidth', - ], - 'ReservationBandwidth' => [ - 'description' => 'The peak bandwidth that is reserved for the premium bandwidth plan. Unit: Mbit/s.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ReservationActiveTime' => [ - 'description' => 'The time when the reserved network bandwidth took effect.'."\n", + .' '."\n", 'type' => 'string', - 'example' => '2021-07-10T00:00:00Z', - ], - 'NetworkPackageStatus' => [ - 'description' => 'The status of the premium bandwidth plan.'."\n" + 'enumValueTitles' => ['REGISTERING' => '', 'REGISTERED' => ''], + 'example' => 'REGISTERING', + 'title' => '', + ], + 'DomainPassword' => ['description' => 'The password of the domain administrator. This parameter is returned only when the directory type is AD office network.'."\n", 'type' => 'string', 'example' => 'testPassword', 'title' => ''], + 'EnableAdminAccess' => ['description' => 'Indicates whether the local administrator permissions are granted to users that use cloud computers in the office network.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SubDomainName' => ['description' => 'The fully qualified domain name (FQDN) of the existing AD subdomain. The value contains both the host name and the domain name.'."\n", 'type' => 'string', 'example' => 'child.example.com', 'title' => ''], + 'DomainUserName' => ['description' => 'The username of the domain administrator.'."\n", 'type' => 'string', 'example' => 'sAMAccountName', 'title' => ''], + 'EnableCrossDesktopAccess' => ['description' => 'Indicates whether cloud computers can communicate with each other in the directory.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CustomSecurityGroupId' => ['description' => 'The security group ID. This parameter is returned only when the directory type is AD office network.'."\n", 'type' => 'string', 'example' => 'sg-bp1ce64o4g9mdf5u****', 'title' => ''], + 'DesktopVpcEndpoint' => ['description' => 'The endpoint that is used to connect to cloud computers in the directory over a VPC.'."\n", 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + 'SsoEnabled' => ['description' => 'Indicates whether single sign-on (SSO) is enabled.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DomainName' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'DesktopAccessType' => [ + 'description' => 'The method in which the cloud computer is connected.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Creating'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Released'."\n" + .'* VPC'."\n" ."\n" .' '."\n" ."\n" @@ -20884,7 +17506,7 @@ ."\n" .' '."\n" ."\n" - .'* InUse'."\n" + .'* Internet'."\n" ."\n" .' '."\n" ."\n" @@ -20892,7 +17514,7 @@ ."\n" .' '."\n" ."\n" - .'* Releasing'."\n" + .'* Any'."\n" ."\n" .' '."\n" ."\n" @@ -20900,50 +17522,17 @@ ."\n" .' '."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'Creating' => 'Creating', - 'Released' => 'Released', - 'InUse' => 'InUse', - 'Releasing' => 'Releasing', - ], - 'example' => 'InUse', - ], - 'OfficeSiteName' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'OfficeSiteVpcType' => [ - 'description' => 'The type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* standard: advanced office network'."\n" - .'* customized: custom office network'."\n" - .'* basic: basic office network', - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => 'standard', - 'customized' => 'customized', - 'basic' => 'basic', - ], - 'example' => 'basic', - ], - 'EipAddresses' => [ - 'description' => 'The public egress IP address of the premium bandwidth plan.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The public egress IP address of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'example' => '120.2.XX.XX', - ], + 'enumValueTitles' => ['VPC' => '', 'Internet' => '', 'Any' => ''], + 'example' => 'Internet', + 'title' => '', ], - 'BusinessStatus' => [ - 'description' => 'The business status.'."\n" + 'MfaEnabled' => ['description' => 'Indicates whether MFA is enabled.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DirectoryType' => [ + 'description' => 'The directory type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Expired'."\n" + .'* AD_CONNECTOR: AD directory'."\n" ."\n" .' '."\n" ."\n" @@ -20951,7 +17540,7 @@ ."\n" .' '."\n" ."\n" - .'* Normal'."\n" + .'* RAM: RAM directory'."\n" ."\n" .' '."\n" ."\n" @@ -20959,1299 +17548,1611 @@ ."\n" .' '."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'Expired' => '', - 'Normal' => '', + 'enumValueTitles' => ['AD_CONNECTOR' => 'AD_CONNECTOR', 'RAM' => 'RAM'], + 'example' => 'RAM', + 'title' => '', + ], + 'DnsUserName' => ['description' => 'The username of a DNS user.'."\n", 'type' => 'string', 'example' => 'testDnsUserName', 'title' => ''], + 'TrustPassword' => ['description' => 'The AD trust password. This parameter is returned only when the directory type is AD office network.'."\n", 'type' => 'string', 'example' => '82Tg****', 'title' => ''], + 'OuName' => ['description' => 'The organization unit that you selected when you added the cloud computer to the domain.'."\n", 'type' => 'string', 'example' => 'example.com/Domain Controllers', 'title' => ''], + 'Name' => ['description' => 'The directory name.'."\n", 'type' => 'string', 'example' => 'testDirectoryName', 'title' => ''], + 'DirectoryId' => ['description' => 'The directory ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'ADConnectors' => [ + 'description' => 'Details of the AD connector.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the AD connector.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConnectorStatus' => [ + 'description' => 'Valid values:'."\n" + ."\n" + .'* CONNECT_ERROR'."\n" + .'* RUNNING'."\n" + .'* CONNECTING: You must configure domain trust for your AD system.'."\n" + .'* EXPIRED'."\n" + .'* CREATING', + 'type' => 'string', + 'enumValueTitles' => ['CONNECT_ERROR' => '', 'RUNNING' => '', 'CONNECTING' => '', 'EXPIRED' => '', 'CREATING' => ''], + 'example' => 'RUNNING', + 'title' => '', + ], + 'VSwitchId' => ['description' => 'The ID of the vSwitch with which the AD connector is associated.'."\n", 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****', 'title' => ''], + 'ADConnectorAddress' => ['description' => 'The connection address.'."\n", 'type' => 'string', 'example' => '172.17.XX.XX', 'title' => ''], + 'TrustKey' => ['description' => 'The trust password of the AD domain controller.'."\n", 'type' => 'string', 'example' => 'yfpoAD****', 'title' => ''], + 'NetworkInterfaceId' => ['description' => 'The ID of the NIC to which the AD connector is mounted.'."\n", 'type' => 'string', 'example' => 'eni-bp1i4wx78lgosrj6****', 'title' => ''], + 'Specification' => [ + 'description' => 'The AD connector type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: General'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* 2: Advanced'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'enumValueTitles' => [1 => '', ''], + 'example' => '1', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'Normal', + 'title' => '', + 'example' => '', + ], + 'Logs' => [ + 'description' => 'The registration logs. This parameter is returned only when the directory type is AD office network.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details of the registration log.'."\n", + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The step that corresponds to the log entry.'."\n", 'type' => 'string', 'example' => 'DescribeDirectories', 'title' => ''], + 'Message' => ['description' => 'Details of the log entry.'."\n", 'type' => 'string', 'example' => 'code:success | message:Create Connector complete.', 'title' => ''], + 'TimeStamp' => ['description' => 'The time when the log entry was printed.'."\n", 'type' => 'string', 'example' => '2021-01-22T06:45Z', 'title' => ''], + 'Level' => [ + 'description' => 'The level of the log entry.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ERROR'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* INFO'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* WARN'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'enumValueTitles' => ['ERROR' => '', 'INFO' => '', 'WARN' => ''], + 'example' => 'INFO', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'VSwitchIds' => [ + 'description' => 'The IDs of the vSwitches specified when the directory was created.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IDs of the vSwitches specified when the directory was created.'."\n", 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FileSystemIds' => [ + 'description' => 'The IDs of File Storage NAS (NAS) file systems.', + 'type' => 'array', + 'items' => ['description' => 'The IDs of File Storage NAS (NAS) file systems.', 'type' => 'string', 'example' => '05b534****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SubDnsAddress' => [ + 'description' => 'The DNS address of the enterprise AD subdomain.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the enterprise AD subdomain.'."\n", 'type' => 'string', 'example' => '172.24.XX.XX', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DnsAddress' => [ + 'description' => 'The DNS address of the directory.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the directory.'."\n", 'type' => 'string', 'example' => '172.24.XX.XX', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'NeedVerifyLoginRisk' => ['description' => 'Indicates whether two-step verification for logons is enabled. This parameter is returned only for directories of convenience account type.\\'."\n" + .'If two-factor verification is enabled, the system checks whether security risks exist within the logon account when a convenience user logs on to an Alibaba Cloud Workspace client. If risks are detected, the system sends a verification code to the email address that is associated with the account. Then, the convenience user can log on to the client only after the user enters the correct verification code.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AdHostname' => ['description' => 'The hostname of the domain controller.', 'type' => 'string', 'example' => 'dc001', 'title' => ''], + 'BackupDns' => ['description' => 'The DNS address of the backup domain controller.', 'type' => 'string', 'example' => '192.168.2.100', 'title' => ''], + 'BackupDCHostname' => ['description' => 'The hostname of the backup domain controller.', 'type' => 'string', 'example' => 'dc002', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'AdHostname' => ['description' => 'The hostname of the domain controller. The hostname must comply with the hostname naming convention of Windows. This parameter is returned only when the directory type is AD office network.'."\n", 'type' => 'string', 'example' => 'cnshsv21hmc****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NetworkPackages\\": [\\n {\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"Bandwidth\\": 10,\\n \\"ExpiredTime\\": \\"2099-12-31T15:59:59Z\\",\\n \\"CreateTime\\": \\"2021-05-10T02:35:26Z\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"PayType\\": \\"PostPaid\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"ReservationInternetChargeType\\": \\"PayByBandwidth\\",\\n \\"ReservationBandwidth\\": 20,\\n \\"ReservationActiveTime\\": \\"2021-07-10T00:00:00Z\\",\\n \\"NetworkPackageStatus\\": \\"InUse\\",\\n \\"OfficeSiteName\\": \\"default\\",\\n \\"OfficeSiteVpcType\\": \\"basic\\",\\n \\"EipAddresses\\": [\\n \\"120.2.XX.XX\\"\\n ],\\n \\"BusinessStatus\\": \\"Normal\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\ncaeba0bbb2be03f84eb48b699f0a4883\\n\\n cn-hangzhou+dir-363353****\\n np-amtp8e8q1o9e4****\\n 2099-12-31T15:59:59Z\\n 2021-05-10T02:35:26Z\\n 10\\n test\\n InUse\\n PayByTraffic\\n\\n","errorExample":""}]', - 'title' => 'DescribeNetworkPackages', - 'summary' => 'Queries the details of one or more premium bandwidth plans.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A776297C7B\\",\\n \\"Directories\\": [\\n {\\n \\"EnableInternetAccess\\": false,\\n \\"VpcId\\": \\"vpc-uf6tz5k67puge5jn8****\\",\\n \\"CreationTime\\": \\"2020-11-02T01:44Z\\",\\n \\"Status\\": \\"REGISTERING\\",\\n \\"DomainPassword\\": \\"testPassword\\",\\n \\"EnableAdminAccess\\": true,\\n \\"SubDomainName\\": \\"child.example.com\\",\\n \\"DomainUserName\\": \\"sAMAccountName\\",\\n \\"EnableCrossDesktopAccess\\": true,\\n \\"CustomSecurityGroupId\\": \\"sg-bp1ce64o4g9mdf5u****\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"SsoEnabled\\": false,\\n \\"DomainName\\": \\"example.com\\",\\n \\"DesktopAccessType\\": \\"Internet\\",\\n \\"MfaEnabled\\": false,\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"DnsUserName\\": \\"testDnsUserName\\",\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"OuName\\": \\"example.com/Domain Controllers\\",\\n \\"Name\\": \\"testDirectoryName\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ADConnectors\\": [\\n {\\n \\"ConnectorStatus\\": \\"RUNNING\\",\\n \\"VSwitchId\\": \\"vsw-bp19ocz3erfx15uon****\\",\\n \\"ADConnectorAddress\\": \\"172.17.XX.XX\\",\\n \\"TrustKey\\": \\"yfpoAD****\\",\\n \\"NetworkInterfaceId\\": \\"eni-bp1i4wx78lgosrj6****\\",\\n \\"Specification\\": \\"1\\"\\n }\\n ],\\n \\"Logs\\": [\\n {\\n \\"Step\\": \\"DescribeDirectories\\",\\n \\"Message\\": \\"code:success | message:Create Connector complete.\\",\\n \\"TimeStamp\\": \\"2021-01-22T06:45Z\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp19ocz3erfx15uon****\\"\\n ],\\n \\"FileSystemIds\\": [\\n \\"05b534****\\"\\n ],\\n \\"SubDnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"DnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"NeedVerifyLoginRisk\\": false,\\n \\"AdHostname\\": \\"dc001\\",\\n \\"BackupDns\\": \\"192.168.2.100\\",\\n \\"BackupDCHostname\\": \\"dc002\\"\\n }\\n ],\\n \\"AdHostname\\": \\"cnshsv21hmc****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n REGISTERING\\n example.com\\n sg-bp1ce64o4g9mdf5u****\\n testDirectoryName\\n RAM\\n testPassword\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\n vpc-uf6tz5k67puge5jn8****\\n 2020-11-02T01:44Z\\n Internet\\n sAMAccountName\\n false\\n testDnsUserName\\n \\n \\n \\n 172.17.**.**\\n eni-bp1i4wx78lgosrj6****\\n RUNNING\\n vsw-bp19ocz3erfx15uon****\\n \\n \\n INFO\\n DescribeDirectories\\n code:success | message:Create Connector complete.\\n 2021-01-22T06:45Z\\n \\n \\n \\n vsw-bp19ocz3erfx15uon****\\n [\\"171.17.**.**\\"]\\n \\n F369A091-002F-49C8-AD55-02A776297C7B\\n caeba0bbb2be03f84eb48b699f0a4883\\n","errorExample":""}]', + 'title' => 'DescribeDirectories', + 'summary' => 'Queries the details of directories.', + 'changeSet' => [ + ['createdAt' => '2024-06-26T07:31:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ], + ], + 'ramActions' => [], 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', ], - 'DescribeFlowMetric' => [ - 'summary' => 'Queries the monitoring data of the desktop inbound bandwidth and the desktop outbound bandwidth, or the monitoring data of the workspace bandwidth originated from or destined for the Internet.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDrives' => [ + 'summary' => 'Queries user-level storage resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], + ], + [ + 'name' => 'DomainIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'description' => 'The IDs of the storage resources.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the storage resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dom-aaaa****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'Period', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '3600', - 'minimum' => '60', - 'enumValueTitles' => [ - 60 => '', - 900 => '', - 3600 => '', - ], - 'example' => '60', - 'enum' => [ - '60', - '300', - '900', - ], - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1651817220643', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1664714703743', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'intranetInRate' => '', - 'net_tx.rate' => '', - 'intranetOutRate' => '', - 'net_rx.rate' => '', - ], - 'example' => 'intranetOutRate', - ], - ], - [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'desktop' => '', - 'network_package' => '', - ], - 'example' => 'desktop', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\'instanceId\': \'np-4wrye3ishxi47****\', \'requestId\': \'4F0CD5B6-70D6-5115-A2F7-7EAC3981****\', \'dataPoints\': [{\'timeStamp\': 1636510320000, \'Average\': 293752.0}]}', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '6857EDCB-631F-5405-BE95-45CBB4C3****', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\'instanceId\': \'np-4wrye3ishxi47****\', \'requestId\': \'4F0CD5B6-70D6-5115-A2F7-7EAC3981****\', \'dataPoints\': [{\'timeStamp\': 1636510320000, \'Average\': 293752.0}]}\\",\\n \\"RequestId\\": \\"6857EDCB-631F-5405-BE95-45CBB4C3****\\"\\n}","type":"json"}]', - 'title' => 'DescribeFlowMetric', - ], - 'DescribeFlowStatistic' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The statistic collection interval. Unit: seconds.'."\n" + 'description' => 'The type of the storage resource.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* 3600: 1 hour'."\n" - .'* 10800: 3 hours'."\n" - .'* 86400: 24 hours', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - 3600 => '3600', - 10800 => '10800', - 86400 => '86400', - ], - 'example' => '3600', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", + .'* NAS: NAS storage'."\n" + .'* PDS: PDS storage'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-363353****', + 'required' => false, + 'enumValueTitles' => ['NAS' => '', 'PDS' => ''], + 'example' => 'NAS', + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'* Maximum value: 500.'."\n" + .'* Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - ], + 'schema' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAA****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'DesktopCount' => [ - 'description' => 'The number of available cloud computers in the office network.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC2****', - ], - 'DesktopFlowStatistic' => [ - 'description' => 'The traffic statistics.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B7AA****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response code. The value 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Count' => ['description' => 'The total number of storage resources.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'AAAA****', 'title' => ''], + 'Drives' => [ + 'description' => 'The user-level storage resources.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Details of the traffic that is consumed by the cloud desktop.'."\n", + 'description' => 'The user-level storage resource.'."\n", 'type' => 'object', 'properties' => [ - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", + 'Id' => ['description' => 'The user ID.'."\n" + ."\n" + .'> You can ignore this parameter.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the storage resource was created.'."\n", 'type' => 'string', 'example' => '2025-07-02T08:42:26.000+00:00', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the storage resource was modified.'."\n", 'type' => 'string', 'example' => '2025-07-07T02:46:04.000+00:00', 'title' => ''], + 'AliUid' => ['description' => 'The ID of the Alibaba Cloud account.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1202****', 'title' => ''], + 'DomainId' => ['description' => 'The ID of the storage resource.'."\n", 'type' => 'string', 'example' => 'dom-aaaa****', 'title' => ''], + 'ExternalDomainId' => ['description' => 'The ID of the external storage resource.'."\n" + ."\n" + .'* If ResourceType is set to NAS, the NAS ID is returned for this parameter.'."\n" + .'* If ResourceType is set to PDS, the PDS ID is returned for this parameter.'."\n", 'type' => 'string', 'example' => '0976****', 'title' => ''], + 'DriveId' => ['description' => 'The ID of the user-level storage resource.'."\n", 'type' => 'string', 'example' => 'dri-aaaa****', 'title' => ''], + 'ExternalDriveId' => ['description' => 'The ID of the storage resource at the external user level.'."\n" + ."\n" + .'> This parameter is returned only if ResourceType is set to PDS.'."\n", 'type' => 'string', 'example' => '1100****', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => 'user01', 'title' => ''], + 'ExternalUserId' => ['description' => 'The ID of the external user.'."\n" + ."\n" + .'> This parameter is returned only if ResourceType is set to PDS.'."\n", 'type' => 'string', 'example' => 'user01@cn-hangzhou.120****', 'title' => ''], + 'Name' => ['description' => 'The name of the storage resource.'."\n", 'type' => 'string', 'example' => 'test****', 'title' => ''], + 'Description' => ['description' => 'The introduction to the storage resource.'."\n", 'type' => 'string', 'example' => 'test****', 'title' => ''], + 'TotalSize' => ['description' => 'The total amount of user-level storage capacity.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '536870912000', 'title' => ''], + 'UsedSize' => ['description' => 'The amount of user-level storage capacity used.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '243175936', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the user-level storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* INIT: initializing'."\n" + .'* MAINTAIN: maintaining'."\n" + .'* DELETING: deleting'."\n" + .'* INVALID: invalid'."\n" + .'* NORMAL: normal'."\n" + .'* FAIL: failed'."\n", 'type' => 'string', - 'example' => 'desktop-1', + 'enumValueTitles' => ['INIT' => '', 'MAINTAIN' => '', 'DELETING' => '', 'INVALID' => '', 'NORMAL' => '', 'FAIL' => ''], + 'example' => 'NORMAL', + 'title' => '', ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", + 'Type' => [ + 'description' => 'The usage of the storage resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DESKTOP: data disk space'."\n" + .'* USER_PROFILE: personal data space'."\n", 'type' => 'string', - 'example' => 'ecd-8bslxqq0csytn****', - ], - 'FlowRank' => [ - 'description' => 'The traffic ranking.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'enumValueTitles' => ['DESKTOP' => '', 'USER_PROFILE' => ''], + 'example' => 'USER_PROFILE', + 'title' => '', ], - 'FlowIn' => [ - 'description' => 'The traffic amount. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '1000', + 'ProfileRoaming' => ['description' => '> This parameter is deprecated.'."\n", 'type' => 'boolean', 'example' => '-', 'title' => ''], + 'DesktopGroupCount' => ['description' => 'The number of associated cloud computer pools.'."\n" + ."\n" + .'> This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DesktopGroups' => [ + 'description' => 'The details of the associated cloud computers.'."\n" + ."\n" + .'> This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the cloud computer pool.'."\n", + 'type' => 'object', + 'properties' => [ + 'DesktopGroupId' => ['description' => 'The ID of the cloud computer pool.'."\n", 'type' => 'string', 'example' => 'dg-aaaa****', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the cloud computer pool.'."\n", 'type' => 'string', 'example' => 'group01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'EnableProfileManagement' => ['description' => 'Indicates whether the UPM feature is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopCount\\": 2,\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC2****\\",\\n \\"DesktopFlowStatistic\\": [\\n {\\n \\"DesktopName\\": \\"desktop-1\\",\\n \\"DesktopId\\": \\"ecd-8bslxqq0csytn****\\",\\n \\"FlowRank\\": 1,\\n \\"FlowIn\\": \\"1000\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeFlowStatistic', - 'summary' => 'Queries cloud computer-level traffic statistics of a single office network.', - 'description' => '> You can query only the traffic data in the last 90 days.'."\n", - ], - 'DescribeAclEntries' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Count\\": 2,\\n \\"NextToken\\": \\"AAAA****\\",\\n \\"Drives\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": 0,\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"ExternalDomainId\\": \\"0976****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true,\\n \\"DesktopGroupCount\\": 1,\\n \\"DesktopGroups\\": [\\n {\\n \\"DesktopGroupId\\": \\"dg-aaaa****\\",\\n \\"DesktopGroupName\\": \\"group01\\"\\n }\\n ],\\n \\"EnableProfileManagement\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDrives', + 'changeSet' => [ + ['createdAt' => '2022-08-31T07:11:35.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDrives'], + ], ], + 'ramActions' => [], + ], + 'DescribeEcdReportTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'list', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'BusinessChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['Enterprise', 'Business'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 1600.'."\n" - .'* Default value: 1600.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '50', - ], + 'schema' => ['description' => 'The ID of the report export task.', 'type' => 'string', 'required' => false, 'example' => 'ret-sfkdsjfi*****', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'TaskType', 'in' => 'query', 'schema' => [ - 'description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.'."\n", + 'description' => 'The type of the report.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'- RESOURCE\\_REPORT', + 'enumValueTitles' => ['RESOURCE_REPORT' => ''], 'type' => 'string', 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kRxd1mKkNnHlUy14zdjl/I', + 'example' => 'RESOURCE_REPORT', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'SubType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", + 'description' => 'The sub-type of the report export task.', + 'enumValueTitles' => ['DESKTOP' => 'Cloud computer'], 'type' => 'string', 'required' => false, - 'example' => 'cn-shanghai+dir-631324****', + 'example' => 'DESKTOP', + 'title' => '', ], ], [ - 'name' => 'SourceType', + 'name' => 'Status', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The granularity of the ACL.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* desktop: cloud computer'."\n" - .'* vpc: office network', - 'type' => 'string', + 'description' => 'The task status.', + 'type' => 'array', + 'items' => ['description' => 'The task status.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'desktop' => '', - 'vpc' => '', - ], - 'example' => 'desktop', + 'enumValueTitles' => ['INIT' => 'Initializing', 'FAILED' => 'Failed', 'RUNNING' => 'Running', 'EXPIRED' => 'Expired', 'FINISHED' => 'Finished'], + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SourceId', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance to which the ACL applies. You can specify an office network ID or a cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-****', - ], + 'schema' => ['description' => 'The number of the page to return. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries returned per page. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query. If the value of this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'AclEntries' => [ - 'description' => 'The ACL entries.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'ExportTaskList' => [ + 'description' => 'The report export tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The ACL entry.'."\n", 'type' => 'object', 'properties' => [ - 'Policy' => [ - 'description' => 'The ACL type.'."\n" + 'TaskId' => ['description' => 'The ID of the report export task.', 'type' => 'string', 'example' => 'ret-asdfkjg*****', 'title' => ''], + 'TaskType' => [ + 'description' => 'The type of the report.'."\n" ."\n" - .'Valid values:'."\n" + .'Valid value:'."\n" ."\n" - .'* allow: whitelist'."\n" - .'* disable: blacklist', + .'- RESOURCE\\_REPORT', + 'enumValueTitles' => ['RESOURCE_REPORT' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'allow' => '', - 'deny' => '', - ], - 'example' => 'allow', + 'example' => 'RESOURCE_REPORT', + 'title' => '', ], - 'SourceType' => [ - 'description' => 'The granularity of the ACL.'."\n" + 'SubType' => [ + 'description' => 'The sub-type of the report export task.'."\n" ."\n" - .'Valid values:'."\n" + .'Valid value:'."\n" ."\n" - .'* desktop: cloud computer'."\n" - .'* vpc: office network', + .'- DESKTOP: cloud computer', + 'enumValueTitles' => ['DESKTOP' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'desktop' => '', - 'vpc' => '', - ], - 'example' => 'desktop', - ], - 'SourceId' => [ - 'description' => 'The ID of the instance to which the ACL applies. You can specify an office network ID or a cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-fsafeweh***', + 'example' => 'DESKTOP', + 'title' => '', ], + 'ReportFileName' => ['description' => 'The name of the report file.', 'type' => 'string', 'example' => 'TestFileName', 'title' => ''], + 'Status' => ['description' => 'The task status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'Progress' => ['description' => 'The progress of the report export task. Unit: %.', 'type' => 'number', 'format' => 'float', 'example' => '80', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2025-07-14T07:46:49.000+00:00', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the task was last modified.', 'type' => 'string', 'example' => '2025-07-14T07:46:49.000+00:00', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL of the report file.', 'type' => 'string', 'example' => 'https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'No Data.', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AclEntries\\": [\\n {\\n \\"Policy\\": \\"allow\\",\\n \\"SourceType\\": \\"desktop\\",\\n \\"SourceId\\": \\"ecd-22poqua477xo4****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeAclEntries', - 'summary' => 'Queries the details of an access control list (ACL) of an office network or a cloud computer.', - ], - 'ModifyAclEntries' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeEcdReportTasks', + 'summary' => 'Queries data report export tasks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEcdReportTasks'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeEcdReportTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"ExportTaskList\\": [\\n {\\n \\"TaskId\\": \\"ret-asdfkjg*****\\",\\n \\"TaskType\\": \\"RESOURCE_REPORT\\",\\n \\"SubType\\": \\"DESKTOP\\",\\n \\"ReportFileName\\": \\"TestFileName\\",\\n \\"Status\\": \\"Running\\",\\n \\"Progress\\": 80,\\n \\"GmtCreate\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"DownloadUrl\\": \\"https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMsg\\": \\"No Data.\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeFlowMetric' => [ + 'summary' => 'Query the inbound bandwidth and outbound bandwidth of a cloud computer, or the inbound bandwidth and outbound bandwidth for public network access of premium public bandwidth, along with their monitoring data.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The Region ID. You can call [DescribeRegions](~~196646~~) to obtain the list of Regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID, which can be either a cloud computr ID or a premium public bandwidth plan ID.', 'type' => 'string', 'example' => 'Ecd-fwq23f13****ornp-6inxqsvcyv6z8****', 'required' => true, 'docRequired' => true, 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', + 'description' => 'The statistic period of monitoring data. Unit: seconds.', + 'enumValueTitles' => [60 => '60 seconds', 900 => '900 seconds', 3600 => '3,600 seconds'], + 'type' => 'integer', + 'format' => 'int32', 'required' => true, 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'maximum' => '3600', + 'minimum' => '60', + 'enum' => ['60', '300', '900', '3600'], + 'example' => '60', + 'title' => '', ], ], [ - 'name' => 'SourceType', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The granularity to which the Internet access control policy is applicable.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* desktop: cloud computer granularity.'."\n" - ."\n" - .'* vpc: office network granularity.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'desktop' => '', - 'vpc' => '', - ], - 'example' => 'desktop', - ], + 'schema' => ['description' => 'Start Time. Supported formats:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds elapsed since January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1651817220643', 'title' => ''], ], [ - 'name' => 'SourceId', + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'End Time. Supported formats:'."\n" + ."\n" + .'- UNIX timestamp: the number of milliseconds elapsed since January 1, 1970.'."\n" + ."\n" + .'- Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1664714703743', 'title' => ''], + ], + [ + 'name' => 'MetricType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instance IDs (office network IDs or cloud computer IDs) to which the Internet access control policy is applicable.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID (office network ID or cloud computer ID) to which the Internet access control policy is applicable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-afhjuiwhfia***', - ], + 'description' => 'The type of monitoring metric. Supports monitoring data for inbound and outbound bandwidth of cloud computers, as well as inbound and outbound bandwidth for public network access of premium public bandwidth.', + 'enumValueTitles' => ['intranetInRate' => 'The inbound bandwidth for a cloud computer.', 'net_tx.rate' => 'The outbound bandwidth for an Internet premium bandwidth plan.', 'intranetOutRate' => 'The outbound bandwidth for a cloud computer.', 'net_rx.rate' => 'The inbound bandwidth for an Internet premium bandwidth plan.'], + 'type' => 'string', 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, + 'docRequired' => true, + 'example' => 'intranetOutRate', + 'title' => '', ], ], [ - 'name' => 'Policy', + 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ - 'description' => 'The Internet access control policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow: allows access to the Internet.'."\n" - ."\n" - .'* disable: forbids access to the Internet.', + 'description' => 'The instance type. You can select either cloud computer type or premium public bandwidth type. If you select cloud computer type, the `InstanceId` and `MetricType` must be filled in with a cloud computer ID and its corresponding traffic type. The same applies to premium public bandwidth.', + 'enumValueTitles' => ['desktop' => 'Cloud computer', 'network_package' => 'Internet premium bandwidth plan'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'enumValueTitles' => [ - 'allow' => '', - 'deny' => '', - ], - 'example' => 'allow', + 'example' => 'desktop', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", + 'description' => 'A collection of response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '062B1439-709A-580E-85DF-CE97A1560565', - ], + 'Data' => ['description' => 'Metric data.', 'type' => 'string', 'example' => '{\'instanceId\': \'np-4wrye3ishxi47****\', \'requestId\': \'4F0CD5B6-70D6-5115-A2F7-7EAC3981****\', \'dataPoints\': [{\'timeStamp\': 1636510320000, \'Average\': 293752.0}]}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6857EDCB-631F-5405-BE95-45CBB4C3****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A1560565\\"\\n}","type":"json"}]', - 'title' => 'ModifyAclEntries', - 'summary' => 'Modify the Internet access control policy on the office network or cloud computer granularity.', - 'description' => 'You can set different Internet access control policies at different granularities to achieve the effect of composite policies. For example, you can disable the Internet access on the office network granularity and enable the Internet access on specific cloud computer granularity. The effect is that all cloud computers in the office network except the specified cloud computers are not allowed to access the Internet.'."\n", - ], - 'AssociateNetworkPackage' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\'instanceId\': \'np-4wrye3ishxi47****\', \'requestId\': \'4F0CD5B6-70D6-5115-A2F7-7EAC3981****\', \'dataPoints\': [{\'timeStamp\': 1636510320000, \'Average\': 293752.0}]}\\",\\n \\"RequestId\\": \\"6857EDCB-631F-5405-BE95-45CBB4C3****\\"\\n}","type":"json"}]', + 'title' => 'Query Inbound Bandwidth and Outbound Bandwidth ', + 'changeSet' => [ + ['createdAt' => '2025-06-30T12:35:04.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFlowMetric'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeFlowMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeFotaPendingDesktops' => [ + 'summary' => 'Queries information about the cloud computers whose images can be and are pending to be updated to the specified version.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'np-e0iodl3yzb62q****', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'* Valid values: 1 to 100.'."\n" + .'* Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'TaskUid', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aot-c4khwrp9ocml4****', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], [ 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the office network. You can call the [DescribeNetworkPackages](~~216079~~) to obtain the ID of the office network to which a premium bandwidth plan is bound.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-*********', - ], + 'schema' => ['description' => 'The ID of the office network. You can call the [DescribeOfficeSites](~~216071~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-428216****', 'title' => ''], + ], + [ + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'demo-computer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'FotaPendingDesktops' => [ + 'description' => 'The cloud computers whose images can be and are pending to be updated to the version specified in `TaskUid`.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DesktopId' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'example' => 'ecd-bvdtu3jn97o1r****', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud computer.'."\n", 'type' => 'string', 'example' => 'demo-computer', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the office network.'."\n", 'type' => 'string', 'example' => 'cn-shanghai+dir-428216****', 'title' => ''], + 'FotaProject' => ['description' => '> This parameter is not publicly available.'."\n", 'type' => 'string', 'example' => 'windows', 'title' => ''], + 'CurrentAppVersion' => ['description' => 'The current version of the image used by the cloud computer.'."\n", 'type' => 'string', 'example' => '0.0.1-D-20220513.143129', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the cloud computer.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 0: The cloud computer is being created.'."\n" + .'* 1: The cloud computer is being started.'."\n" + .'* 2: The cloud computer is running.'."\n" + .'* 3: The cloud computer is being stopped.'."\n" + .'* 5: The cloud computer is stopped.'."\n" + .'* 6: The cloud computer expires.'."\n" + .'* 7: The cloud computer is deleted.'."\n" + .'* 9: Failed to create the cloud computer.', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => ['', '', '', '', 5 => '', '', '', 9 => ''], + 'example' => '2', + 'title' => '', + ], + 'Sessions' => [ + 'description' => 'The connected sessions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the end user that connects to the cloud computer.'."\n", 'type' => 'string', 'example' => 'alice', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'Succeeded', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'AssociateNetworkPackage', - 'summary' => 'Binds a premium bandwidth plan to an office network. A premium bandwidth plan is used together with only one office network.', - ], - 'DissociateNetworkPackage' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FotaPendingDesktops\\": [\\n {\\n \\"DesktopId\\": \\"ecd-bvdtu3jn97o1r****\\",\\n \\"DesktopName\\": \\"demo-computer\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-428216****\\",\\n \\"FotaProject\\": \\"windows\\",\\n \\"CurrentAppVersion\\": \\"0.0.1-D-20220513.143129\\",\\n \\"Status\\": 2,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Succeeded\\"\\n}","type":"json"}]', + 'title' => 'DescribeFotaPendingDesktops', + 'changeSet' => [ + ['createdAt' => '2024-03-25T11:43:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-14T09:44:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaPendingDesktops'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeFotaPendingDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeFotaTasks' => [ + 'summary' => 'Queries a list of update tasks.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the premium bandwidth plan. You can call the [DescribeNetworkPackages](~~216079~~) operation to obtain the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'np-*********', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'* Valid values: 1 to 100'."\n" + .'* Default value: 20'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'TaskUid', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the image update tasks.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aot-c4khwrp9ocml4****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'UserStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to automatically push the image update task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Running: automatically pushes the image update task.'."\n" + .'* Pending: does not automatically push the image update task.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['Running' => '', 'Pending' => ''], + 'example' => 'Pending', + 'title' => '', + ], + ], + [ + 'name' => 'FotaStatus', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'windows', 'title' => ''], + ], + [ + 'name' => 'Lang', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language of the image version to update.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* en: English.'."\n" + .'* zh: Simplified Chinese.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], + 'example' => 'zh', + 'title' => '', + ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'FotaTasks' => [ + 'description' => 'Details about the image update task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details about the image update task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskUid' => ['description' => 'The ID of the image upgrade task.'."\n", 'type' => 'string', 'example' => 'aot-c4khwrp9ocml4****', 'title' => ''], + 'FotaProject' => ['description' => '> This parameter is not publicly available.'."\n", 'type' => 'string', 'example' => 'To be hidden.', 'title' => ''], + 'AppVersion' => ['description' => 'The image version. You can call the [DescribeImages](~~188895~~) operation to obtain the value of this parameter.'."\n", 'type' => 'string', 'example' => '0.0.1-D-20220513.143129', 'title' => ''], + 'Status' => [ + 'description' => 'Indicates whether the image update task is automatically pushed.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Running: automatically pushes the image update task.'."\n" + .'* Pending: does not automatically push the image update task.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['Running' => '', 'Pending' => ''], + 'example' => 'valid', + 'title' => '', + ], + 'PublishTime' => ['description' => 'The time when the image version available for update was published.'."\n", 'type' => 'string', 'example' => '2022-05-31T04:28:48Z', 'title' => ''], + 'PendingDesktopCount' => ['description' => 'The number of cloud computers whose images can be updated to this version.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ReleaseNote' => ['description' => 'The description of the image version available for update.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Size' => ['description' => 'The size of the update package. Unit: KB.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '568533470', 'title' => ''], + 'PendingCustomImageCount' => ['description' => 'The number of custom images that can be updated to this version.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The returned message. If the request was successful, a `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The returned error message. This parameter is not returned if the Code value is a `success` message.'."\n", 'type' => 'string', 'example' => 'The parameter is not specified.', 'title' => ''], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DissociateNetworkPackage', - 'summary' => 'Unbinds a premium bandwidth plan from an office network.', - ], - 'RenewNetworkPackages' => [ - 'summary' => 'Renews premium bandwidth plans.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FotaTasks\\": [\\n {\\n \\"TaskUid\\": \\"aot-c4khwrp9ocml4****\\",\\n \\"FotaProject\\": \\"To be hidden.\\",\\n \\"AppVersion\\": \\"0.0.1-D-20220513.143129\\",\\n \\"Status\\": \\"valid\\",\\n \\"PublishTime\\": \\"2022-05-31T04:28:48Z\\",\\n \\"PendingDesktopCount\\": 1,\\n \\"ReleaseNote\\": \\"test\\",\\n \\"Size\\": 568533470,\\n \\"PendingCustomImageCount\\": 1\\n }\\n ],\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The parameter is not specified.\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\"\\n}","type":"json"}]', + 'title' => 'DescribeFotaTasks', + 'changeSet' => [ + ['createdAt' => '2023-12-06T02:37:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-23T06:17:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-28T04:46:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaTasks'], + ], ], + 'ramActions' => [], + ], + 'DescribeGlobalDesktopRecords' => [ + 'summary' => 'Queries basic information and usage duration for all recent Cloud Desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'BusinessChannel', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['Enterprise', 'Business', 'Lincore_team'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Period', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration if you specify subscription as the new billing method for the cloud desktop. The unit of the value is specified by the `PeriodUnit` parameter. This parameter takes effect only when the `ChargeType` parameter is set to `PrePaid`.'."\n" - ."\n" - .'* If the `PeriodUnit` parameter is set to `Week`, the valid value of the Period parameter is 1.'."\n" - .'* If the `PeriodUnit` parameter is set to `Month`, the valid values of the Period parameter are 1, 2, 3, and 6.'."\n" - .'* If the `PeriodUnit` parameter is set to `Year`, the valid values of the Period parameter are 1, 2, 3, 4, and 5.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the region.'."\n" + ."\n" + .'- Shanghai'."\n" + ."\n" + .'- Singapore', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'PeriodUnit', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the renewal duration specified by the Period parameter. Valid values:'."\n" - ."\n" - .'* Month'."\n" - .'* Year'."\n" - ."\n" - .'Default value: Month.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - 'Week' => '', - ], - 'example' => 'Month', - ], + 'schema' => ['description' => 'The ID of the office site.'."\n" + ."\n" + .'- China (Shanghai)'."\n" + ."\n" + .'- Singapore', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the automatic payment feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default): enables the auto-payment feature.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' Make sure that your account has sufficient balance. Otherwise, no order is generated.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated but you need to make the payment manually.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' To make the payment, log on to the Elastic Desktop Service console, go to the Orders page, and find the order based on the order ID.'."\n" - ."\n" - .' ', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The start time of the query. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.', 'type' => 'string', 'required' => false, 'example' => '2022-03-23T04:10:21Z', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of premium bandwidth plans. You can specify up to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'np-jc31jdxfdydr1****', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The end time of the query. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format. The interval between the start and end times cannot exceed 30 days.'."\n" + ."\n" + .'- Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'string', 'required' => false, 'example' => '2022-08-31T06:56:45Z', 'title' => ''], ], [ - 'name' => 'PromotionId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The promotion ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '500038360030606', - ], + 'schema' => ['description' => 'The page number to return.
Default value: 1.
'."\n" + ."\n" + .'- Format: YYYY-MM-DDThh:mm:ssZ.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'DesktopId', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'type' => 'boolean', + 'description' => 'The IDs of the cloud desktops. You can specify up to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '214726268900640', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], + [ + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer', 'title' => ''], ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Order.Unpaid', - 'errorMessage' => 'You have unpaid orders, please pay such orders before placing a new order.', - ], - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], + [ + 'name' => 'SubPayType', + 'in' => 'query', + 'schema' => ['description' => 'The billing method of the cloud desktop. Valid values:', 'type' => 'string', 'required' => false, 'example' => 'monthPackage', 'title' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', - ], + [ + 'name' => 'Scope', + 'in' => 'query', + 'schema' => ['description' => 'The query scope. This parameter is empty by default. Valid value:'."\n" + ."\n" + .'- `ADVANCED`: Queries statistical records, such as connection duration.'."\n" + ."\n" + .'- postPaid: Pay-as-you-go.'."\n" + ."\n" + .'- monthPackage: monthly time-based package.', 'type' => 'string', 'required' => false, 'example' => 'ADVANCED', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214726268900640\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'RenewNetworkPackages', - ], - 'ModifyNetworkPackageBandwidth' => [ - 'summary' => 'Modifies the bandwidth of a premium bandwidth plan.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The field by which to sort the results. If you do not specify this parameter, the results are sorted by creation time in descending order. Valid value:'."\n" + ."\n" + .'- `uptime`: Sorts the results by cloud desktop uptime.', 'type' => 'string', 'required' => false, 'example' => 'uptime', 'title' => ''], ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'SortType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The sort order. The default is `Asc`. Valid values:'."\n" + ."\n" + .'- `Asc`: ascending order', 'type' => 'string', 'required' => false, 'example' => 'Asc', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'np-cxj99qb8d34vo****', - ], + 'schema' => ['description' => 'The ID of the end user.'."\n" + ."\n" + .'- Asc: ascending order'."\n" + ."\n" + .'- Desc: descending order', 'type' => 'string', 'required' => false, 'example' => 'TestUser', 'title' => ''], ], [ - 'name' => 'Bandwidth', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum bandwidth of the premium bandwidth plan, in Mbit/s. Valid range: The allowed range depends on the billing method:'."\n" - ."\n" - .'* Subscription: 2 to 1000'."\n" - .'* Pay-as-you-go, by data transfer (PayByTraffic): 2 to 200'."\n" - .'* Pay-as-you-go, by fixed bandwidth (PayByBandwidth): 2 to 1000'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '20000', - 'minimum' => '2', - 'example' => '10', - ], + 'schema' => ['description' => 'The desktop type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of the supported desktop types.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.2c4g', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the automatic payment feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true (default): enables the auto-payment feature.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' Make sure that your account has sufficient balance. Otherwise, no order is generated.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: disables the auto-payment feature. In this case, an order is generated but you need to make the payment manually.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' To make the payment, log on to the Elastic Desktop Service console, go to the Orders page, and find the order based on the order ID.'."\n" - ."\n" - .' ', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-3mtuc28rx95lx****', 'title' => ''], ], [ - 'name' => 'PromotionId', + 'name' => 'DesktopStatusList', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'The promotion ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '500033080110596', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 20, + 'description' => 'The ID of the resource group.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'ExcludeDesktopStatusList', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'string', - 'example' => '214552063030752', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Sessions' => [ + 'description' => 'A list of sessions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session details.', + 'type' => 'object', + 'properties' => [ + 'Platform' => ['description' => 'The operating system version.', 'type' => 'string', 'example' => 'Windows 10', 'title' => ''], + 'StatusChangeTime' => ['description' => 'The time when the cloud desktop status changed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1760583xxxx', 'title' => ''], + 'Memory' => ['description' => 'The memory size of the cloud desktop, in MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], + 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'SubPayType' => ['description' => 'The billing method for the cloud desktop. Valid values:'."\n" + ."\n" + .'- `prePaid`: Subscription.'."\n" + ."\n" + .'- `postPaid`: Pay-as-you-go.'."\n" + ."\n" + .'- `monthPackage`: Monthly usage package.', 'type' => 'string', 'example' => 'monthPackage', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'TestUser', 'title' => ''], + 'OsType' => ['description' => 'The operating system type. Valid values:'."\n" + ."\n" + .'- `Windows`'."\n" + ."\n" + .'- `Linux`', 'type' => 'string', 'example' => 'Linux', 'title' => ''], + 'SessionIdleTime' => ['description' => 'The idle duration of the session, in minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The name of the office site.', 'type' => 'string', 'example' => 'TestOfficeSite', 'title' => ''], + 'ConnectionStatus' => ['description' => 'The connection status.', 'type' => 'string', 'example' => 'Connected', 'title' => ''], + 'Sessions' => [ + 'description' => 'A list of sessions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The session details for the end user.', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'TestUser', 'title' => ''], + 'EstablishmentTime' => ['description' => 'The time the session was created.', 'type' => 'string', 'example' => '2022-08-31T06:56:45Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****', 'title' => ''], + 'EndUserIds' => [ + 'description' => 'A list of assigned end user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'TestUser', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ResourceGroups' => [ + 'description' => 'A list of resource groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The resource group details.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'dms_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OfficeSiteId' => ['description' => 'The ID of the office site.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****', 'title' => ''], + 'UpTime' => ['description' => 'The cloud desktop uptime, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '86400', 'title' => ''], + 'ProtocolType' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'- `HDX`'."\n" + ."\n" + .'- `ASP`', 'type' => 'string', 'example' => 'ASP', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU memory size.', 'type' => 'string', 'example' => '8GiB', 'title' => ''], + 'LatestConnectionTime' => ['description' => 'The duration of the last connection, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], + 'TotalConnectionTime' => ['description' => 'The total connection duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '240', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'example' => 'dg-iaqu3bi2xtie****', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the desktop group.', 'type' => 'string', 'example' => 'DemoCCGroup', 'title' => ''], + 'DesktopStatus' => ['title' => '', 'description' => 'The desktop status.', 'type' => 'string', 'example' => 'Running'], + 'OfficeSiteType' => ['title' => '', 'description' => 'The office site type.', 'type' => 'string', 'example' => 'Simple'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyNetworkPackageBandwidth', - ], - 'ModifyNetworkPackageEnabled' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'Query global desktops and related usage records', + 'description' => '- Select China (Shanghai) for the Alibaba Cloud China site and Singapore for the Alibaba Cloud International site.'."\n" + ."\n" + .'- By default, this operation returns both active and deleted Cloud Desktops.'."\n" + ."\n" + .'- You can query only Cloud Desktops deleted within the last three months.'."\n" + ."\n" + .'- You cannot use the sort condition with other query conditions.', + 'changeSet' => [ + ['createdAt' => '2025-12-01T06:53:05.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktopRecords'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeGlobalDesktopRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Sessions\\": [\\n {\\n \\"Platform\\": \\"Windows 10\\",\\n \\"StatusChangeTime\\": 0,\\n \\"Memory\\": 4096,\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"Cpu\\": 2,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"EstablishmentTime\\": \\"2022-08-31T06:56:45Z\\"\\n }\\n ],\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"EndUserIds\\": [\\n \\"TestUser\\"\\n ],\\n \\"ResourceGroups\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"dms_test\\"\\n }\\n ],\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"UpTime\\": 86400,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"GpuSpec\\": \\"8GiB\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"OfficeSiteType\\": \\"Simple\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeGlobalTimerBatches' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n" + ."\n" + .'- China (Shanghai)'."\n" + ."\n" + .'- Singapore (Singapore)', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'TimerType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'np-cfedn7r2pe48g****', - ], + 'schema' => ['description' => 'The type of the scheduled task. This operation returns batch information for timer-based scheduled tasks only.'."\n" + ."\n" + .'- `TimerBoot`: scheduled startup'."\n" + ."\n" + .'- `TimerShutdown`: scheduled shutdown'."\n" + ."\n" + .'- `TimerReboot`: scheduled reboot'."\n" + ."\n" + .'- `TimerReset`: scheduled reset'."\n" + ."\n" + .'- `TimerMaintenance`: scheduled maintenance'."\n" + ."\n" + .'- `TimerHibernate`: scheduled hibernation', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Enabled', + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'string', 'example' => '20', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token used to retrieve the next page of results. Set this parameter to the `NextToken` value from a previous response.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SearchRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region where the cloud computers are located. This parameter filters the results to include only cloud computers in the specified region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the scheduled task group.', 'type' => 'string', 'example' => 'ccg-i1ruuudp92qpj****', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ResourceTypes', 'in' => 'query', + 'style' => 'flat', 'schema' => [ - 'description' => 'Specifies whether to restore the premium bandwidth plan of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - 'default' => 'true', + 'type' => 'array', + 'items' => ['type' => 'string', 'example' => 'Desktop', 'description' => '', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******', 'title' => ''], + 'Count' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NextToken' => ['description' => 'The token to use to retrieve the next page of results. This parameter is returned only when more results are available.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Results' => [ + 'description' => 'A list of batches.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a batch.', + 'type' => 'object', + 'properties' => [ + 'BatchId' => ['description' => 'The ID of the batch.', 'type' => 'string', 'example' => 'ccg-0cvfvf6u1enx1****', 'title' => ''], + 'TimerType' => ['description' => 'The type of the scheduled task.', 'type' => 'string', 'example' => 'TimerBoot', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the batch was created.', 'type' => 'string', 'example' => '2023-08-03T08:27:29Z', 'title' => ''], + 'SucceedCount' => ['description' => 'The number of successfully executed tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FailedCount' => ['description' => 'The number of failed tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'SkippedCount' => ['description' => 'The number of skipped tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RunningCount' => ['description' => 'The number of running tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyNetworkPackageEnabled', - 'summary' => 'Restores or disables a premium bandwidth plan.', - 'description' => 'If you want to temporarily disable the Internet access of your cloud computer after the Internet access is enabled for your cloud computer, you can disable the premium bandwidth plan and restore it as needed.'."\n", - ], - 'DeleteNetworkPackages' => [ - 'summary' => 'Deletes one or more premium bandwidth plans.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query the list of scheduled task execution batches', + 'summary' => 'Queries for batch information from the execution history of scheduled tasks and returns aggregated results.', + 'description' => '- This API uses a centralized endpoint. You can call this API only from the China (Shanghai) or Singapore (Singapore) regions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerBatches'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"SucceedCount\\": 0,\\n \\"FailedCount\\": 0,\\n \\"SkippedCount\\": 0,\\n \\"RunningCount\\": 0\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeGlobalTimerRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to list the regions available in Elastic Desktop Service.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'NetworkPackageId', + 'name' => 'TimerTypes', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of premium bandwidth plans. You can specify one or more IDs.'."\n", + 'description' => 'The types of scheduled tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the premium bandwidth plan.'."\n", + 'description' => 'The type of the scheduled task. Valid values:'."\n" + ."\n" + .'**Scheduled tasks:**'."\n" + ."\n" + .'- `TimerBoot`: scheduled boot'."\n" + ."\n" + .'- `TimerShutdown`: scheduled shutdown'."\n" + ."\n" + .'- `TimerReboot`: scheduled reboot'."\n" + ."\n" + .'- `TimerReset`: scheduled reset'."\n" + ."\n" + .'- `TimerMaintenance`: scheduled maintenance'."\n" + ."\n" + .'- `TimerHibernate`: scheduled hibernation'."\n" + ."\n" + .'**Idle-based tasks:**'."\n" + ."\n" + .'- `NoOperationShutdown`: shut down on idle'."\n" + ."\n" + .'- `NoOperationReboot`: reboot on idle'."\n" + ."\n" + .'- `NoOperationDisconnect`: disconnect on idle'."\n" + ."\n" + .'- `NoOperationHibernate`: hibernate on idle'."\n" + ."\n" + .'**Disconnection-based tasks:**'."\n" + ."\n" + .'- `NoConnectShutdown`: shut down upon disconnection'."\n" + ."\n" + .'- `NoConnectHibernate`: hibernate upon disconnection', + 'enumValueTitles' => ['NoOperationDisconnect' => 'disconnect on idle', 'NoConnectShutdown' => 'shut down upon disconnection', 'TimerBoot' => 'scheduled boot', 'NoOperationShutdown' => 'shut down on idle', 'NoOperationHibernate' => 'hibernate on idle', 'NoConnectHibernate' => 'hibernate upon disconnection', 'TimerShutdown' => 'scheduled shutdown', 'NoOperationReboot' => 'reboot on idle', 'TimerReboot' => 'scheduled reboot'], 'type' => 'string', + 'example' => 'TimerBoot', 'required' => false, - 'example' => 'np-amtp8e8q1o9e4****', + 'title' => '', ], - 'required' => true, + 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'string', 'example' => '10', 'required' => false, 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token used to start the next query.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'SearchRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region to filter by. Only records for cloud desktops in this region are returned.', 'type' => 'string', 'example' => 'cn-shanghai', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => ['description' => 'The batch ID for a scheduled task execution.', 'type' => 'string', 'example' => 'ccg-****', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'TimerResult', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution result of the scheduled task. Valid values:', + 'enumValueTitles' => ['CONNECTED_NOT_RUN' => 'The scheduled task was not executed because the cloud desktop was connected.', 'PAUSED' => 'The execution is paused.', 'COMPLETED' => 'The task is completed.', 'FAILED' => 'The execution failed.', 'RUNNING' => 'The task is running.', 'TERMINATED' => 'The execution was terminated.'], + 'type' => 'string', + 'example' => 'RUNNING', + 'required' => false, + 'title' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled task group ID.', 'type' => 'string', 'example' => 'ccg-0cvfvf6u1enx1****', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'ResultCategory', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filters the results by execution status. Valid values:', + 'enumValueTitles' => ['SUCCEED' => 'The execution was successful.', 'FAILED' => 'The execution failed.', 'RUNNING' => 'The execution is in progress.', 'SKIPPED' => 'The execution was skipped.'], + 'type' => 'string', + 'example' => 'SUCCEED', + 'required' => false, + 'title' => '', + ], + ], + [ + 'name' => 'DesktopIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'A list of cloud desktop IDs.', + 'type' => 'array', + 'items' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'example' => 'ecd-84mztzatmipf2****', 'required' => false, 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Retryable', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'DisplayResultName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'FAILED', 'description' => '', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The data returned.', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****'], + 'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****', 'title' => ''], + 'Count' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Results' => [ + 'description' => 'The returned results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of results.', + 'type' => 'object', + 'properties' => [ + 'BatchId' => ['description' => 'The batch ID of the scheduled task execution.', 'type' => 'string', 'example' => 'ccg-0cvfvf6u1enx1****', 'title' => ''], + 'TimerType' => ['description' => 'The type of the scheduled task.', 'type' => 'string', 'example' => 'TimerBoot', 'title' => ''], + 'TimerResult' => ['description' => 'The execution result of the scheduled task.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the record was created.', 'type' => 'string', 'example' => '2023-08-03T08:27:29Z', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => '2025-01-21T02:00:45Z', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'example' => 'ecd-0c951fy9arnk9****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'DesktopName' => ['description' => 'The cloud desktop name.', 'type' => 'string', 'example' => 'DesktopName', 'title' => ''], + 'TimerGroupId' => ['description' => 'The scheduled task group ID.', 'type' => 'string', 'example' => 'ccg-xxxx', 'title' => ''], + 'ActionType' => ['description' => 'The type of action performed.', 'type' => 'string', 'example' => 'REBOOT', 'title' => ''], + 'Context' => ['description' => 'The recorded information during the execution of the scheduled task.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'DisplayResultName' => ['type' => 'string', 'example' => 'SKIPPED', 'description' => '', 'title' => ''], + 'Retryable' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], + 'TimerRecordId' => ['type' => 'string', 'example' => 't-xxx', 'description' => '', 'title' => ''], + 'ResourceParentId' => ['type' => 'string', 'example' => 'p-xxx', 'description' => '', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteNetworkPackages', - ], - 'DescribeCens' => [ - 'summary' => 'Queries the details of all Cloud Enterprise Network (CEN) instances within an Alibaba Cloud account.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query global scheduled task execution records ', + 'summary' => 'This operation queries the scheduled task execution records for EDS across all regions.', + 'changeSet' => [ + ['createdAt' => '2025-12-24T11:15:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerRecords'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"Count\\": 2,\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"TimerResult\\": \\"RUNNING\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"FinishTime\\": \\"2025-01-21T02:00:45Z\\",\\n \\"DesktopId\\": \\"ecd-0c951fy9arnk9****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DesktopName\\": \\"DesktopName\\",\\n \\"TimerGroupId\\": \\"ccg-xxxx\\",\\n \\"ActionType\\": \\"REBOOT\\",\\n \\"Context\\": \\"{}\\",\\n \\"DisplayResultName\\": \\"SKIPPED\\",\\n \\"Retryable\\": true,\\n \\"TimerRecordId\\": \\"t-xxx\\",\\n \\"ResourceParentId\\": \\"p-xxx\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeGuestApplications' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.\\'."\n" - .'Default value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-asw3giklqvfqe****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice', 'title' => ''], ], ], 'responses' => [ @@ -22260,1790 +19161,2218 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of CEN instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Cens' => [ - 'description' => 'Details of the CEN instances.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '272CF39E-B5DE-5BE3-A09B-B43F1026****', 'title' => ''], + 'Applications' => [ + 'description' => 'The applications.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The application.'."\n", 'type' => 'object', 'properties' => [ + 'ApplicationName' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'Google Chrome', 'title' => ''], + 'ApplicationVersion' => ['description' => 'The application version.'."\n", 'type' => 'string', 'example' => '115.0.5790.110', 'title' => ''], + 'ProcessPath' => ['description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe', 'title' => ''], + 'Pid' => ['description' => 'The process ID (PID).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1357', 'title' => ''], + 'CpuPercent' => ['description' => 'The CPU utilization (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'MemPercent' => ['description' => 'The memory utilization (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '1.8368155', 'title' => ''], + 'GpuPercent' => ['description' => 'The GPU utilization (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'IoSpeed' => ['description' => 'The I/O read and write performance. Unit: byte/s.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '8919266', 'title' => ''], + 'IconUrl' => ['description' => 'The icon URL of the application.'."\n", 'type' => 'string', 'example' => 'https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png', 'title' => ''], 'Status' => [ - 'description' => 'The status of the CEN instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Creating'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Active'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Deleting'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Creating' => '', - 'Active' => '', - 'Deleting' => '', - ], - 'example' => 'Active', - ], - 'CreationTime' => [ - 'description' => 'The time when the CEN instance was created.'."\n", - 'type' => 'string', - 'example' => '2021-06-16T08:46Z', - ], - 'Ipv6Level' => [ - 'description' => 'The IPv6 level.'."\n" - ."\n" - .'> IPv6 is not supported.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* DISABLED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DISABLED' => '', - ], - 'example' => 'DISABLED', - ], - 'Description' => [ - 'description' => 'The description of the CEN instance.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CenId' => [ - 'description' => 'The ID of the CEN instance.'."\n", - 'type' => 'string', - 'example' => 'cen-3gwy16dojz1m65****', - ], - 'ProtectionLevel' => [ - 'description' => 'The tolerated level of CIDR block conflict.'."\n" + 'description' => 'The status of the application.'."\n" ."\n" .'Valid value:'."\n" ."\n" - .'* REDUCED: CIDR block conflicts are allowed, but the conflicting CIDR blocks cannot be identical.', - 'type' => 'string', - 'enumValueTitles' => [ - 'REDUCED' => '', - ], - 'example' => 'REDUCED', - ], - 'Name' => [ - 'description' => 'The name of the CEN instance.'."\n", + .'* Idle: The application is installed in the cloud computer but is not running.'."\n" + .'* Running: The application has been installed in the cloud computer and is running.'."\n", 'type' => 'string', - 'example' => 'testCen', - ], - 'Tags' => [ - 'description' => 'The tags of the CEN instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'testKey', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'testValue', - ], - ], - ], + 'enumValueTitles' => ['Idle' => '', 'Running' => ''], + 'example' => 'Running', + 'title' => '', ], - 'PackageIds' => [ - 'description' => 'The bandwidth plans that are bound to the CEN instance.'."\n", + 'ProcessData' => [ + 'description' => 'The processes.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The process.'."\n", 'type' => 'object', 'properties' => [ - 'PackageId' => [ - 'description' => 'The ID of the bandwidth plan that is bound to the CEN instance.'."\n", - 'type' => 'string', - 'example' => 'cenbwp-4c2zaavbvh5f42****', - ], + 'ApplicationName' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'Google Chrome', 'title' => ''], + 'ApplicationVersion' => ['description' => 'The application version.'."\n", 'type' => 'string', 'example' => '115.0.5790.110', 'title' => ''], + 'ProcessPath' => ['description' => 'The path to the process.'."\n", 'type' => 'string', 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe', 'title' => ''], + 'Pid' => ['description' => 'The PID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1357', 'title' => ''], + 'CpuPercent' => ['description' => 'The CPU utilization (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'MemPercent' => ['description' => 'The memory usage (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '1.8368155', 'title' => ''], + 'GpuPercent' => ['description' => 'The GPU usage (%).'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], + 'Iospeed' => ['description' => 'The I/O read and write performance. Unit: byte/s.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '8919266', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cens\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"CreationTime\\": \\"2021-06-16T08:46Z\\",\\n \\"Ipv6Level\\": \\"DISABLED\\",\\n \\"Description\\": \\"test\\",\\n \\"CenId\\": \\"cen-3gwy16dojz1m65****\\",\\n \\"ProtectionLevel\\": \\"REDUCED\\",\\n \\"Name\\": \\"testCen\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ],\\n \\"PackageIds\\": [\\n {\\n \\"PackageId\\": \\"cenbwp-4c2zaavbvh5f42****\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 50\\n 2BFA6822-240E-4E27-B4C8-AA400EF7474D\\n 1\\n \\n Active\\n REDUCED\\n test\\n DISABLED\\n 2021-06-16T08:46Z\\n cen-3gwy16dojz1m65****\\n testCen\\n \\n testValue\\n testKey\\n \\n \\n cenbwp-4c2zaavbvh5f42****\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeCens', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'VerifyCen' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DescribeGuestApplications', + 'summary' => 'Queries the applications and their processes of an end user.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGuestApplications'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"272CF39E-B5DE-5BE3-A09B-B43F1026****\\",\\n \\"Applications\\": [\\n {\\n \\"ApplicationName\\": \\"Google Chrome\\",\\n \\"ApplicationVersion\\": \\"115.0.5790.110\\",\\n \\"ProcessPath\\": \\"C:\\\\\\\\\\\\\\\\Program Files\\\\\\\\\\\\\\\\Google\\\\\\\\\\\\\\\\Chrome\\\\\\\\\\\\\\\\Application\\\\\\\\\\\\\\\\chrome.exe\\",\\n \\"Pid\\": 1357,\\n \\"CpuPercent\\": 0,\\n \\"MemPercent\\": 1.8368155,\\n \\"GpuPercent\\": 0,\\n \\"IoSpeed\\": 8919266,\\n \\"IconUrl\\": \\"https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png\\",\\n \\"Status\\": \\"Running\\",\\n \\"ProcessData\\": [\\n {\\n \\"ApplicationName\\": \\"Google Chrome\\",\\n \\"ApplicationVersion\\": \\"115.0.5790.110\\",\\n \\"ProcessPath\\": \\"C:\\\\\\\\\\\\\\\\Program Files\\\\\\\\\\\\\\\\Google\\\\\\\\\\\\\\\\Chrome\\\\\\\\\\\\\\\\Application\\\\\\\\\\\\\\\\chrome.exe\\",\\n \\"Pid\\": 1357,\\n \\"CpuPercent\\": 0,\\n \\"MemPercent\\": 1.8368155,\\n \\"GpuPercent\\": 0,\\n \\"Iospeed\\": 8919266\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeImageModifiedRecords' => [ + 'summary' => 'Queries the image change records of a cloud computer.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Region ID. Call [DescribeRegions](~~196646~~) to list regions that support WUYING Workspace.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', + 'title' => '', ], ], [ - 'name' => 'CenId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the CEN instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cen-3gwy16dojz1m65****', - ], - ], - [ - 'name' => 'CenOwnerId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account to which the CEN instance belongs.'."\n" - ."\n" - .'* If you own the CEN instance, you can skip this parameter.'."\n" - .'* If you do not own the CEN instance, you must specify the ID of the account that owns the CEN instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '102681951715****', - ], + 'schema' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-bd53sfmysz8ir****', 'title' => ''], ], [ - 'name' => 'CidrBlock', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The IPv4 CIDR block of the associated office network.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '47.100.XX.XX', - ], + 'schema' => ['description' => 'Number of entries per page for paged queries.'."\n" + ."\n" + .'- Maximum: 100.'."\n" + ."\n" + .'- Default: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'VerifyCode', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code. If you do not own the CEN instance, you must call the [SendVerifyCode](~~436847~~) operation to obtain a verification code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12****', - ], + 'schema' => ['description' => 'Pagination token. Set this parameter to the NextToken value returned by the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l3d+SWeOobbIlDLjwhjkTk', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The check result of CIDR block conflict.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* InvalidCen.CenUidInvalid: The Alibaba Cloud account is invalid or the Alibaba Cloud account does not have the permission to access Elastic Desktop Service.'."\n" - .'* VerifyCode.InvalidTokenCode: The verification code is invalid.'."\n" - .'* VerifyCode.ReachTokenRetryTime: The maximum number of times for entering a verification code reaches the limit.'."\n" - .'* Conflict: A CIDR block conflict exists. If the verification result of at least one route is Conflict, Conflict is returned for this parameter.'."\n" - .'* Access: The verification is passed. If the verification result for all routes is Access, Access is returned for this parameter.'."\n" - .'* InvalidCen.ParameterCenInstanceId: The Alibaba Cloud account does not own the CEN instance.', - 'type' => 'string', - 'enumValueTitles' => [ - 'InvalidCen.CenUidInvalid' => '', - 'VerifyCode.InvalidTokenCode' => '', - 'VerifyCode.ReachTokenRetryTime' => '', - 'Conflict' => '', - 'Access' => '', - 'InvalidCen.ParameterCenInstanceId' => '', - ], - 'example' => 'Access', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0AF9D857-AE96-53D6-B317-5DD665EC4EC0', - ], - 'CidrBlocks' => [ - 'description' => 'The recommended IPv4 CIDR blocks. Three CIDR blocks are randomly recommended. This parameter is returned when the `Status` value is `Conflict`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recommended IPv4 CIDR blocks. Three CIDR blocks are randomly recommended. This parameter is returned when the `Status` value is `Conflict`.'."\n", - 'type' => 'string', - 'example' => ' ["10.0.0.****","172.24.0.****","192.168.128.****"]', - ], - ], - 'RouteEntries' => [ - 'description' => 'The routes provided by the CEN instance.'."\n", + 'NextToken' => ['description' => 'Token for the next page of results. An empty NextToken means no more results.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DC40EE61-7E83-59ED-AEA6-7EE9C437F352', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of image modification records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ImageModifiedRecords' => [ + 'description' => 'Collection of image modification records.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the routes of the CEN instance.'."\n", + 'description' => 'Image modification record.', 'type' => 'object', 'properties' => [ 'Status' => [ - 'description' => 'The verification result of the route.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Conflict: A CIDR block conflict exists.'."\n" - .'* Access: The verification is passed.', - 'type' => 'string', - 'enumValueTitles' => [ - 'Conflict' => '', - 'Access' => '', - ], - 'example' => 'Access', - ], - 'NextHopInstanceId' => [ - 'description' => 'The ID of the instance corresponding to the route.'."\n", - 'type' => 'string', - 'example' => 'vpc-uf62bu0xs5j8md54p****', - ], - 'DestinationCidrBlock' => [ - 'description' => 'The CIDR block of the route.'."\n", - 'type' => 'string', - 'example' => '172.16.111.3****', - ], - 'RegionId' => [ - 'description' => 'The region ID of the route.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'description' => 'Status of the image modification.', + 'enumValueTitles' => ['Modifying image.', 'Image modified successfully.', 'Image modification failed.'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', ], + 'UpdateTime' => ['description' => 'Time when the image was last modified.', 'type' => 'string', 'example' => '2022-03-03T02:43:44.851Z', 'title' => ''], + 'NewImageName' => ['description' => 'Name of the new image after modification.', 'type' => 'string', 'example' => 'Windows server 2022 Mainland asp', 'title' => ''], + 'ImageName' => ['description' => 'Name of the original image before modification.', 'type' => 'string', 'example' => 'Windows server 2019 Mainland', 'title' => ''], + 'NewImageId' => ['description' => 'ID of the new image after modification.', 'type' => 'string', 'example' => 'desktopimage-windows-server-2022-64-ch-asp', 'title' => ''], + 'ImageId' => ['description' => 'ID of the original image before modification.', 'type' => 'string', 'example' => 'desktopimage-windows-server-2019-64-ch-asp', 'title' => ''], + 'Reason' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'TransitRouterService.TrNotExistInRegion', - 'errorMessage' => 'The transit router need create in current region.', - ], - ], + 'title' => 'DescribeImageModifiedRecords', + 'changeSet' => [ + ['createdAt' => '2025-04-25T10:05:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-05-12T02:46:24.000Z', 'description' => 'OpenAPI offline'], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImageModifiedRecords'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Access\\",\\n \\"RequestId\\": \\"0AF9D857-AE96-53D6-B317-5DD665EC4EC0\\",\\n \\"CidrBlocks\\": [\\n \\" [\\\\\\"10.0.XX.XX\\\\\\",\\\\\\"172.24.XX.XX\\\\\\",\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"RouteEntries\\": [\\n {\\n \\"Status\\": \\"Access\\",\\n \\"NextHopInstanceId\\": \\"vpc-uf62bu0xs5j8md54p****\\",\\n \\"DestinationCidrBlock\\": \\"172.16.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Access\\n \\n Access\\n 100.64.X.X/10\\n cn-shanghai\\n \\n \\n Access\\n 172.16.111.0/27\\n cn-shanghai\\n vpc-uf62bu0xs5j8md54****\\n \\n \\n Access\\n 192.168.0.0/24\\n cn-shanghai\\n vpc-uf6n17kvw0t15br3s****\\n \\n 06D87278-F765-5FC9-9978-ADD7DC070C7D\\n","errorExample":""}]', - 'title' => 'VerifyCen', - 'summary' => 'Verifies the ID of a Cloud Enterprise Network (CEN) instance and the ID of the Alibaba Cloud account to which the instance belongs and checks whether a CIDR block conflict exists between the routes of the instance and the IPv4 CIDR blocks of the associated office network.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821\\",\\n \\"RequestId\\": \\"DC40EE61-7E83-59ED-AEA6-7EE9C437F352\\",\\n \\"TotalCount\\": 20,\\n \\"ImageModifiedRecords\\": [\\n {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2022-03-03T02:43:44.851Z\\",\\n \\"NewImageName\\": \\"Windows server 2022 Mainland asp\\",\\n \\"ImageName\\": \\"Windows server 2019 Mainland\\",\\n \\"NewImageId\\": \\"desktopimage-windows-server-2022-64-ch-asp\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-asp\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'SendVerifyCode' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeImagePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'VerifyCodeAction', - 'in' => 'query', - 'schema' => [ - 'description' => 'The action that you want to perform by using the verification code.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* eds_cenID_securityverification: Use the verification code to verify the CEN instance.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'eds_cenID_securityverification' => 'eds_cenID_securityverification', - ], - 'example' => 'eds_cenID_securityverification', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ExtraInfo', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The information that is required to send the verification code, in JSON format. When you verify the CEN instance of another Alibaba Cloud account, you must provide the ID of the CEN instance and the ID of the Alibaba Cloud account to which the instance belongs.'."\n" - ."\n" - .'* CenId: the ID of the CEN instance.'."\n" - .'* CenOwnerId: the ID of the Alibaba Cloud account to which the CEN instance belongs.'."\n" - ."\n" - .'> If you own the CEN instance, skip this parameter. If you do not own the CEN instance, specify the ID of the Alibaba Cloud account that owns the CEN instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"cenOwnerId": 1234567890******,"cenId": "cen-3weq30r6t0s7t4****"}', - ], + 'schema' => ['description' => 'The image ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object that is returned.'."\n", + 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', 'title' => ''], + 'AliUids' => [ + 'description' => 'The IDs of the Alibaba Cloud accounts with which the image is shared.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IDs of the recipient Alibaba Cloud accounts.'."\n", 'type' => 'string', 'example' => '176102063125****', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'SendVerifyCode', - 'summary' => 'Obtains the verification code that is required when you bind an advanced office network to a Cloud Enterprise Network (CEN) instance that belongs to another Alibaba Cloud account.', - 'description' => 'You must call this operation to obtain the verification code that is required when you bind an advanced office network to a CEN instance that belongs to another Alibaba Cloud account. After you call this operation, the system sends a verification code to the email address associated with the Alibaba Cloud account to which the CEN instance belongs.'."\n", - ], - 'AttachCen' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"AliUids\\": [\\n \\"176102063125****\\"\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeImagePermission', + 'summary' => 'Queries the recipient Alibaba Cloud accounts with which an image is shared.', + 'description' => 'You can call the [ModifyImagePermission](~~436982~~) operation to share an image with another cloud computer user or unshare an image. You can call the DescribeImagePermission operation to obtain the Alibaba Cloud accounts with which the current image is shared.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImagePermission'], + ], ], + 'ramActions' => [], + ], + 'DescribeImages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that determines the start point of the next query. If you do not specify this parameter, all results are returned.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'ImageType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The type of the image.', + 'enumValueTitles' => ['SYSTEM' => '', 'CUSTOM' => ''], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'SYSTEM', + 'title' => '', ], ], [ - 'name' => 'CenId', + 'name' => 'ImageStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the CEN instance.'."\n", + 'description' => 'The state of the image.', + 'enumValueTitles' => ['Creating' => '', 'Available' => '', 'CreateFailed' => ''], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cen-3gwy16dojz1m65****', + 'required' => false, + 'example' => 'Available', + 'title' => '', ], ], [ - 'name' => 'CenOwnerId', + 'name' => 'GpuCategory', 'in' => 'query', 'schema' => [ - 'description' => 'The Alibaba Cloud account to which the CEN instance belongs.'."\n" + 'description' => 'Specifies whether the images are GPU-accelerated images.'."\n" ."\n" - .'* If you own the CEN instance, you can skip this parameter.'."\n" - .'* If you do not own the CEN instance, you must specify the ID of the account that owns the CEN instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', 'required' => false, - 'example' => '102681951715****', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'VerifyCode', + 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'description' => 'The verification code. If you do not own the CEN instance, you must call the [SendVerifyCode](~~436847~~) operation to obtain a verification code.'."\n", + 'description' => 'The protocol type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- HDX: High-definition Experience (HDX) protocol'."\n" + ."\n" + .'- ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)', + 'enumValueTitles' => ['HDX' => '', 'ASP' => ''], 'type' => 'string', 'required' => false, - 'example' => '12****', + 'example' => 'ASP', + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'LanguageType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", + 'description' => 'The language of the OS.', + 'enumValueTitles' => ['en-US' => '', 'zh-HK' => '', 'zh-CN' => '', 'ja-JP' => ''], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'required' => false, + 'example' => 'en-US', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', - 'title' => 'AttachCen', - 'summary' => 'Binds an advanced office network to a Cloud Enterprise Network (CEN) instance.', - 'description' => 'Prerequisites'."\n" - ."\n" - .'* A CEN instance is created.'."\n" - .'* The office network is an advanced office network, and the account system type is convenient account.'."\n" - ."\n" - .'> The office network is added to the CEN instance when you create the instance. An office network can be added to only one CEN instance.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DetachCen' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'DesktopInstanceType', + 'in' => 'query', + 'schema' => ['description' => 'The instance type of the cloud computer. You can call the [DescribeDesktopTypes](~~436816~~) operation to obtain the parameter value.', 'type' => 'string', 'required' => false, 'example' => 'ecd.graphics.xlarge', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ImageId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The IDs of the images. You can specify one or more image IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + 'required' => false, + 'example' => 'm-gx2x1dhsmusr2****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'OsType', 'in' => 'query', 'schema' => [ - 'description' => 'The office network ID.'."\n", + 'description' => 'The type of the operating system of the images. Default value: `null`.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Linux'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Windows'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', + 'required' => false, + 'example' => 'Windows', + 'title' => '', ], ], + [ + 'name' => 'GpuDriverVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the GPU driver.', 'type' => 'string', 'required' => false, 'example' => '417.22', 'title' => ''], + ], + [ + 'name' => 'SessionType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session type.', + 'enumValueTitles' => ['SINGLE_SESSION' => '', 'MULTIPLE_SESSION' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'SINGLE_SESSION', + 'title' => '', + ], + ], + [ + 'name' => 'FotaVersion', + 'in' => 'query', + 'schema' => ['description' => 'The image version.', 'type' => 'string', 'required' => false, 'example' => '0.0.3-R-20220616.133609', 'title' => ''], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => ['description' => 'The image name.', 'type' => 'string', 'required' => false, 'example' => 'Win_01', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'NextToken' => ['description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB', 'title' => ''], + 'Images' => [ + 'description' => 'The details of the images.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the image.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => 'The time when the image was created.', 'type' => 'string', 'example' => '2018-01-10T01:01:10Z', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the image.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Creating'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Available'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CreateFailed'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['Creating' => '', 'Available' => '', 'CreateFailed' => ''], + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'Progress' => ['description' => 'The creation progress of the image. Unit: %.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'DataDiskSize' => ['description' => 'The size of the data disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'ImageType' => [ + 'description' => 'The type of the image.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- SYSTEM'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CUSTOM'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['SYSTEM' => '', 'CUSTOM' => ''], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', + ], + 'Description' => ['description' => 'The description of the image.', 'type' => 'string', 'example' => 'This is description.', 'title' => ''], + 'Size' => ['description' => 'The size of the image. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + 'OsType' => ['description' => 'The type of the operating system.', 'type' => 'string', 'example' => 'WINDOWS', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- HDX: High-definition Experience (HDX) protocol'."\n" + ."\n" + .'- ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)', + 'enumValueTitles' => ['HDX' => '', 'ASP' => ''], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'Name' => ['description' => 'The name of the image.', 'type' => 'string', 'example' => 'testImageName', 'title' => ''], + 'ImageId' => ['description' => 'The ID of the image.', 'type' => 'string', 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], + 'GpuCategory' => ['description' => 'Indicates whether the image is a GPU-accelerated image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SupportedLanguages' => [ + 'description' => 'The languages of the operating system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The languages of the operating system. One or more languages are supported.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- en-US: American English.'."\n" + ."\n" + .'- zh-HK: traditional Chinese (Hong Kong, China)'."\n" + ."\n" + .'- zh-CN: simple Chinese'."\n" + ."\n" + .'- ja-JP: Japanese', + 'enumValueTitles' => ['en-US' => '', 'zh-HK' => '', 'zh-CN' => '', 'ja-JP' => ''], + 'type' => 'string', + 'example' => 'en-US', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GpuDriverVersion' => ['description' => 'The version number of the GPU driver.', 'type' => 'string', 'example' => '417.22', 'title' => ''], + 'AppVersion' => ['description' => 'The version of the image.', 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'VolumeEncryptionEnabled' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to query the list of KMS keys.', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + 'SharedCount' => ['description' => 'The number of shared images.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SessionType' => [ + 'description' => 'The type of the image session.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- SINGLE\\_SESSION: single-session image.'."\n" + ."\n" + .'- MULTIPLE\\_SESSION: multi-session image.', + 'enumValueTitles' => ['SINGLE_SESSION' => '', 'MULTIPLE_SESSION' => ''], + 'type' => 'string', + 'example' => 'MULTIPLE_SESSION', + 'title' => '', + ], + 'UpdateTime' => ['description' => 'The time when the image was last modified.', 'type' => 'string', 'example' => '2021-12-22T02:48:43Z', 'title' => ''], + 'Platform' => [ + 'description' => 'The operating system type of the image.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Ubuntu'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Windows Server 2022'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- UOS'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CentOS'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Windows Server 2019'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- SQL Server 2016'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Windows 10'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['Ubuntu' => 'Ubuntu', 'Windows Server 2022' => 'Windows Server 2022', 'UOS' => 'UOS', 'CentOS' => 'CentOS', 'Windows Server 2019' => 'Windows Server 2019', 'Windows Server 2016' => 'Windows Server 2016', 'Windows 10' => 'Windows 10'], + 'type' => 'string', + 'example' => 'Windows Server 2019', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', - 'title' => 'DetachCen', - 'summary' => 'Unbinds an advanced office network from a CEN instance.', + 'title' => 'DescribeImages', + 'summary' => 'Queries the information about images.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDrive' => [ - 'summary' => 'Creates a user-level storage resource.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2023-06-13T12:35:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-22T06:06:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], + ['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImages'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\",\\n \\"Images\\": [\\n {\\n \\"CreationTime\\": \\"2018-01-10T01:01:10Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"Progress\\": \\"100%\\",\\n \\"DataDiskSize\\": 150,\\n \\"ImageType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"This is description.\\",\\n \\"Size\\": 40,\\n \\"OsType\\": \\"WINDOWS\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"Name\\": \\"testImageName\\",\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"GpuCategory\\": false,\\n \\"SupportedLanguages\\": [\\n \\"en-US\\"\\n ],\\n \\"GpuDriverVersion\\": \\"417.22\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"SharedCount\\": 1,\\n \\"SessionType\\": \\"MULTIPLE_SESSION\\",\\n \\"UpdateTime\\": \\"2021-12-22T02:48:43Z\\",\\n \\"Platform\\": \\"Windows Server 2019\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeInvocations' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliUid', + 'name' => 'InvokeId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of your Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1202****', - ], + 'schema' => ['description' => 'The execution ID of the command. You can obtain the value by calling the [RunCommand](~~RunCommand~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 't-hz0jdfwd9f****', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'CommandType', 'in' => 'query', 'schema' => [ - 'description' => 'The user ID.'."\n", + 'description' => 'The command type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RunPowerShellScript: the PowerShell command.'."\n" + .'* RunBatScript: the Bat command.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'user01', + 'enumValueTitles' => ['RunPowerShellScript' => '', 'RunBatScript' => ''], + 'example' => 'RunPowerShellScript', + 'title' => '', ], ], [ - 'name' => 'DomainId', + 'name' => 'InvokeStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the storage resource.'."\n" + 'description' => 'The execution status of the command. The value of this parameter is determined by the execution states of the command on all participating cloud computers.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'> Call the DescribeDrives operation to retrieve the storage resource ID.'."\n", + .'* Finished: The command execution completes on all cloud computers. Alternatively, the command execution is manually stopped on some cloud computers while it completes on the others.'."\n" + .'* Stopped: The command execution stops.'."\n" + .'* Failed: The command execution failed on all cloud computers.'."\n" + .'* Running: Once there is a command execution in progress, the execution status defaults to Running.'."\n" + .'* PartialFailed: If the command execution failed on part of the cloud computers, the execution status is considered partially failed.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'dom-aaaa****', + 'enumValueTitles' => ['Finished' => '', 'Stopped' => '', 'Failed' => '', 'Running' => '', 'PartialFailed' => ''], + 'example' => 'Finished', + 'title' => '', ], ], [ - 'name' => 'ExternalDomainId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the external storage resource.'."\n" - ."\n" - .'> Call the DescribeDrives operation to retrieve the external storage resource ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234****', - ], + 'schema' => ['description' => 'The cloud computer ID. If you specify a cloud computer, all command execution records of the cloud computer are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'IncludeOutput', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the storage resource.'."\n" + 'description' => 'Specifies whether to return command outputs in the response.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* NAS: File Storage NAS'."\n" - .'* PDS: Drive and Photo Service'."\n", - 'type' => 'string', + .'* true'."\n" + .'* false (default)'."\n", + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'NAS' => '', - 'PDS' => '', - ], - 'example' => 'NAS', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'Type', + 'name' => 'ContentEncoding', 'in' => 'query', 'schema' => [ - 'description' => 'The usage of the storage resource.'."\n" + 'description' => 'The encoding method of the command content and outputs.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* DESKTOP: data disk space'."\n" - .'* USER_PROFILE: space for personal data of the user'."\n", + .'* Base64 (default): returns the Base64-encoded command content and command outputs.'."\n" + .'* PlainText: returns the original command content and outputs in plain text.'."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP' => '', - 'USER_PROFILE' => '', - ], - 'example' => 'USER_PROFILE', + 'enumValueTitles' => ['Base64' => '', 'PlainText' => ''], + 'example' => 'PlainText', + 'title' => '', ], ], [ - 'name' => 'DriveName', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the user-level storage resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test01', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'* Valid values: 1 to 50.'."\n" + .'* Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '50', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The query token. Set the value to the NextToken value that is returned from the last call to the previous DescribeInvocations operation.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'DesktopIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The description of the user-level storage resource.'."\n", - 'type' => 'string', + 'description' => 'The cloud computer IDs.'."\n" + ."\n" + .'> The `DesktopId` parameter will be deprecated. We recommend using the DesktopIds parameter to specify cloud computer IDs instead.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****', 'title' => ''], 'required' => false, - 'example' => 'test01', + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProfileRoaming', + 'name' => 'IncludeInvokeDesktops', 'in' => 'query', 'schema' => [ - 'description' => '> This parameter is deprecated.'."\n", + 'description' => 'Specifies whether to return the execution results of the remote command on all cloud computers when executed across multiple cloud computers.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, - 'example' => '-', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B7AA****', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'Code' => [ - 'description' => 'The response code. The value 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Drive' => [ - 'description' => 'The user-level storage resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => 'The time when the storage resource was created.'."\n", - 'type' => 'string', - 'example' => '2025-07-02T08:42:26.000+00:00', - ], - 'GmtModified' => [ - 'description' => 'The time when the storage resource was last modified.'."\n", - 'type' => 'string', - 'example' => '2025-07-07T02:46:04.000+00:00', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1202****', - ], - 'DomainId' => [ - 'description' => 'The ID of the storage resource.'."\n", - 'type' => 'string', - 'example' => 'dom-aaaa****', - ], - 'DriveId' => [ - 'description' => 'The ID of the user-level storage resource.'."\n", - 'type' => 'string', - 'example' => 'dri-aaaa****', - ], - 'ExternalDriveId' => [ - 'description' => 'The ID of the external user-level storage resource.'."\n" + 'NextToken' => ['description' => 'The query token that is returned from this call.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], + 'Invocations' => [ + 'description' => 'The command execution records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The command execution record.'."\n", + 'type' => 'object', + 'properties' => [ + 'InvokeId' => ['description' => 'The ID of the execution.'."\n", 'type' => 'string', 'example' => 't-hz0jdfwd9f****', 'title' => ''], + 'CommandContent' => ['description' => 'The Base64-encoded command content.'."\n", 'type' => 'string', 'example' => 'cnBtIC1xYSB8IGdyZXAgdnNm****', 'title' => ''], + 'CommandType' => ['description' => 'The type of the command.'."\n", 'type' => 'string', 'example' => 'RunPowerShellScript', 'title' => ''], + 'InvocationStatus' => ['description' => 'The overall execution status of the command. The value of this parameter depends on the execution status of the command on all the involved cloud computers. Valid values:'."\n" ."\n" - .'> A value is returned for this parameter only if ResourceType is set to PDS.'."\n", - 'type' => 'string', - 'example' => '1100****', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => 'user01', - ], - 'ExternalUserId' => [ - 'description' => 'The ID of the external user.'."\n", - 'type' => 'string', - 'example' => 'user01@cn-hangzhou.120****', - ], - 'Name' => [ - 'description' => 'The name of the storage resource.'."\n", - 'type' => 'string', - 'example' => 'test****', - ], - 'Description' => [ - 'description' => 'The description of the storage resource.'."\n", - 'type' => 'string', - 'example' => 'test****', - ], - 'TotalSize' => [ - 'description' => 'The total amount of the user-level storage resource capacity.'."\n" + .'* Pending: The command is being verified or sent. If the execution status is Pending on at least one cloud computer, the overall status is considered Pending.'."\n" ."\n" - .'> Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '536870912000', - ], - 'UsedSize' => [ - 'description' => 'The amount of user-level storage resource capacity used.'."\n" + .'* Running: The command is being executed on cloud computers. If the execution status is Running on at least one cloud computer, the overall status is considered Running.'."\n" ."\n" - .'> Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '243175936', - ], - 'Status' => [ - 'description' => 'The status of the user-level storage resource.'."\n" + .'* Success: If the execution status is Success on at least one cloud computer and either Success or Stopped on all other cloud computers, the overall status is considered Success.'."\n" ."\n" - .'Valid values:'."\n" + .'* Failed: If the execution status is Stopped or Failed on all cloud computers, the overall status is considered Failed. If any execution status on cloud computers matches one of the following values, Failed is returned.'."\n" ."\n" - .'* INIT: initializing'."\n" - .'* MAINTAIN: maintaining'."\n" - .'* DELETING'."\n" - .'* INVALID'."\n" - .'* NORMAL'."\n" - .'* FAIL: failed'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '', - 'MAINTAIN' => '', - 'DELETING' => '', - 'INVALID' => '', - 'NORMAL' => '', - 'FAIL' => '', - ], - 'example' => 'NORMAL', - ], - 'Type' => [ - 'description' => 'The usage of the storage resource.'."\n" + .' * Invalid: The command is invalid.'."\n" + .' * Aborted: The command failed to be sent.'."\n" + .' * Failed: The command is executed, but the exit code is not 0.'."\n" + .' * Timeout: The command execution timed out.'."\n" + .' * Error: An error occurred when the command is being executed.'."\n" ."\n" - .'Valid values:'."\n" + .'* Stopping: The command execution is being stopped. If the execution status is Stopping on at least one cloud computer, the overall status is considered Stopping.'."\n" ."\n" - .'* DESKTOP: data disk space'."\n" - .'* USER_PROFILE: space for personal data of the user'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DESKTOP' => '', - 'USER_PROFILE' => '', + .'* Stopped: The command execution stops. If the execution status is Stopped on at least one cloud computer, the overall status is considered Stopped. If any execution status on cloud computers matches one of the following values, Stopped is returned.'."\n" + ."\n" + .' * Cancelled: The command execution is canceled.'."\n" + .' * Terminated: The command execution is terminated.'."\n" + ."\n" + .'* PartialFailed: The command execution succeeded on some cloud computers but failed on others. If the execution status on any cloud computer is Success, Failed, or Stopped, the overall status is considered PartialFailed.'."\n", 'type' => 'string', 'example' => 'Pending', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the execution task is created.'."\n", 'type' => 'string', 'example' => '2020-12-19T09:15:46Z', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'User1', 'title' => ''], + 'InvokeDesktops' => [ + 'description' => 'The cloud computers on which the command is executed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud computer on which the command is executed.'."\n", + 'type' => 'object', + 'properties' => [ + 'InvocationStatus' => ['description' => 'The execution progress of the command on a single cloud computer.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Output' => ['description' => 'The command output.'."\n" + ."\n" + .'* When the `IncludeOutput` parameter is set to false, the output is not returned.'."\n" + .'* When the `ContentEncoding` parameter is set to Base64, the output is returned as a Base64-encoded string.'."\n", 'type' => 'string', 'example' => 'OutPutTestmsg', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the command execution was performed.'."\n", 'type' => 'string', 'example' => '2020-12-20T06:15:54Z', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the execution status was updated.'."\n", 'type' => 'string', 'example' => '2020-12-25T06:15:56Z', 'title' => ''], + 'Repeats' => ['description' => 'The number of times the command has been executed on the cloud computer.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + 'Dropped' => ['description' => 'The size of the text that is truncated and discarded when the Output value exceeds 24 KB in size.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the command execution.'."\n", 'type' => 'string', 'example' => '2020-12-20T06:15:55Z', 'title' => ''], + 'StopTime' => ['description' => 'The stop time of the command execution (StopInvocatio).'."\n", 'type' => 'string', 'example' => '2020-12-25T09:15:47Z', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the command execution ended.'."\n", 'type' => 'string', 'example' => '2020-12-20T06:15:56Z', 'title' => ''], + 'ExitCode' => ['description' => 'The exit code of the execution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ErrorCode' => ['description' => 'The code explaining why the command failed to be sent or executed. Valid values:'."\n" + ."\n" + .'* Null: The command is executed successfully.'."\n" + .'* InstanceNotExists: The specified cloud computer does not exist or is released.'."\n" + .'* InstanceReleased: The cloud computer is released during the execution.'."\n" + .'* InstanceNotRunning: The cloud computer is not running during the execution.'."\n" + .'* CommandNotApplicable: The command cannot be executed on the specified cloud computer.'."\n" + .'* ClientNotRunning: The Cloud Assistant agent is not running.'."\n" + .'* ClientNotResponse: The Cloud Assistant agent does not respond.'."\n" + .'* ClientIsUpgrading: The Cloud Assistant agent is being updated.'."\n" + .'* ClientNeedUpgrade: The Cloud Assistant agent needs to be updated.'."\n" + .'* DeliveryTimeout: The command sending times out.'."\n" + .'* ExecutionTimeout: The command execution times out.'."\n" + .'* ExecutionException: An exception occurs when the command is being executed.'."\n" + .'* ExecutionInterrupted: The command execution is interrupted.'."\n" + .'* ExitCodeNonzero: The command execution completes, but the exit code is not 0.'."\n", 'type' => 'string', 'example' => 'InstanceNotExists', 'title' => ''], + 'ErrorInfo' => ['description' => 'The message explaining why the command failed to be sent or executed. Valid values:'."\n" + ."\n" + .'* Null: The command is executed successfully.'."\n" + .'* the specified instance does not exists: The specified cloud computer does not exist or is released.'."\n" + .'* the instance has released when create task: The cloud computer is released during the execution.'."\n" + .'* the instance is not running when create task: The cloud computer is not running during the execution.'."\n" + .'* the command is not applicable: The command cannot be executed on the specified cloud computer.'."\n" + .'* the aliyun service is not running on the instance: The Cloud Assistant agent is not running.'."\n" + .'* the aliyun service in the instance does not response: The Cloud Assistant agent does not respond.'."\n" + .'* the aliyun service in the instance is upgrading now: The Cloud Assistant agent is being updated.'."\n" + .'* the aliyun service in the instance need upgrade: The Cloud Assistant agent needs to be updated.'."\n" + .'* the command delivery has been timeout: The command sending times out.'."\n" + .'* the command execution has been timeout: The command execution times out.'."\n" + .'* the command execution got an exception: An exception occurs when the command is being executed.'."\n" + .'* the command execution has been interrupted: The command execution is interrupted.'."\n" + .'* the command execution exit code is not zero: The command execution completes, but the exit code is not 0.'."\n", 'type' => 'string', 'example' => 'The specified instance does not exist.', 'title' => ''], + 'DesktopName' => ['description' => 'The cloud computer name.'."\n", 'type' => 'string', 'example' => 'demo1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'example' => 'USER_PROFILE', - ], - 'ProfileRoaming' => [ - 'description' => '> This parameter is deprecated.'."\n", - 'type' => 'boolean', - 'example' => '-', + 'InvokeDesktopCount' => ['description' => 'The total number of cloud computers on which the command is executed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'InvokeDesktopSucceedCount' => ['description' => 'The total number of cloud computers on which the command execution succeeds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Drive\\": {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": \\"1202****\\",\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true\\n }\\n}","type":"json"}]', - 'title' => 'CreateDrive', - ], - 'DeleteDrive' => [ - 'summary' => 'Deletes a drive.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Invocations\\": [\\n {\\n \\"InvokeId\\": \\"t-hz0jdfwd9f****\\",\\n \\"CommandContent\\": \\"cnBtIC1xYSB8IGdyZXAgdnNm****\\",\\n \\"CommandType\\": \\"RunPowerShellScript\\",\\n \\"InvocationStatus\\": \\"Pending\\",\\n \\"CreationTime\\": \\"2020-12-19T09:15:46Z\\",\\n \\"EndUserId\\": \\"User1\\",\\n \\"InvokeDesktops\\": [\\n {\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"Output\\": \\"OutPutTestmsg\\",\\n \\"CreationTime\\": \\"2020-12-20T06:15:54Z\\",\\n \\"UpdateTime\\": \\"2020-12-25T06:15:56Z\\",\\n \\"Repeats\\": 0,\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\",\\n \\"Dropped\\": 0,\\n \\"StartTime\\": \\"2020-12-20T06:15:55Z\\",\\n \\"StopTime\\": \\"2020-12-25T09:15:47Z\\",\\n \\"FinishTime\\": \\"2020-12-20T06:15:56Z\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorCode\\": \\"InstanceNotExists\\",\\n \\"ErrorInfo\\": \\"The specified instance does not exist.\\",\\n \\"DesktopName\\": \\"demo1234\\"\\n }\\n ],\\n \\"InvokeDesktopCount\\": 1,\\n \\"InvokeDesktopSucceedCount\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the execution list and status of Cloud Assistant scripts ', + 'summary' => 'Used to query the execution list and status of Cloud Assistant scripts. ', + 'description' => '- After you execute a command, it does not necessarily mean that the command was successfully executed or produced the expected effect. You must check the actual execution result based on the return value from the API, and the actual output result prevails. '."\n" + .'- You can query execution information from the past two weeks, with a maximum retention limit of 100,000 records. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-13T06:29:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-18T06:09:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-18T15:09:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-29T06:07:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-30T12:11:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'], + ], ], + 'ramActions' => [], + ], + 'DescribeKmsKeys' => [ + 'summary' => 'Queries Key Management Service (KMS) keys of users. The first time you call this operation, you can try to create a service key for Elastic Desktop Service (EDS) and call the operation to return results.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '133183', + 'abilityTreeNodes' => ['FEATUREgwsOD038K'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DriveId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user-level storage resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dri-aaaa****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameter.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B7AA****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code. The value 200 indicates that the request was successful.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'KmsServiceStatus' => [ + 'description' => 'Indicates whether KMS is activated.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* disabled'."\n" + .'* enabled'."\n", 'type' => 'string', - 'example' => '200', + 'enumValueTitles' => ['disabled ' => '', 'enabled ' => ''], + 'example' => 'enabled', + 'title' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", + 'AuthorizeStatus' => [ + 'description' => 'The authorization status.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* not_authorized'."\n" + .'* authorized'."\n", 'type' => 'string', - 'example' => 'successful', + 'enumValueTitles' => ['not_authorized' => '', 'authorized' => ''], + 'example' => 'authorized', + 'title' => '', ], - 'Data' => [ - 'description' => 'Indicates whether the delete operation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Keys' => [ + 'description' => 'Customer master key (CMK)'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Details about the CMK.', + 'type' => 'object', + 'properties' => [ + 'KeyId' => ['description' => 'The ID of the key.', 'type' => 'string', 'example' => '05754286-3ba2-4fa6-8d41-4323aca6****', 'title' => ''], + 'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the key in KMS.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****', 'title' => ''], + 'Alias' => ['description' => 'The alias of the key.', 'type' => 'string', 'example' => 'TestAlias', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the key.', + 'type' => 'string', + 'enumValueTitles' => ['ServiceKey ' => '', 'CustomKey ' => ''], + 'example' => 'ServiceKey', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDrive', - ], - 'DescribeDrives' => [ - 'summary' => 'Queries user-level storage resources.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"KmsServiceStatus\\": \\"enabled\\",\\n \\"AuthorizeStatus\\": \\"authorized\\",\\n \\"Keys\\": [\\n {\\n \\"KeyId\\": \\"05754286-3ba2-4fa6-8d41-4323aca6****\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****\\",\\n \\"Alias\\": \\"TestAlias\\",\\n \\"Type\\": \\"ServiceKey\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeKmsKeys', + 'changeSet' => [ + ['createdAt' => '2022-05-23T04:01:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeKmsKeys'], + ], ], + 'ramActions' => [], + ], + 'DescribeModificationPrice' => [ + 'summary' => 'Query the Upgrade/Downgrade price for monthly subscription cloud desktops with unlimited duration or Internet premium bandwidth.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', + 'enumValueTitles' => ['cn-hangzhou' => 'cn-hangzhou'], 'type' => 'string', - 'required' => false, + 'required' => true, + 'docRequired' => true, 'example' => 'cn-hangzhou', + 'title' => '', ], ], [ - 'name' => 'UserId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of either the monthly subscription cloud computer with unlimited hours or the premium bandwidth plan.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-0gfv2z3sf95zvt****', 'title' => ''], ], [ - 'name' => 'DomainIds', + 'name' => 'InstanceType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the storage resources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the storage resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dom-aaaa****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The specifications.'."\n" + ."\n" + .'- Valid values when you set `ResourceType` to `Desktop`:'."\n" + ."\n" + .' - ecd.basic.small'."\n" + ."\n" + .' - ecd.basic.large'."\n" + ."\n" + .' - ecd.advanced.large'."\n" + ."\n" + .' - ecd.advanced.xlarge'."\n" + ."\n" + .' - ecd.performance.2xlarge'."\n" + ."\n" + .' - ecd.graphics.xlarge'."\n" + ."\n" + .' - ecd.graphics.2xlarge'."\n" + ."\n" + .' - ecd.advanced.xlarge\\_s8d2'."\n" + ."\n" + .' - ecd.advanced.xlarge\\_s8d7'."\n" + ."\n" + .' - ecd.graphics.1g72c'."\n" + ."\n" + .' - eds.general.2c2g'."\n" + ."\n" + .' - eds.general.2c4g'."\n" + ."\n" + .' - eds.general.2c8g'."\n" + ."\n" + .' - eds.general.4c8g'."\n" + ."\n" + .' - eds.general.4c16g'."\n" + ."\n" + .' - eds.general.8c16g'."\n" + ."\n" + .' - eds.general.8c32g'."\n" + ."\n" + .' - eds.general.16c32g'."\n" + ."\n" + .'- You can skip this parameter if `ResourceType` is set to `NetworkPackage`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'eds.enterprise_office.8c16g', 'title' => ''], + ], + [ + 'name' => 'RootDiskSizeGib', + 'in' => 'query', + 'schema' => ['description' => 'The size of the system disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'UserDiskSizeGib', + 'in' => 'query', + 'schema' => ['description' => 'The size of the data disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'RootDiskPerformanceLevel', + 'in' => 'query', + 'schema' => ['description' => 'Performance level of the system disk. When the WUYING Workspace instance type is set to graphics-optimized or high clock speed, you can specify the disk performance level. For differences between performance levels, see [](t583241.xdita#).', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], + ], + [ + 'name' => 'UserDiskPerformanceLevel', + 'in' => 'query', + 'schema' => ['description' => 'Performance level of the data disk. When the WUYING Workspace instance type is set to graphics-optimized or high clock speed, you can specify the disk performance level. For differences between performance levels, see [](t583241.xdita#).', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the storage resource.'."\n" + 'description' => 'The resource type. The required parameters depend on the resource type.'."\n" ."\n" - .'Valid values:'."\n" + .'- When `ResourceType` is set to `Desktop`, the required parameters are `InstanceType`, `RootDiskSizeGib`, and `UserDiskSizeGib`.'."\n" ."\n" - .'* NAS: NAS storage'."\n" - .'* PDS: PDS storage'."\n", + .'- When `ResourceType` is set to `NetworkPackage`, the required parameter is `Bandwidth`.', + 'enumValueTitles' => ['Desktop' => '(Default) Cloud computers.', 'NetworkPackage' => 'Premium bandwidth plans.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'NAS' => '', - 'PDS' => '', - ], - 'example' => 'NAS', + 'example' => 'Desktop', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'Bandwidth', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 500.'."\n" - .'* Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The maximum public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'> Valid values when PayByTraffic is set to PayByBandwidth: 10 to 1000.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '3072', 'minimum' => '2', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'PromotionId', 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAA****', - ], + 'schema' => ['description' => 'Promotion activity ID.', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'ResourceSpecs', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B7AA****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response code. The value 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'successful', - ], - 'Count' => [ - 'description' => 'The total number of storage resources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', + 'maxItems' => 20, + 'description' => 'List of resource specification templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of resource specification templates.', + 'type' => 'object', + 'properties' => [ + 'DesktopId' => ['description' => 'Cloud computer ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-6ghhzivgmnzgeyXXX', 'title' => ''], + 'RootDiskSizeGib' => ['description' => 'System disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'UserDiskSizeGib' => ['description' => 'Data disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAA****', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['description' => 'User ID for resource ownership in resale mode. You do not need to specify this parameter if resale mode is not used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1422724566551XXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****', 'title' => ''], + 'PriceInfo' => [ + 'description' => 'The price details.', + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'description' => 'The promotion rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotion rule.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'example' => '买满1年，立享官网价格8.5折优惠。', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '14806', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Price' => [ + 'description' => 'The price information.', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discounted amount.', 'type' => 'number', 'format' => 'float', 'example' => '15.8', 'title' => ''], + 'Currency' => ['description' => 'The unit of currency (CNY).The unit of currency (USD).', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TradePrice' => ['description' => 'The actual price. The actual price is the original price minus the discount.', 'type' => 'number', 'format' => 'float', 'example' => '63.2', 'title' => ''], + 'Promotions' => [ + 'description' => 'The promotion activities.', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotion activity.', + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => ['description' => 'The promotion description.', 'type' => 'string', 'example' => '新品上市，立享优惠', 'title' => ''], + 'OptionCode' => ['description' => 'The description of the promotion rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Selected' => ['description' => 'Indicates whether an item is selected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PromotionId' => ['description' => 'The ID of the promotion activity.', 'type' => 'string', 'example' => 'promo_option', 'title' => ''], + 'PromotionName' => ['description' => 'The name of the promotion activity.', 'type' => 'string', 'example' => 'Featured deals', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OrderLines' => [ + 'description' => 'The orders.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The order.', 'type' => 'string', 'example' => '5376483****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Drives' => [ - 'description' => 'The user-level storage resources.'."\n", + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48174475-5EB2-5F99-A9E9-6F892D645****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 14806\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"promo_option\\",\\n \\"PromotionName\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Query Upgrade/Downgrade Price', + 'changeSet' => [ + ['createdAt' => '2025-11-04T08:21:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-09T03:02:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-29T01:40:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-12T08:48:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeModificationPrice'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeModificationPrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'DescribeNASFileSystems' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions where Elastic Desktop Service (EDS) is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the office network.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the NAS file systems.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the NAS file system.', 'type' => 'string', 'required' => false, 'example' => '04f314****', 'title' => ''], + 'required' => false, + 'example' => '04f314****', + 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'MatchCompatibleProfile', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only NAS file systems that are compatible with User Profile Management (UPM).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token for the next page of results. If this parameter is empty, no more results are available.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], + 'FileSystems' => [ + 'description' => 'The details of the NAS file systems.', 'type' => 'array', 'items' => [ - 'description' => 'The user-level storage resource.'."\n", + 'description' => 'The details of a NAS file system.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The user ID.'."\n" - ."\n" - .'> You can ignore this parameter.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'GmtCreate' => [ - 'description' => 'The time when the storage resource was created.'."\n", - 'type' => 'string', - 'example' => '2025-07-02T08:42:26.000+00:00', - ], - 'GmtModified' => [ - 'description' => 'The time when the storage resource was modified.'."\n", - 'type' => 'string', - 'example' => '2025-07-07T02:46:04.000+00:00', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1202****', - ], - 'DomainId' => [ - 'description' => 'The ID of the storage resource.'."\n", - 'type' => 'string', - 'example' => 'dom-aaaa****', - ], - 'ExternalDomainId' => [ - 'description' => 'The ID of the external storage resource.'."\n" - ."\n" - .'* If ResourceType is set to NAS, the NAS ID is returned for this parameter.'."\n" - .'* If ResourceType is set to PDS, the PDS ID is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => '0976****', - ], - 'DriveId' => [ - 'description' => 'The ID of the user-level storage resource.'."\n", - 'type' => 'string', - 'example' => 'dri-aaaa****', - ], - 'ExternalDriveId' => [ - 'description' => 'The ID of the storage resource at the external user level.'."\n" - ."\n" - .'> This parameter is returned only if ResourceType is set to PDS.'."\n", - 'type' => 'string', - 'example' => '1100****', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", + 'Capacity' => ['description' => 'The storage capacity of the NAS file system, in GiB.'."\n" + ."\n" + .'- If the storage type is capacity type, the capacity is 10 PiB (10,485,760 GiB).'."\n" + ."\n" + .'- If the storage type is performance type, the capacity is 1 PiB (1,048,576 GiB).', 'type' => 'integer', 'format' => 'int64', 'example' => '10485760', 'title' => ''], + 'MountTargetStatus' => [ + 'description' => 'The status of the mount target.', + 'enumValueTitles' => ['Active' => 'The mount target is active.', 'Inactive' => 'The mount target is inactive.', 'Pending' => 'The mount target is being created.', 'Deleting' => 'The mount target is being deleted.', 'Invalid' => 'The mount target is invalid.'], 'type' => 'string', - 'example' => 'user01', + 'example' => 'Active', + 'title' => '', ], - 'ExternalUserId' => [ - 'description' => 'The ID of the external user.'."\n" - ."\n" - .'> This parameter is returned only if ResourceType is set to PDS.'."\n", + 'CreateTime' => ['description' => 'The creation time of the NAS file system.', 'type' => 'string', 'example' => '2021-05-10T11:39Z', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'SupportAcl' => ['description' => 'Indicates whether the Server Message Block (SMB) access control list (ACL) feature is supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'StorageType' => [ + 'description' => 'The storage type of the NAS file system.', + 'enumValueTitles' => ['Capacity' => 'capacity type', 'Performance' => 'performance type'], 'type' => 'string', - 'example' => 'user01@cn-hangzhou.120****', + 'example' => 'Capacity', + 'title' => '', ], - 'Name' => [ - 'description' => 'The name of the storage resource.'."\n", + 'OfficeSiteName' => ['description' => 'The name of the office network.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'FileSystemId' => ['description' => 'The ID of the NAS file system.', 'type' => 'string', 'example' => '04f314****', 'title' => ''], + 'FileSystemType' => [ + 'description' => 'The type of the NAS file system. Currently, only the standard type is supported. The value is always `standard`.', + 'enumValueTitles' => ['standard' => 'standard type'], 'type' => 'string', - 'example' => 'test****', + 'example' => 'standard', + 'title' => '', ], - 'Description' => [ - 'description' => 'The introduction to the storage resource.'."\n", + 'FileSystemName' => ['description' => 'The name of the NAS file system.', 'type' => 'string', 'example' => 'testNAS', 'title' => ''], + 'MeteredSize' => ['description' => 'The amount of storage used by the NAS file system, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'MountTargetDomain' => ['description' => 'The domain name of the mount target.', 'type' => 'string', 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com', 'title' => ''], + 'Description' => ['description' => 'The description of the NAS file system.', 'type' => 'string', 'example' => 'testDescription', 'title' => ''], + 'ZoneId' => ['description' => 'The ID of the zone.', 'type' => 'string', 'example' => 'cn-hangzhou-f', 'title' => ''], + 'FileSystemStatus' => [ + 'description' => 'The status of the NAS file system.', + 'enumValueTitles' => ['Stopped' => 'The file system is stopped.', 'Running' => 'The file system is running.', 'Deleted' => 'The file system is deleted.', 'Pending' => 'The file system is being created.', 'Deleting' => 'The file system is being deleted.', 'Invalid' => 'The file system is invalid.'], 'type' => 'string', - 'example' => 'test****', - ], - 'TotalSize' => [ - 'description' => 'The total amount of user-level storage capacity.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '536870912000', - ], - 'UsedSize' => [ - 'description' => 'The amount of user-level storage capacity used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '243175936', + 'example' => 'Running', + 'title' => '', ], - 'Status' => [ - 'description' => 'The status of the user-level storage resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INIT: initializing'."\n" - .'* MAINTAIN: maintaining'."\n" - .'* DELETING: deleting'."\n" - .'* INVALID: invalid'."\n" - .'* NORMAL: normal'."\n" - .'* FAIL: failed'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'INIT' => '', - 'MAINTAIN' => '', - 'DELETING' => '', - 'INVALID' => '', - 'NORMAL' => '', - 'FAIL' => '', + 'EncryptionEnabled' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProfileCompatible' => ['description' => 'Indicates whether the User Profile Management (UPM) feature is supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DesktopGroups' => [ + 'description' => 'The desktop groups associated with the UPM-supported NAS file system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a desktop group.', + 'type' => 'object', + 'properties' => [ + 'DesktopGroupId' => ['description' => 'The ID of the desktop group.', 'type' => 'string', 'example' => 'dg-9eeyf15b25nyl****', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the desktop group.', 'type' => 'string', 'example' => 'test_dg', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'NORMAL', + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'description' => 'The usage of the storage resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DESKTOP: data disk space'."\n" - .'* USER_PROFILE: personal data space'."\n", + 'Scene' => [ + 'description' => 'The use case of the NAS file system.', + 'enumValueTitles' => ['Upm' => 'UPM NAS', 'ShareNas' => 'shared NAS file system'], 'type' => 'string', - 'enumValueTitles' => [ - 'DESKTOP' => '', - 'USER_PROFILE' => '', - ], - 'example' => 'USER_PROFILE', - ], - 'ProfileRoaming' => [ - 'description' => '> This parameter is deprecated.'."\n", - 'type' => 'boolean', - 'example' => '-', - ], - 'DesktopGroupCount' => [ - 'description' => 'The number of associated cloud computer pools.'."\n" - ."\n" - .'> This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'example' => 'Upm', + 'title' => '', ], - 'DesktopGroups' => [ - 'description' => 'The details of the associated cloud computers.'."\n" - ."\n" - .'> This parameter is returned only if ResourceType is set to NAS and Type is set to USER_PROFILE.'."\n", + 'AppInstanceGroups' => [ + 'description' => 'The application delivery groups associated with the UPM-supported NAS file system.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the cloud computer pool.'."\n", + 'description' => 'The details of an application delivery group.', 'type' => 'object', 'properties' => [ - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer pool.'."\n", - 'type' => 'string', - 'example' => 'dg-aaaa****', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer pool.'."\n", - 'type' => 'string', - 'example' => 'group01', - ], + 'AppInstanceGroupId' => ['description' => 'The ID of the application delivery group.', 'type' => 'string', 'example' => 'aig-0bz55ibznu9p7****', 'title' => ''], + 'AppInstanceGroupName' => ['description' => 'The name of the application delivery group.', 'type' => 'string', 'example' => 'DemoDeliveryGroup', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'EnableProfileManagement' => [ - 'description' => 'Indicates whether the UPM feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'AllowOperateUserDrive' => ['description' => '> This parameter is not publicly available.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'SizeQuota' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'OfficeSites' => [ + 'description' => 'The office networks associated with the file system.', + 'type' => 'array', + 'items' => [ + 'description' => 'The office network.', + 'type' => 'object', + 'properties' => [ + 'OfficeSiteId' => ['description' => 'The ID of the office network.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The name of the office network.', 'type' => 'string', 'example' => 'DemoOfficeNetwork', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'ProductType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Count\\": 2,\\n \\"NextToken\\": \\"AAAA****\\",\\n \\"Drives\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": 0,\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"ExternalDomainId\\": \\"0976****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true,\\n \\"DesktopGroupCount\\": 1,\\n \\"DesktopGroups\\": [\\n {\\n \\"DesktopGroupId\\": \\"dg-aaaa****\\",\\n \\"DesktopGroupName\\": \\"group01\\"\\n }\\n ],\\n \\"EnableProfileManagement\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDrives', - ], - 'CreateCloudDriveService' => [ - 'summary' => 'Creates an enterprise drive.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeNASFileSystems', + 'summary' => 'Queries NAS file systems.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-12-19T08:10:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-27T01:45:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-27T01:32:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNASFileSystems'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeNASFileSystems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"FileSystems\\": [\\n {\\n \\"Capacity\\": 10485760,\\n \\"MountTargetStatus\\": \\"Active\\",\\n \\"CreateTime\\": \\"2021-05-10T11:39Z\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"SupportAcl\\": false,\\n \\"StorageType\\": \\"Capacity\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemId\\": \\"04f314****\\",\\n \\"FileSystemType\\": \\"standard\\",\\n \\"FileSystemName\\": \\"testNAS\\",\\n \\"MeteredSize\\": 0,\\n \\"MountTargetDomain\\": \\"04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"FileSystemStatus\\": \\"Running\\",\\n \\"EncryptionEnabled\\": false,\\n \\"ProfileCompatible\\": false,\\n \\"DesktopGroups\\": [\\n {\\n \\"DesktopGroupId\\": \\"dg-9eeyf15b25nyl****\\",\\n \\"DesktopGroupName\\": \\"test_dg\\"\\n }\\n ],\\n \\"Scene\\": \\"Upm\\",\\n \\"AppInstanceGroups\\": [\\n {\\n \\"AppInstanceGroupId\\": \\"aig-0bz55ibznu9p7****\\",\\n \\"AppInstanceGroupName\\": \\"DemoDeliveryGroup\\"\\n }\\n ],\\n \\"AllowOperateUserDrive\\": false,\\n \\"SizeQuota\\": 0,\\n \\"OfficeSites\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\"\\n }\\n ],\\n \\"ProductType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeNetworkPackages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Enterprise Drive Service is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the enterprise drive'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wuying-pds', - ], + 'schema' => ['description' => 'The number of entries per page in a paged query. '."\n" + ."\n" + .'- Maximum value: 100. '."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'OfficeSiteType', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience office network.'."\n" - .'* AD_CONNECTOR: enterprise Active Directory (AD) office network.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'SIMPLE', - 'default' => 'SIMPLE', - ], + 'schema' => ['description' => 'The token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'NetworkPackageId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the office network. This parameter takes effect only if you set OfficeSiteType to `AD_CONNECTOR`.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the premium Internet bandwidth plans. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the premium Internet bandwidth plan.', 'type' => 'string', 'required' => false, 'example' => 'np-amtp8e8q1o9e4****', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou+dir-400695****', + 'example' => 'np-amtp8e8q1o9e4****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'CenId', + 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the Cloud Enterprise Network (CEN) instance. This parameter takes effect only if you set `OfficeSiteType` to `AD_CONNECTOR`. If you have configured `OfficeSiteId`, you can leave this parameter empty.'."\n", + 'description' => 'The billing method of the pay-as-you-go premium Internet bandwidth plan.', + 'enumValueTitles' => ['PayByTraffic' => 'pay-by-data-transfer.', 'PayByBandwidth' => 'pay-by-bandwidth.'], 'type' => 'string', 'required' => false, - 'example' => 'cen-g4ba1mkji8nj6****', + 'example' => 'PayByBandwidth', + 'title' => '', ], ], [ - 'name' => 'DomainName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The domain name of the enterprise AD office network. This parameter takes effect only if you set `OfficeSiteType` to `AD_CONNECTOR`. If you have configured `OfficeSiteId`, you can leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.local', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'UserMaxSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum storage capacity of the user\'s personal disk when allocated. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1024000', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token for the next query. If NextToken is empty, no more results exist.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', 'title' => ''], + 'NetworkPackages' => [ + 'description' => 'The list of premium Internet bandwidth plans.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the premium Internet bandwidth plan.', + 'type' => 'object', + 'properties' => [ + 'NetworkPackageId' => ['description' => 'The ID of the premium Internet bandwidth plan.', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****', 'title' => ''], + 'Bandwidth' => ['description' => 'The bandwidth of the premium Internet bandwidth plan. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'ExpiredTime' => ['description' => 'The expiration time of the premium Internet bandwidth plan.'."\n" + ."\n" + .'- If the plan uses the subscription billing method, the actual expiration time is returned.'."\n" + .'- If the plan uses the pay-as-you-go billing method, `2099-12-31T15:59:59Z` is returned.', 'type' => 'string', 'example' => '2099-12-31T15:59:59Z', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2021-05-10T02:35:26Z', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'PayType' => [ + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go.', 'PrePaid' => 'subscription.'], + 'type' => 'string', + 'example' => 'PostPaid', + 'title' => '', + ], + 'InternetChargeType' => [ + 'description' => 'The billing method of the premium Internet bandwidth plan.'."\n" + ."\n" + .'- If the parameter `PayType` is set to `PrePaid`, valid values:'."\n" + .' - PayByBandwidth: pay-by-bandwidth.'."\n" + .'- If the parameter `PayType` is set to `PostPaid`, valid values:'."\n" + .' - PayByTraffic: pay-by-data-transfer.'."\n" + .' - PayByBandwidth: pay-by-bandwidth.', + 'enumValueTitles' => ['PayByTraffic' => 'pay-by-data-transfer.', 'PayByBandwidth' => 'pay-by-bandwidth.'], + 'type' => 'string', + 'example' => 'PayByTraffic', + 'title' => '', + ], + 'ReservationInternetChargeType' => [ + 'description' => 'The billing method of the reserved network bandwidth.', + 'enumValueTitles' => ['PayByTraffic' => 'pay-by-data-transfer.', 'PayByBandwidth' => 'pay-by-bandwidth.'], + 'type' => 'string', + 'example' => 'PayByBandwidth', + 'title' => '', + ], + 'ReservationBandwidth' => ['description' => 'The peak reserved network bandwidth. Unit: Mbit/s.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'ReservationActiveTime' => ['description' => 'The effective period of the reserved network bandwidth.', 'type' => 'string', 'example' => '2021-07-10T00:00:00Z', 'title' => ''], + 'NetworkPackageStatus' => [ + 'description' => 'The status of the premium Internet bandwidth plan.', + 'enumValueTitles' => ['Creating' => 'being created.', 'Released' => 'released.', 'InUse' => 'in use.', 'Releasing' => 'being released.'], + 'type' => 'string', + 'example' => 'InUse', + 'title' => '', + ], + 'OfficeSiteName' => ['description' => 'The office network name.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'OfficeSiteVpcType' => [ + 'description' => 'The office network type.', + 'enumValueTitles' => ['standard' => 'advanced office network.', 'customized' => 'custom office network.', 'basic' => 'basic office network.'], + 'type' => 'string', + 'example' => 'basic', + 'title' => '', + ], + 'EipAddresses' => [ + 'description' => 'The public egress IP address of the premium Internet bandwidth plan.', + 'type' => 'array', + 'items' => ['description' => 'The public egress IP address of the premium Internet bandwidth plan.', 'type' => 'string', 'example' => '120.2.XX.XX', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'BusinessStatus' => [ + 'description' => 'The business status.', + 'enumValueTitles' => ['Expired' => 'expired.', 'Normal' => 'normal.'], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Tags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MaxSize', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The maximum storage capacity of the enterprise drive.'."\n" - ."\n" - .'* For a pay-as-you-go enterprise drive, the unit is bytes.'."\n" - .'* For a subscription enterprise drive, the unit is GiB. For example, to create a 500 GiB subscription drive, set the value to 500 GiB. To create a 2 TiB subscription drive, set the value to 2048 GiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '536870912000', - ], + ], + 'title' => 'Query details of premium internet bandwidth plans', + 'summary' => 'Queries the details of one or more premium Internet bandwidth plans.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-26T06:48:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-30T03:32:28.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-28T02:06:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNetworkPackages'], ], + ], + 'ramActions' => [ [ - 'name' => 'EndUserId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeNetworkPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'docRequired' => false, - 'maxItems' => 100, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"NetworkPackages\\": [\\n {\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"Bandwidth\\": 10,\\n \\"ExpiredTime\\": \\"2099-12-31T15:59:59Z\\",\\n \\"CreateTime\\": \\"2021-05-10T02:35:26Z\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"PayType\\": \\"PostPaid\\",\\n \\"InternetChargeType\\": \\"PayByTraffic\\",\\n \\"ReservationInternetChargeType\\": \\"PayByBandwidth\\",\\n \\"ReservationBandwidth\\": 20,\\n \\"ReservationActiveTime\\": \\"2021-07-10T00:00:00Z\\",\\n \\"NetworkPackageStatus\\": \\"InUse\\",\\n \\"OfficeSiteName\\": \\"default\\",\\n \\"OfficeSiteVpcType\\": \\"basic\\",\\n \\"EipAddresses\\": [\\n \\"120.2.XX.XX\\"\\n ],\\n \\"BusinessStatus\\": \\"Normal\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOfficeSites' => [ + 'summary' => 'Gets all properties of an office network, including its ID, name, status, and creation time.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '52838', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], + ], + 'parameters' => [ [ - 'name' => 'BizType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SolutionId', + 'name' => 'OfficeSiteType', 'in' => 'query', 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", + 'description' => 'The type of account for the office network.', + 'enumValueTitles' => ['SIMPLE' => 'convenience account', 'AD_CONNECTOR' => 'enterprise Active Directory (AD) account'], 'type' => 'string', 'required' => false, - 'example' => 'co-0esnf8kb8zpfbqmvt', + 'docRequired' => false, + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'CdsChargeType', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of the enterprise drive.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go.'."\n" - .'* PrePaid: subscription.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], - 'example' => 'PostPaid', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'AutoPay', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the auto-payment feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: enables the auto-payment feature. Ensure your Alibaba Cloud account has sufficient balance. Insufficient balance may result in abnormal orders.'."\n" - .'* false (default): disables the auto-payment feature. The order is generated, but payment must be made manually. You can log on to the Alibaba Cloud Management Console and complete the payment based on the order ID on the Orders page.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'AutoRenew', + 'name' => 'OfficeSiteId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Optional. Specifies whether to enable the auto-renewal feature. This parameter takes effect only if you set CdsChargeType to `Prepaid`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', + 'description' => 'The office network IDs. You can specify 1 to 100 office network IDs.', + 'type' => 'array', + 'items' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'example' => 'cn-hangzhou+dir-363353****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'Period', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The subscription duration. The unit is specified by `PeriodUnit`. This parameter takes effect only if you set `CdsChargeType` to `PrePaid`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 2'."\n" - .'* 3'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The office network status.', + 'enumValueTitles' => ['REGISTERING' => 'Registering', 'DEREGISTERING' => 'Deregistering', 'REGISTERED' => 'Registered', 'NEEDCONFIGTRUST' => 'Requires trust relationship configuration', 'CONFIGTRUSTFAILED' => 'Trust relationship configuration failed', 'DEREGISTERED' => 'Deregistered', 'ERROR' => 'Configuration error', 'CONFIGTRUSTING' => 'Configuring trust relationship', 'NEEDCONFIGUSER' => 'User configuration required'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 1 => '1', - '2', - '3', - ], - 'example' => '1', + 'example' => 'REGISTERED', + 'title' => '', ], ], [ - 'name' => 'PeriodUnit', + 'name' => 'SecurityProtection', 'in' => 'query', 'schema' => [ - 'description' => 'Required. The unit of the subscription duration. This parameter takes effect only if you set `CdsChargeType` to `PrePaid`.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Year'."\n", + 'description' => 'The security protection setting for the office network.', + 'enumValueTitles' => ['SASE' => 'SASE', 'OFF' => 'Off'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Year' => '', - ], - 'example' => 'Year', + 'example' => 'SASE', + 'title' => '', ], ], [ - 'name' => 'UserCount', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'Required. The maximum number of users allowed on the enterprise drive. This parameter takes effect only if you set `CdsChargeType` to `PrePaid`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 5 when the value of MaxSize is 500 GiB.'."\n" - .'* 20 when the value of MaxSize is 2048 GiB.'."\n" - .'* 50 when the value of MaxSize is 5120 GiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 5 => '', - 20 => '', - 50 => '', - ], - 'example' => '5', - ], + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ResellerOwnerUid', + 'name' => 'AccountType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '062B1439-709A-580E-85DF-CE97A1560565', - ], - 'CdsId' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+cds-7782057786', - ], - 'CdsName' => [ - 'description' => 'The name of the cloud disk that is created in Cloud Drive Service.'."\n", - 'type' => 'string', - 'example' => 'CDS_Windows_1126', - ], - 'MaxSize' => [ - 'description' => 'The maximum storage capacity of the enterprise drive. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '213674622976', - ], - 'OfficeSiteType' => [ - 'description' => 'The type of the office network.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience office network.'."\n" - .'* AD_CONNECTOR: enterprise AD office network.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'AD_CONNECTOR', - ], - 'CenId' => [ - 'description' => 'The ID of the CEN instance.'."\n" - ."\n" - .'> To allow end users to connect to cloud computers via virtual private clouds (VPCs), attach your office network to a CEN instance. The CEN instance connects to your on-premises network through VPN Gateway or Express Connect.'."\n", - 'type' => 'string', - 'example' => 'cen-638u3wxds9snyc****', - ], - 'DomainName' => [ - 'description' => 'The domain name of the enterprise AD office network.'."\n", - 'type' => 'string', - 'example' => 'test1.local', - ], - 'OrderId' => [ - 'description' => 'The ID of the order. You can obtain an order ID on the Orders page in the Expenses and Costs console.'."\n", - 'type' => 'string', - 'example' => '214552063030752', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'ExistConflictCds', - ], - 'ConflictCdsAndOrder' => [ - 'description' => 'The existing enterprise drive or its order that conflicts with the enterprise drive being created.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConflictCds' => [ - 'description' => 'The conflicting enterprise drive.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CdsId' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+cds-778205****', - ], - 'RegionId' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'OfficeSites' => [ + 'description' => 'A list of office networks.', + 'type' => 'array', + 'items' => [ + 'description' => 'An office network.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the office network.', + 'enumValueTitles' => ['REGISTERING' => 'Registering', 'DEREGISTERING' => 'Deregistering', 'REGISTERED' => 'Registered', 'NEEDCONFIGTRUST' => 'A trust relationship must be configured.', 'CONFIGTRUSTFAILED' => 'Failed to configure the trust relationship.', 'DEREGISTERED' => 'Deregistered', 'ERROR' => 'Error', 'CONFIGTRUSTING' => 'Configuring the trust relationship.', 'NEEDCONFIGUSER' => 'A user must be configured.'], + 'type' => 'string', + 'example' => 'REGISTERED', + 'title' => '', + ], + 'CreationTime' => ['description' => 'The time when the office network was created.', 'type' => 'string', 'example' => '2021-05-06T05:58Z', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the office network\'s Virtual Private Cloud (VPC).', 'type' => 'string', 'example' => 'vpc-uf6tz5k67puge5jn8****', 'title' => ''], + 'VpcType' => [ + 'description' => 'The VPC type.', + 'enumValueTitles' => ['Basic' => 'Basic', 'Customized' => 'Customized', 'Standard' => 'Standard'], + 'type' => 'string', + 'example' => 'Basic', + 'title' => '', + ], + 'EnableAdminAccess' => [ + 'description' => 'Specifies whether to grant local administrator permissions to users of cloud computers in the office network.', + 'enumValueTitles' => ['true' => 'Grants the local administrator permissions. This is the default value.', 'false' => 'Does not grant the local administrator permissions.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'EnableCrossDesktopAccess' => ['description' => 'Specifies whether cloud computers in the office network can access each other.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DesktopVpcEndpoint' => ['description' => 'The endpoint used to connect to cloud computers over a VPC.', 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + 'DesktopAccessType' => [ + 'description' => 'The method for connecting to cloud computers from an Elastic Desktop Service client.'."\n" + ."\n" + .'> Connections over a VPC use Alibaba Cloud PrivateLink, which is provided free of charge. The PrivateLink service is enabled when this parameter is returned as `VPC` or `Any`.', + 'enumValueTitles' => ['INTERNET' => 'Allows connections from clients only over the internet. This is the default value.', 'VPC' => 'Allows connections from clients only over the VPC.', 'ANY' => 'Allows connections over both the internet and a VPC. Users can select the connection method on their client.'], + 'type' => 'string', + 'example' => 'INTERNET', + 'title' => '', + ], + 'SsoEnabled' => ['description' => 'Specifies whether to enable single sign-on (SSO).', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CidrBlock' => ['description' => 'The IPv4 CIDR block of the office network\'s Virtual Private Cloud (VPC).', 'type' => 'string', 'example' => '47.100.XX.XX', 'title' => ''], + 'Bandwidth' => ['description' => 'The peak public bandwidth, in Mbit/s. Valid values: 0 to 1000.
A value of 0 indicates that internet access is disabled.
', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TrustPassword' => ['description' => '> This parameter is not available.', 'type' => 'string', 'example' => 'To be hidden.', 'title' => ''], + 'Name' => ['description' => 'The name of the office network. The name must be unique within the same region.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'EnableInternetAccess' => ['description' => 'Indicates whether internet access is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DomainPassword' => ['description' => 'The password of the domain administrator.', 'type' => 'string', 'example' => 'testPassword', 'title' => ''], + 'CustomSecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-bp1ce64o4g9mdf5u****', 'title' => ''], + 'OuName' => ['description' => 'The organizational unit (OU) in the Active Directory (AD) domain.', 'type' => 'string', 'example' => 'example.com/Domain Controllers', 'title' => ''], + 'DomainUserName' => ['description' => 'The username of the domain administrator.', 'type' => 'string', 'example' => 'Administrator', 'title' => ''], + 'SubDomainName' => ['description' => 'The name of the Active Directory (AD) subdomain.', 'type' => 'string', 'example' => 'testSubDnsUserName', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'CenId' => ['description' => 'The ID of the Cloud Enterprise Network (CEN) instance.', 'type' => 'string', 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], + 'CenAttachStatus' => ['description' => 'The attachment status of the Cloud Enterprise Network (CEN) instance.', 'type' => 'string', 'example' => 'attached', 'title' => ''], + 'MfaEnabled' => ['description' => 'Indicates whether multi-factor authentication (MFA) is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'NetworkPackageId' => ['description' => 'The ID of the premium bandwidth plan.', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****', 'title' => ''], + 'DnsUserName' => ['description' => 'The DNS username.', 'type' => 'string', 'example' => 'testDnsUserName ', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The account type of the office network.', + 'enumValueTitles' => ['SIMPLE' => 'Convenience account', 'AD_CONNECTOR' => 'Enterprise AD account'], + 'type' => 'string', + 'example' => 'AD_CONNECTOR', + 'title' => '', + ], + 'ADConnectors' => [ + 'description' => 'A list of AD connectors.', + 'type' => 'array', + 'items' => [ + 'description' => 'An AD connector.', + 'type' => 'object', + 'properties' => [ + 'ConnectorStatus' => [ + 'description' => 'The status of the AD connector.', + 'enumValueTitles' => ['CONNECT_ERROR' => 'Connection error', 'RUNNING' => 'Running', 'CONNECTING' => 'Connecting. AD domain configuration is pending.', 'EXPIRED' => 'Expired due to overdue payments', 'CREATING' => 'Creating'], + 'type' => 'string', + 'example' => 'RUNNING', + 'title' => '', + ], + 'VSwitchId' => ['description' => 'The ID of the vSwitch that corresponds to the network of the AD connector.', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****', 'title' => ''], + 'ADConnectorAddress' => ['description' => 'The connection address of the AD connector.', 'type' => 'string', 'example' => '172.24.*.*', 'title' => ''], + 'TrustKey' => ['description' => 'The trust password that is configured when you set up an AD trust relationship.', 'type' => 'string', 'example' => 'password123***', 'title' => ''], + 'NetworkInterfaceId' => ['description' => 'The ID of the elastic network interface (ENI) to which the AD connector is attached.', 'type' => 'string', 'example' => 'eni-bp1i4wx78lgosrj6****', 'title' => ''], + 'Specification' => [ + 'description' => 'The specification of the AD connector.', + 'enumValueTitles' => [1 => 'General', 'Advanced'], + 'type' => 'string', + 'example' => '1', + 'title' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'ConflictOrder' => [ - 'description' => 'The subscription orders of the conflicting enterprise drives that are unpaid.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CdsId' => [ - 'description' => 'The ID of the enterprise drive. The enterprise drive cannot be used if the order is unpaid.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+cds-778205****', - ], - 'OrderId' => [ - 'description' => 'The ID of the order. You can obtain an order ID on the **Orders** page in the Expenses and Costs console.'."\n", - 'type' => 'string', - 'example' => '22442411898****', + 'Logs' => [ + 'description' => 'The registration logs.', + 'type' => 'array', + 'items' => [ + 'description' => 'A registration log entry.', + 'type' => 'object', + 'properties' => [ + 'Step' => ['description' => 'The registration step.', 'type' => 'string', 'example' => 'CREATE_CONNECTOR', 'title' => ''], + 'Message' => ['description' => 'The log message.', 'type' => 'string', 'example' => 'code:success | message:Create Connector complete', 'title' => ''], + 'TimeStamp' => ['description' => 'The timestamp of the log entry.', 'type' => 'string', 'example' => '2021-05-12T09:42Z', 'title' => ''], + 'Level' => [ + 'description' => 'The log level.', + 'enumValueTitles' => ['ERROR' => 'Error', 'INFO' => 'Info', 'WARN' => 'Warn'], + 'type' => 'string', + 'example' => 'INFO', + 'title' => '', + ], ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'VSwitchIds' => [ + 'description' => 'The vSwitch IDs.', + 'type' => 'array', + 'items' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FileSystemIds' => [ + 'description' => 'The IDs of Apsara File Storage for NAS file systems.', + 'type' => 'array', + 'items' => ['description' => 'The NAS file system ID.', 'type' => 'string', 'example' => '["05b534****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SubDnsAddress' => [ + 'description' => 'The DNS addresses of the AD subdomains.', + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the AD subdomain.', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DnsAddress' => [ + 'description' => 'The DNS addresses of the AD domain.', + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the AD domain.', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'CustomDnsAddress' => [ + 'description' => 'The custom DNS addresses.', + 'type' => 'array', + 'items' => ['description' => 'The custom DNS address.', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'NeedVerifyLoginRisk' => ['description' => 'Indicates whether risk-based verification is enabled for user logon. This feature applies only to office networks that use convenience accounts. If enabled, the system checks for security risks during logon. If a risk is detected, the user must enter a verification code sent to their email address to complete the logon process.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DesktopCount' => ['description' => 'The number of individually provisioned cloud computers.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'TotalEdsCount' => ['description' => 'The total number of cloud computers in the office network, including individual and shared computers.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'TotalEdsCountForGroup' => ['description' => 'The number of shared cloud computers.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NeedVerifyZeroDevice' => [ + 'description' => 'Specifies whether to enable trusted device verification.', + 'enumValueTitles' => ['true' => 'Enabled', 'false' => 'Disabled'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'CloudBoxOfficeSite' => [ + 'description' => 'Specifies whether the office network is a CloudBox-based office network.', + 'enumValueTitles' => ['true' => 'The office network is a CloudBox-based office network.', 'false' => 'The office network is deployed in the public cloud.'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'SsoType' => [ + 'description' => 'The single sign-on (SSO) type.', + 'enumValueTitles' => ['SAML' => 'SAML'], + 'type' => 'string', + 'example' => 'SAML', + 'title' => '', + ], + 'ProtocolType' => [ + 'description' => 'The streaming protocol.', + 'enumValueTitles' => ['HDX' => 'High-Definition Experience (HDX) protocol', 'ASP' => 'Alibaba Cloud proprietary Adaptive Streaming Protocol (ASP)'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'AdHostname' => ['description' => 'The hostname of the domain controller.'."\n" + .'The hostname must comply with the Windows hostname naming conventions.', 'type' => 'string', 'example' => 'beijing-ad01', 'title' => ''], + 'RdsLicenseStatus' => ['description' => 'The status of the Remote Desktop Services (RDS) license.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'RdsLicenseAddress' => ['description' => 'The IP address of the RDS license server.', 'type' => 'string', 'example' => '47.100.XX.XX', 'title' => ''], + 'RdsLicenseDomainName' => ['description' => 'The domain name of the RDS license server.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'BackupDns' => ['description' => 'The DNS address of the backup domain controller.', 'type' => 'string', 'example' => '172.24.XX.XX', 'title' => ''], + 'BackupDCHostname' => ['description' => 'The hostname of the backup domain controller.', 'type' => 'string', 'example' => 'beijing-ad02', 'title' => ''], + 'EnableServiceRoute' => ['description' => 'Specifies whether to enable access control for cloud service routing.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SubnetMode' => [ + 'description' => 'The subnet mode of the office network.', + 'enumValueTitles' => ['The subnet follows the office network mode.', 'The subnet is in semi-managed mode.'], + 'type' => 'string', + 'example' => '0', + 'title' => '', + ], + 'SecurityProtection' => [ + 'description' => 'The security protection configuration for the office network.', + 'enumValueTitles' => ['SASE' => 'SASE', 'OFF' => 'Off'], + 'type' => 'string', + 'example' => 'SASE', + 'title' => '', + ], + 'CustomAccessPoint' => ['description' => 'The address of the custom access gateway.', 'type' => 'string', 'example' => 'gw-****.com', 'title' => ''], + 'ResourceAmounts' => [ + 'description' => 'A list of resource quantities.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'resourceType' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['desktop' => 'A cloud computer.', 'desktopGroup' => 'A desktop group.'], + 'type' => 'string', + 'example' => 'desktop', + 'title' => '', + ], + 'amount' => ['description' => 'The number of resources of this type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], - ], + 'TotalResourceAmount' => ['description' => 'The total number of resources, including cloud computers and shared cloud computers.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NmVersion' => [ + 'description' => 'The network version. The new version supports products such as App Streaming.', + 'enumValueTitles' => ['DEFAULT' => 'Old version', 'NM' => 'New version'], + 'type' => 'string', + 'example' => 'NM', + 'title' => '', + ], + 'AcceleratorId' => ['description' => 'The ID of the Global Accelerator (GA) instance.', 'type' => 'string', 'example' => 'ga-bp1astu3yrplkzoo2****', 'title' => ''], + 'LdapUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'IsLdap' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'DomainName' => ['description' => 'The domain name of the enterprise AD.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'AccountType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AuthorityHost' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'VplVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientSecret' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Eid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AccessAttribute' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A156****\\",\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"CdsName\\": \\"CDS_Windows_1126\\",\\n \\"MaxSize\\": \\"5368709120\\",\\n \\"OfficeSiteType\\": \\"AD_CONNECTOR\\",\\n \\"CenId\\": \\"cen-638u3wxds9snyc****\\",\\n \\"DomainName\\": \\"test1.local\\",\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"ErrorCode\\": \\"ExistConflictCds\\",\\n \\"ConflictCdsAndOrder\\": {\\n \\"ConflictCds\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConflictOrder\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"OrderId\\": \\"22442411898****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'CreateCloudDriveService', - 'description' => 'Before you call this operation, make sure that you understand the billing methods and pricing of Enterprise Drive Service (formerly Cloud Drive Service). For more information, see [Overview](~~386301~~).'."\n", - ], - 'DescribeCloudDiskGroupDrives' => [ - 'summary' => 'Queries team spaces in a cloud disk.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'title' => 'DescribeOfficeSites', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-23T02:19:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-07-07T09:58:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-10T02:56:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-20T07:27:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-06T03:14:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-23T08:47:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-05T02:52:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-10T12:27:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-06-01T13:41:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-29T06:51:17.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-12T03:55:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-13T08:13:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-19T03:15:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOfficeSites'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeOfficeSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"OfficeSites\\": [\\n {\\n \\"Status\\": \\"REGISTERED\\",\\n \\"CreationTime\\": \\"2021-05-06T05:58Z\\",\\n \\"VpcId\\": \\"vpc-uf6tz5k67puge5jn8****\\",\\n \\"VpcType\\": \\"Basic\\",\\n \\"EnableAdminAccess\\": true,\\n \\"EnableCrossDesktopAccess\\": false,\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"SsoEnabled\\": false,\\n \\"CidrBlock\\": \\"47.100.XX.XX\\",\\n \\"Bandwidth\\": 10,\\n \\"TrustPassword\\": \\"To be hidden.\\",\\n \\"Name\\": \\"test\\",\\n \\"EnableInternetAccess\\": false,\\n \\"DomainPassword\\": \\"testPassword\\",\\n \\"CustomSecurityGroupId\\": \\"sg-bp1ce64o4g9mdf5u****\\",\\n \\"OuName\\": \\"example.com/Domain Controllers\\",\\n \\"DomainUserName\\": \\"Administrator\\",\\n \\"SubDomainName\\": \\"testSubDnsUserName\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"CenId\\": \\"cen-3gwy16dojz1m65****\\",\\n \\"CenAttachStatus\\": \\"attached\\",\\n \\"MfaEnabled\\": false,\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"DnsUserName\\": \\"testDnsUserName\\\\t\\",\\n \\"OfficeSiteType\\": \\"AD_CONNECTOR\\",\\n \\"ADConnectors\\": [\\n {\\n \\"ConnectorStatus\\": \\"RUNNING\\",\\n \\"VSwitchId\\": \\"vsw-bp19ocz3erfx15uon****\\",\\n \\"ADConnectorAddress\\": \\"172.24.*.*\\",\\n \\"TrustKey\\": \\"password123***\\",\\n \\"NetworkInterfaceId\\": \\"eni-bp1i4wx78lgosrj6****\\",\\n \\"Specification\\": \\"1\\"\\n }\\n ],\\n \\"Logs\\": [\\n {\\n \\"Step\\": \\"CREATE_CONNECTOR\\",\\n \\"Message\\": \\"code:success | message:Create Connector complete\\",\\n \\"TimeStamp\\": \\"2021-05-12T09:42Z\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp19ocz3erfx15uon****\\"\\n ],\\n \\"FileSystemIds\\": [\\n \\"[\\\\\\"05b534****\\\\\\"]\\"\\n ],\\n \\"SubDnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"DnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"CustomDnsAddress\\": [\\n \\" [\\\\\\"172.24.XX.XX\\\\\\"]\\"\\n ],\\n \\"NeedVerifyLoginRisk\\": false,\\n \\"DesktopCount\\": 1,\\n \\"TotalEdsCount\\": 0,\\n \\"TotalEdsCountForGroup\\": 0,\\n \\"NeedVerifyZeroDevice\\": true,\\n \\"CloudBoxOfficeSite\\": true,\\n \\"SsoType\\": \\"SAML\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"AdHostname\\": \\"beijing-ad01\\",\\n \\"RdsLicenseStatus\\": \\"2\\",\\n \\"RdsLicenseAddress\\": \\"47.100.XX.XX\\",\\n \\"RdsLicenseDomainName\\": \\"example.com\\",\\n \\"BackupDns\\": \\"172.24.XX.XX\\",\\n \\"BackupDCHostname\\": \\"beijing-ad02\\",\\n \\"EnableServiceRoute\\": false,\\n \\"SubnetMode\\": \\"0\\",\\n \\"SecurityProtection\\": \\"SASE\\",\\n \\"CustomAccessPoint\\": \\"gw-****.com\\",\\n \\"ResourceAmounts\\": [\\n {\\n \\"resourceType\\": \\"desktop\\",\\n \\"amount\\": 1\\n }\\n ],\\n \\"TotalResourceAmount\\": 1,\\n \\"NmVersion\\": \\"NM\\",\\n \\"AcceleratorId\\": \\"ga-bp1astu3yrplkzoo2****\\",\\n \\"LdapUrl\\": \\"\\",\\n \\"IsLdap\\": false,\\n \\"DomainName\\": \\"example.com\\",\\n \\"AccountType\\": \\"\\",\\n \\"AuthorityHost\\": \\"\\",\\n \\"TenantId\\": \\"\\",\\n \\"ClientId\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"VplVersion\\": \\"\\",\\n \\"ClientSecret\\": \\"\\",\\n \\"Eid\\": \\"\\",\\n \\"AccessAttribute\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeOnlineUserCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'CdsId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-6805637***', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the region to search. This filters the results to show only resources from the specified region.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - ], + 'schema' => ['description' => 'The office site ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai+dir-631324****', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'BizType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MTA0MjA=', - ], + 'schema' => ['description' => '> This parameter is for internal use only.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -24051,779 +21380,1237 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'MTA0MjA=', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B9F9CBBE-8A9F-5FE5-8A72-0E81C2401A91', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'CloudDriveGroups' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1', - ], - 'GroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cg-e70ga4ixp30ur****', - ], - 'GroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'DirectoryId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-959593****', - ], - 'DriveId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-04-11T07:44:21Z', - ], - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5368709120', - ], - 'UsedSize' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1024000000', - ], - 'OrgId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'org-aliyun-wy-org-id', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], + 'AssignedUserCount' => ['description' => 'The number of users who have been assigned a cloud desktop.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'OnlineUserCount' => ['description' => 'The number of online users. Online users include convenience users and AD users.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AdAssignedUserCount' => ['description' => 'The number of AD users who have been assigned a cloud desktop.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'SimpleAssignedUserCount' => ['description' => 'The number of convenience users who have been assigned a cloud desktop.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"MTA0MjA=\\",\\n \\"RequestId\\": \\"B9F9CBBE-8A9F-5FE5-8A72-0E81C2401A91\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"测试团队1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCloudDiskGroupDrives', - ], - 'DescribeCloudDiskGroups' => [ - 'summary' => 'Queries team spaces from the drive.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'DescribeOnlineUserCount', + 'summary' => 'Queries metrics such as the online user count and the assigned user count.', + 'description' => 'Before you call this operation, make sure that you are familiar with the resource types and product types of Elastic Desktop Service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"AssignedUserCount\\": 10,\\n \\"OnlineUserCount\\": 1,\\n \\"AdAssignedUserCount\\": 2,\\n \\"SimpleAssignedUserCount\\": 8\\n}","type":"json"}]', + ], + 'DescribePolicyGroups' => [ + 'summary' => 'Retrieves the details of a cloud computer policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '52839', + 'abilityTreeNodes' => ['FEATUREgwsN6S2WW'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~DescribeRegions~~) to query the regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-0456357992', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'- Maximum value: 100'."\n" + ."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Set this parameter to the NextToken value returned in the previous response. Do not set this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'description' => 'The list of cloud computer policy IDs.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], + 'items' => ['description' => 'The cloud computer policy ID.', 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy', 'title' => ''], 'required' => false, - 'docRequired' => false, + 'example' => 'system-all-enabled-policy', 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'GroupName', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The effective scope of the cloud computer policy.', + 'enumValueTitles' => ['ALL' => 'All policies', 'IP' => 'Effective based on IP address', 'GLOBAL' => 'Globally effective \\[default]'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '', + 'example' => 'GLOBAL', + 'title' => '', ], ], [ - 'name' => 'ParentOrgId', + 'name' => 'ExternalPolicyGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The list of cloud computer policy IDs to exclude from the query results.', + 'type' => 'array', + 'items' => ['description' => 'The cloud computer policy ID to exclude from the query results.', 'type' => 'string', 'required' => false, 'example' => 'pg-0cid8v30p16k4****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'root', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'A collection of the returned information.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D648DBF7-9476-53D6-98AB-674836021DFB', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'True', - ], - 'CloudDriveGroups' => [ - 'description' => '', + 'NextToken' => ['description' => 'The pagination token for the next query. If NextToken is empty, no further pages exist.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', 'title' => ''], + 'Count' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DescribePolicyGroups' => [ + 'description' => 'The detailed information about the cloud computer policies.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The detailed information about the cloud computer policies.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '', + 'PolicyStatus' => [ + 'description' => 'The status of the cloud computer policy.', + 'enumValueTitles' => ['AVAILABLE' => 'Active', 'CREATING' => 'Creating'], 'type' => 'string', - 'example' => '1', + 'example' => 'AVAILABLE', + 'title' => '', ], - 'GroupId' => [ - 'description' => '', + 'Html5Access' => [ + 'description' => 'The web client access policy.', + 'enumValueTitles' => ['off' => 'Disabled \\[default]', 'on' => 'Enabled'], 'type' => 'string', - 'example' => 'cg-e70ga4ixp30ur****', + 'example' => 'off', + 'title' => '', ], - 'GroupName' => [ - 'description' => '', + 'WatermarkType' => [ + 'description' => 'The watermark type.', + 'enumValueTitles' => ['EndUserId' => 'Username', 'Custom' => 'Custom text', 'DesktopIp' => 'Cloud computer IP address', 'ClientIp' => 'Client IP address', 'HostName' => 'Last 15 digits of the cloud computer ID', 'ClientTime' => 'Current time on the cloud computer'], 'type' => 'string', - 'example' => '', + 'example' => 'EndUserId', + 'title' => '', ], - 'DirectoryId' => [ - 'description' => '', + 'PreemptLogin' => [ + 'description' => 'The cloud computer preemption policy.'."\n" + ."\n" + .'> To ensure user experience and data security for end users currently using a cloud computer, mutual preemption between multiple users is not allowed. This parameter defaults to `off` and cannot be modified.', + 'enumValueTitles' => ['off' => 'Preemption disabled'], 'type' => 'string', - 'example' => 'cn-hangzhou+dir-959593****', + 'example' => 'off', + 'title' => '', ], - 'DriveId' => [ - 'description' => '', + 'WatermarkCustomText' => ['description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.', 'type' => 'string', 'example' => 'custom-watermark', 'title' => ''], + 'Clipboard' => [ + 'description' => 'The clipboard permissions.', + 'enumValueTitles' => ['read' => 'One-way allowed. You can copy local content to the cloud computer but cannot copy cloud computer content to the local device.', 'readwrite' => 'Two-way allowed. You can copy content between the local device and the cloud computer.', 'write' => 'One-way allowed. You can copy cloud computer content to the local device but cannot copy local content to the cloud computer.', 'off' => 'Two-way disabled. No copying is allowed between the cloud computer and the local device. \\[default]'], 'type' => 'string', - 'example' => '1234', + 'example' => 'off', + 'title' => '', ], - 'CreateTime' => [ - 'description' => '', + 'PolicyGroupId' => ['description' => 'The cloud computer policy ID.', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'PrinterRedirection' => [ + 'description' => 'The printer redirection policy.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'example' => '2022-04-11T07:44:21Z', + 'example' => 'on', + 'title' => '', ], - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5368709120', + 'WatermarkTransparency' => [ + 'description' => 'The watermark transparency level.', + 'enumValueTitles' => ['LIGHT' => 'Light', 'DARK' => 'Dark', 'MIDDLE' => 'Medium'], + 'type' => 'string', + 'example' => 'LIGHT', + 'title' => '', ], - 'UsedSize' => [ - 'description' => '', + 'Html5FileTransfer' => [ + 'description' => 'The file transfer policy for the web client.', + 'enumValueTitles' => ['all' => 'Upload and download allowed', 'download' => 'Download allowed', 'upload' => 'Upload allowed', 'off' => 'Disabled \\[default]'], 'type' => 'string', - 'example' => '1024000000', + 'example' => 'off', + 'title' => '', ], - 'OrgId' => [ - 'description' => '', + 'UsbRedirect' => [ + 'description' => 'USB redirection.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'example' => 'org-aliyun-wy-org-id', + 'example' => 'on', + 'title' => '', ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"D648DBF7-9476-53D6-98AB-674836021DFB\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"测试团队1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCloudDiskGroups', - ], - 'CreateCloudDriveGroup' => [ - 'summary' => 'Authorizes a user to use a team space.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'CdsId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-532033****', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7f4bbccda0cf40bb85981b65fb5e****', - 'minLength' => 0, - ], - ], - [ - 'name' => 'TotalSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the cloud disk in Cloud Drive Service. Unit: bytes. The size is unlimited.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1024000', - ], - ], - [ - 'name' => 'AdminUserIds', - 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'FD14D2A1-CC39-5ED3-8EE7-11FDF4B9D6D2', - ], - 'Code' => [ - 'description' => 'The returned results. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the call is successful. true: The call is successful. false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD14D2A1-CC39-5ED3-8EE7-11FDF4B9D6D2\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateCloudDriveGroup', - 'description' => 'The list of teams of a cloud disk in Cloud Drive Service is synchronized from the Organization tab in the Elastic Desktop Service (EDS) console. You can choose Users > Manager User > User > Organization in the console. If you want to authorize a user to use a team space, you must move the user to the corresponding organization. After you move the user, the user can view the menu bar of the team space on a Cloud Drive Service client.'."\n", - ], - 'DescribeCloudDriveGroups' => [ - 'summary' => 'Queries the list and basic information of all team shared disks in an enterprise drive.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'list', - ], + 'PolicyGroupType' => [ + 'description' => 'The cloud computer policy type.', + 'enumValueTitles' => ['SYSTEM' => 'System policy', 'CUSTOM' => 'Custom policy'], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', + ], + 'Watermark' => [ + 'description' => 'Watermark.', + 'enumValueTitles' => ['blind' => 'Blind watermark enabled', 'off' => 'Watermark disabled', 'on' => 'Visible watermark enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'VisualQuality' => [ + 'description' => 'The image display quality policy.', + 'enumValueTitles' => ['high' => 'High definition', 'low' => 'Smooth', 'medium' => 'Automatic rotation \\[default]', 'lossless' => 'Lossless'], + 'type' => 'string', + 'example' => 'medium', + 'title' => '', + ], + 'EdsCount' => ['description' => 'The total number of cloud computers and cloud computer pools associated with this policy. This value is returned only for custom policies.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Name' => ['description' => 'The cloud computer policy name.', 'type' => 'string', 'example' => 'testPolicyGroupName', 'title' => ''], + 'LocalDrive' => [ + 'description' => 'The local disk mapping permissions.', + 'enumValueTitles' => ['read' => 'Read-only. Local disk mapping is available on the cloud computer, but you can only read (copy) local files and cannot modify them.', 'readwrite' => 'Read and write. Local disk mapping is available on the cloud computer, and you can read (copy) and modify local files.', 'off' => 'Disabled. No local disk mapping is available on the cloud computer. \\[default]'], + 'type' => 'string', + 'example' => 'readwrite', + 'title' => '', + ], + 'AuthorizeSecurityPolicyRules' => [ + 'description' => 'The security group control rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The security group control rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The rule direction of the security group control rule.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], + 'type' => 'string', + 'example' => 'inflow', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'The authorization policy of the security group control rule.', + 'enumValueTitles' => ['drop' => 'Deny policy. Denies all access requests.', 'accept' => 'Allow policy. Accepts all access requests.'], + 'type' => 'string', + 'example' => 'accept', + 'title' => '', + ], + 'Description' => ['description' => 'The description of the security group control rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'PortRange' => ['description' => 'The port range of the security group control rule.', 'type' => 'string', 'example' => '22/22', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'The protocol type of the security group control rule.', + 'enumValueTitles' => ['tcp' => 'TCP protocol', 'udp' => 'UDP protocol', 'all' => 'All protocols', 'gre' => 'GRE protocol', 'icmp' => 'ICMP (IPv4) protocol'], + 'type' => 'string', + 'example' => 'tcp', + 'title' => '', + ], + 'Priority' => ['description' => 'The priority of the security group control rule. A smaller number indicates a higher priority.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'The target of the security group control rule. The value is an IPv4 CIDR block.', 'type' => 'string', 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AuthorizeAccessPolicyRules' => [ + 'description' => 'The client IP address whitelist. Only IP addresses within the whitelisted CIDR blocks can access the cloud computer.', + 'type' => 'array', + 'items' => [ + 'description' => 'The client IP address whitelist entry.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The remarks for the client-accessible CIDR block.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'The client-accessible IP address segment. The value is an IPv4 CIDR block.', 'type' => 'string', 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ClientTypes' => [ + 'description' => 'The logon method control list. Controls which clients can access the cloud computer.', + 'type' => 'array', + 'items' => [ + 'description' => 'The logon method control rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Whether a specific client type is allowed to connect to the cloud computer.', + 'enumValueTitles' => ['OFF' => 'Not allowed', 'ON' => 'Allowed'], + 'type' => 'string', + 'example' => 'ON', + 'title' => '', + ], + 'ClientType' => [ + 'description' => 'The client type.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'windows' => 'Windows client', 'ios' => 'iOS client', 'macos' => 'macOS client'], + 'type' => 'string', + 'example' => 'windows', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'PreemptLoginUsers' => [ + 'description' => 'The usernames of users who can preempt the cloud computer.', + 'type' => 'array', + 'items' => ['description' => 'The username of a user who can preempt the cloud computer.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'GpuAcceleration' => [ + 'description' => 'Whether to enable the image quality policy for graphics-specification cloud computers. Enable this policy if you have high requirements for cloud computer performance and user experience, such as in professional design scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'UsbSupplyRedirectRule' => [ + 'description' => 'The USB redirection rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The USB redirection rule.', + 'type' => 'object', + 'properties' => [ + 'VendorId' => ['description' => 'The vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'example' => '04**', 'title' => ''], + 'ProductId' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '08**', 'title' => ''], + 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'example' => 'Test rule', 'title' => ''], + 'UsbRedirectType' => [ + 'description' => 'The USB redirection type.', + 'enumValueTitles' => [1 => 'Allow', 'Deny'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'DeviceClass' => ['description' => 'The device class. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'example' => '0Eh', 'title' => ''], + 'DeviceSubclass' => ['description' => 'The device subclass. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'example' => 'xxh', 'title' => ''], + 'UsbRuleType' => [ + 'description' => 'The USB redirection rule type.', + 'enumValueTitles' => [1 => 'Device class', 'Device vendor'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DomainResolveRuleType' => [ + 'description' => 'The domain name resolution policy switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'DomainResolveRule' => [ + 'description' => 'The domain name resolution policy list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The domain name resolution policy details.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'example' => '*.example.com', 'title' => ''], + 'Policy' => [ + 'description' => 'The resolution policy.', + 'enumValueTitles' => ['allow' => 'Allow', 'block' => 'Deny'], + 'type' => 'string', + 'example' => 'allow', + 'title' => '', + ], + 'Description' => ['description' => 'The policy description.', 'type' => 'string', 'example' => '测试规则', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NetRedirectRule' => [ + 'description' => 'The network redirection policy list.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', + 'type' => 'array', + 'items' => [ + 'description' => 'The network redirection policy details.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The policy content.', 'type' => 'string', 'example' => '*.example.com', 'title' => ''], + 'RuleType' => [ + 'description' => 'The policy type.', + 'enumValueTitles' => ['prc' => 'Process', 'domain' => 'Domain name'], + 'type' => 'string', + 'example' => 'domain', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'The policy type.', + 'enumValueTitles' => ['allow' => 'Allow', 'block' => 'Deny'], + 'type' => 'string', + 'example' => 'allow', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Recording' => [ + 'description' => 'Whether to enable screen recording.', + 'enumValueTitles' => ['byaction_cmd_ft' => 'User operation-triggered screen recording (triggered when executing commands and transferring files)', 'ALLTIME' => 'Full-session screen recording (from connection to disconnection)', 'PERIOD' => 'Interval-based screen recording (requires setting start and end times)', 'byaction_commands' => 'User operation-triggered screen recording (triggered only when executing commands)', 'OFF' => 'Screen recording disabled', 'byaction_file_transfer' => 'User operation-triggered screen recording (triggered only when transferring files)'], + 'type' => 'string', + 'example' => 'OFF', + 'title' => '', + ], + 'RecordingStartTime' => ['description' => 'The screen recording start time in HH:MM:SS format. This parameter takes effect only when Recording is set to PERIOD.', 'type' => 'string', 'example' => '08:00:00', 'title' => ''], + 'RecordingEndTime' => ['description' => 'The screen recording end time in HH:MM:SS format. This parameter takes effect only when Recording is set to PERIOD.', 'type' => 'string', 'example' => '08:59:00', 'title' => ''], + 'RecordingFps' => [ + 'description' => 'The screen recording frame rate. Unit: FPS (frames per second).', + 'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + 'title' => '', + ], + 'RecordingExpires' => ['description' => 'The retention period for screen recording files. Valid values: 1 to 180 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'CameraRedirect' => [ + 'description' => 'Whether to enable local camera redirection.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled \\[default]'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'NetRedirect' => [ + 'description' => 'Network redirection.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', + 'enumValueTitles' => ['off' => 'Disabled \\[default]', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'AppContentProtection' => [ + 'description' => 'Whether to enable the anti-screenshot feature.', + 'enumValueTitles' => ['off' => 'Disabled \\[default]', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'RecordContent' => [ + 'description' => 'Whether to enable custom screen recording.', + 'enumValueTitles' => ['off' => 'Disabled \\[default]', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'RecordContentExpires' => ['description' => 'The expiration time for custom screen recording files. Default value: 30 days.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'RemoteCoordinate' => [ + 'description' => 'The keyboard and mouse control permissions during remote assistance.', + 'enumValueTitles' => ['optionalControl' => 'Disabled by default. Click to request keyboard and mouse control permissions.', 'fullControl' => 'Full control', 'disableControl' => 'No control'], + 'type' => 'string', + 'example' => 'fullControl', + 'title' => '', + ], + 'RecordingDuration' => [ + 'description' => 'The screen recording file viewing duration in minutes. Recording files are automatically split based on this duration and uploaded to the bucket. When a file reaches 300 MB, it is preferentially rolled over.', + 'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + 'title' => '', + ], + 'Scope' => [ + 'description' => 'The effective scope of the policy.', + 'enumValueTitles' => ['IP' => 'Effective based on IP address', 'GLOBAL' => 'Globally effective'], + 'type' => 'string', + 'example' => 'GLOBAL', + 'title' => '', + ], + 'ScopeValue' => [ + 'description' => 'Specify this parameter when `Scope` is set to `IP`. This parameter takes effect only when `Scope` is set to `IP`.', + 'type' => 'array', + 'items' => ['description' => 'The effective CIDR block.', 'type' => 'string', 'example' => '47.100.XX.XX/24', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RecordingAudio' => [ + 'description' => 'The option to record audio from the cloud computer.', + 'enumValueTitles' => ['off' => 'Record video only, not audio \\[default]', 'on' => 'Enable audio recording'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'InternetCommunicationProtocol' => [ + 'description' => 'The network communication protocol.', + 'enumValueTitles' => ['TCP' => 'TCP only \\[default]', 'BOTH' => 'Automatically switch between TCP and UDP'], + 'type' => 'string', + 'example' => 'BOTH', + 'title' => '', + ], + 'VideoRedirect' => [ + 'description' => 'Multimedia redirection.', + 'enumValueTitles' => ['off' => 'Media redirection disabled', 'on' => 'Media redirection enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'WatermarkTransparencyValue' => ['description' => 'The watermark transparency. A higher value means lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'WatermarkColor' => ['description' => 'The watermark font color in RGB format. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WatermarkFontSize' => ['description' => 'The watermark font size. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'WatermarkFontStyle' => [ + 'description' => 'The watermark font style.', + 'enumValueTitles' => ['plain' => 'Plain', 'bold' => 'Bold'], + 'type' => 'string', + 'example' => 'plain', + 'title' => '', + ], + 'WatermarkDegree' => ['description' => 'The watermark tilt angle. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'example' => '-10', 'title' => ''], + 'WatermarkRowAmount' => ['description' => 'The number of watermark rows.'."\n" + ."\n" + .'> This parameter is not publicly available.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'EndUserApplyAdminCoordinate' => [ + 'description' => 'The switch for users to request administrator assistance.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'EndUserGroupCoordinate' => [ + 'description' => 'The switch for stream collaboration between users.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'CpuProtectedMode' => [ + 'description' => 'The CPU protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'CpuRateLimit' => ['description' => 'The overall CPU usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'CpuSampleDuration' => ['description' => 'The overall CPU sampling duration in seconds. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CpuSingleRateLimit' => ['description' => 'The single-core CPU usage percentage. Valid values: 70 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'CpuDownGradeDuration' => ['description' => 'The CPU downclocking duration in seconds. Valid values: 30 to 120.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'CpuProcessors' => [ + 'description' => 'The process whitelist exempt from CPU usage limits.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'chrome.exe', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'MemoryProtectedMode' => [ + 'description' => 'The memory protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'MemoryRateLimit' => ['description' => 'The overall memory usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], + 'MemorySampleDuration' => ['description' => 'The overall memory sampling duration in seconds. Valid values: 30 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemorySingleRateLimit' => ['description' => 'The memory usage percentage per worker. Valid values: 30 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemoryDownGradeDuration' => ['description' => 'The memory downclocking duration per process in seconds. Valid values: 30 to 120.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'MemoryProcessors' => [ + 'description' => 'The process whitelist exempt from memory usage limits.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'notepad.exe', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WatermarkSecurity' => [ + 'description' => 'The blind watermark security priority rule.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'WatermarkAntiCam' => [ + 'description' => 'The blind watermark anti-photo feature.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'WatermarkPower' => [ + 'description' => 'The blind watermark enhancement feature.', + 'enumValueTitles' => ['high' => 'High', 'low' => 'Low', 'medium' => 'Medium'], + 'type' => 'string', + 'example' => 'medium', + 'title' => '', + ], + 'RecordingUserNotify' => [ + 'description' => 'The screen recording client notification feature.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'RecordingUserNotifyMessage' => ['description' => 'The screen recording client notification message. Leave empty by default.', 'type' => 'string', 'example' => 'Your cloud desktop is being recorded.', 'title' => ''], + 'AdminAccess' => ['description' => 'Whether end users have administrative permission after connecting to the cloud computer.'."\n" + ."\n" + .'> This feature is in invitational preview and is not publicly available.', 'type' => 'string', 'example' => 'deny', 'title' => ''], + 'MaxReconnectTime' => ['description' => 'The maximum retry time for reconnecting to the cloud computer after a disconnection caused by objective reasons. Valid values: 30 to 7200 seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], + 'DisplayMode' => [ + 'description' => 'The display mode.', + 'enumValueTitles' => ['clientCustom' => 'User self-configuration', 'adminOffice' => 'Daily office scenario', 'adminDesign' => '3D application scenario', 'adminCustom' => 'Administrator-defined parameters'], + 'type' => 'string', + 'example' => 'adminCustom', + 'title' => '', + ], + 'StreamingMode' => [ + 'description' => 'The streaming mode adaptation scenario.', + 'enumValueTitles' => ['intelligent' => 'Daily office scenario (intelligent mode)', 'smooth' => 'Design and 3D application scenario (smooth priority)'], + 'type' => 'string', + 'example' => 'smooth', + 'title' => '', + ], + 'ColorEnhancement' => [ + 'description' => 'Whether to enable color enhancement for design and 3D application scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'SmoothEnhancement' => [ + 'description' => 'Whether to enable smoothness enhancement for daily office scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'QualityEnhancement' => [ + 'description' => 'Whether to enable image quality enhancement for design and 3D application scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'VideoEncPolicy' => [ + 'description' => 'The video encoding policy.', + 'enumValueTitles' => ['qualityFirst' => 'Image quality priority', 'bandwidthFirst' => 'Bitrate policy priority'], + 'type' => 'string', + 'example' => 'qualityFirst', + 'title' => '', + ], + 'TargetFps' => ['description' => 'The target frame rate. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'VideoEncMinQP' => ['description' => 'The minimum quantization parameter (QP) for video encoding, representing the highest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'VideoEncMaxQP' => ['description' => 'The maximum quantization parameter (QP) for video encoding, representing the lowest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'VideoEncAvgKbps' => ['description' => 'The average bitrate for video encoding. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'VideoEncPeakKbps' => ['description' => 'The peak bitrate for video encoding. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''], + 'DeviceRedirects' => [ + 'description' => 'The device redirection rule list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The device redirection rule.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => [ + 'description' => 'The peripheral type.', + 'enumValueTitles' => ['printer' => 'Printer', 'scanner' => 'Scanner', 'camera' => 'Camera', 'adb' => 'Android device'], + 'type' => 'string', + 'example' => 'camera', + 'title' => '', + ], + 'RedirectType' => ['description' => 'The redirection type.'."\n" + ."\n" + .'- usbRedirect: USB redirection.'."\n" + ."\n" + .'- deviceRedirect: Device redirection.'."\n" + ."\n" + .'- off: Disabled.', 'type' => 'string', 'example' => 'usbRedirect', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DeviceRules' => [ + 'description' => 'The custom peripheral rule list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom peripheral rule.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => [ + 'description' => 'The peripheral type.', + 'enumValueTitles' => ['usbKey' => 'UKey', 'other' => 'Other', 'graphicsTablet' => 'Graphics tablet', 'printer' => 'Printer', 'cardReader' => 'Card reader', 'scanner' => 'Scanner', 'storage' => 'Storage device', 'camera' => 'Camera', 'adb' => 'Android device', 'networkInterfaceCard' => 'Network interface controller (NIC)'], + 'type' => 'string', + 'example' => 'storage', + 'title' => '', + ], + 'DeviceName' => ['description' => 'The device name.', 'type' => 'string', 'example' => 'sandisk', 'title' => ''], + 'DeviceVid' => ['description' => 'The vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'example' => '0x0781', 'title' => ''], + 'DevicePid' => ['description' => 'The product ID.', 'type' => 'string', 'example' => '0x55b1', 'title' => ''], + 'RedirectType' => [ + 'description' => 'The redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Redirection disabled'], + 'type' => 'string', + 'example' => 'usbRedirect', + 'title' => '', + ], + 'OptCommand' => ['description' => 'The link optimization command.', 'type' => 'string', 'example' => '2:0', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WyAssistant' => [ + 'description' => 'Whether to provide the WUYING AI Assistant feature in the floating ball when accessing the cloud computer.', + 'enumValueTitles' => ['off' => 'Not provided', 'on' => 'Provided'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'ResourceRegionId' => ['description' => 'The region to which the cloud computer policy belongs.'."\n" + ."\n" + .'> For region-less policies, this value is `center`.', 'type' => 'string', 'example' => 'center', 'title' => ''], + 'DomainList' => [ + 'description' => 'The access control for domain names. Wildcards (\\*) are supported. Separate multiple domain names with commas (,).', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'StatusMonitor' => [ + 'description' => 'Whether to provide the status monitoring feature in the floating ball when accessing the cloud computer.', + 'enumValueTitles' => ['off' => 'Not provided', 'on' => 'Provided'], + 'type' => 'string', + 'example' => 'on', + 'title' => '', + ], + 'MobileRestart' => [ + 'description' => 'Whether to display the restart button in the floating ball when accessing the cloud computer from mobile clients (including Android and iOS clients).'."\n" + ."\n" + .'> Applies only to mobile clients of V7.4 or later.', + 'enumValueTitles' => ['off' => 'Not provided', 'on' => 'Provided'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'MobileShutdown' => [ + 'description' => 'Whether to display the shutdown button in the floating ball when accessing the cloud computer from mobile clients (including Android and iOS clients).'."\n" + ."\n" + .'> Applies only to mobile clients of V7.4 or later.', + 'enumValueTitles' => ['off' => 'Not provided', 'on' => 'Provided'], + 'type' => 'string', + 'example' => 'off', + 'title' => '', + ], + 'DesktopCount' => ['description' => 'The number of cloud computers associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DesktopGroupCount' => ['description' => 'The number of cloud computer pools associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ResourceGroupCount' => ['description' => 'The number of resource groups associated with this policy.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RecordEventFilePaths' => [ + 'description' => 'The list of absolute paths for file monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'The absolute path for file monitoring in screen recording audit.', 'type' => 'string', 'example' => 'd:/data', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RecordEventRegisters' => [ + 'description' => 'The list of absolute paths for registry monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'The absolute path for registry monitoring in screen recording audit.', 'type' => 'string', 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', 'title' => ''], + 'title' => '', + 'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', + ], + 'RecordEventDuration' => ['description' => 'The screen recording duration after an event is detected in screen recording audit. Unit: minutes. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'ResetDesktop' => ['description' => 'Resets the cloud computer.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'FileTransfer' => ['description' => 'File transfer.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'DeviceConnectHint' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResolutionModel' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResolutionWidth' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ResolutionHeight' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'FileMigrate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WuyingKeeper' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InternetPrinter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SafeMenu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ScreenDisplayMode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientControlMenu' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferSpeedLocation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferAddress' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'FileTransferSpeed' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpdDriveClipboard' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UseTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AutoReconnect' => ['description' => 'The automatic client reconnection configuration.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'MobileWuyingKeeper' => ['description' => 'The WUYING Keeper switch for mobile clients.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'MobileSafeMenu' => ['description' => 'The Windows security control switch for mobile clients.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'MobileWyAssistant' => ['description' => 'The Xiaoying AI Assistant switch for mobile clients.', 'type' => 'string', 'example' => 'off', 'title' => ''], + 'ExternalDrive' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientCreateSnapshot' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WatermarkShadow' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AcademicProxy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ModelLibrary' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PortProxy' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DiskOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CpuOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemoryOverload' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ResolutionDpi' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'HoverConfigMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MultiScreen' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverShutdown' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverRestart' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HoverHibernate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientShutdown' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientRestart' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ClientHibernate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'KeyboardControl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AdminKeyboardOnWindows' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AdminKeyboardOnFullScreen' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RecordEventLevels' => [ + 'title' => '', + 'description' => 'The screen recording event severity switch.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventType' => ['description' => 'The event type.', 'type' => 'string', 'title' => '', 'example' => ''], + 'EventLevel' => ['description' => 'The event severity.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'RecordEventFileExts' => [ + 'title' => '', + 'description' => 'The screen recording event suffix.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'example' => '', + ], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'NetworkPrinter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndUserCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OrganizationCount' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"Count\\": 0,\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 0,\\n \\"DescribePolicyGroups\\": [\\n {\\n \\"PolicyStatus\\": \\"AVAILABLE\\",\\n \\"Html5Access\\": \\"off\\",\\n \\"WatermarkType\\": \\"EndUserId\\",\\n \\"PreemptLogin\\": \\"off\\",\\n \\"WatermarkCustomText\\": \\"custom-watermark\\",\\n \\"Clipboard\\": \\"off\\",\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"PrinterRedirection\\": \\"on\\",\\n \\"WatermarkTransparency\\": \\"LIGHT\\",\\n \\"Html5FileTransfer\\": \\"off\\",\\n \\"UsbRedirect\\": \\"on\\",\\n \\"PolicyGroupType\\": \\"SYSTEM\\",\\n \\"Watermark\\": \\"on\\",\\n \\"VisualQuality\\": \\"medium\\",\\n \\"EdsCount\\": 2,\\n \\"Name\\": \\"testPolicyGroupName\\",\\n \\"LocalDrive\\": \\"readwrite\\",\\n \\"AuthorizeSecurityPolicyRules\\": [\\n {\\n \\"Type\\": \\"inflow\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Description\\": \\"test\\",\\n \\"PortRange\\": \\"22/22\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Priority\\": \\"1\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"AuthorizeAccessPolicyRules\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"ClientTypes\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"PreemptLoginUsers\\": [\\n \\"Alice\\"\\n ],\\n \\"GpuAcceleration\\": \\"off\\",\\n \\"UsbSupplyRedirectRule\\": [\\n {\\n \\"VendorId\\": \\"04**\\",\\n \\"ProductId\\": \\"08**\\",\\n \\"Description\\": \\"Test rule\\",\\n \\"UsbRedirectType\\": 1,\\n \\"DeviceClass\\": \\"0Eh\\",\\n \\"DeviceSubclass\\": \\"xxh\\",\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"OFF\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"BOTH\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 5,\\n \\"EndUserApplyAdminCoordinate\\": \\"on\\",\\n \\"EndUserGroupCoordinate\\": \\"on\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"on\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"Your cloud desktop is being recorded.\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 1000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"ResourceRegionId\\": \\"center\\",\\n \\"DomainList\\": \\"off\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"ResetDesktop\\": \\"null\\",\\n \\"FileTransfer\\": \\"null\\",\\n \\"DeviceConnectHint\\": \\"\\",\\n \\"ResolutionModel\\": \\"\\",\\n \\"ResolutionWidth\\": 0,\\n \\"ResolutionHeight\\": 0,\\n \\"FileMigrate\\": \\"\\",\\n \\"WuyingKeeper\\": \\"\\",\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"AutoReconnect\\": \\"off\\",\\n \\"MobileWuyingKeeper\\": \\"off\\",\\n \\"MobileSafeMenu\\": \\"off\\",\\n \\"MobileWyAssistant\\": \\"off\\",\\n \\"ExternalDrive\\": \\"\\",\\n \\"ClientCreateSnapshot\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"DiskOverload\\": \\"\\",\\n \\"CpuOverload\\": \\"\\",\\n \\"MemoryOverload\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"KeyboardControl\\": \\"\\",\\n \\"AdminKeyboardOnWindows\\": \\"\\",\\n \\"AdminKeyboardOnFullScreen\\": \\"\\",\\n \\"RecordEventLevels\\": [\\n {\\n \\"EventType\\": \\"\\",\\n \\"EventLevel\\": \\"\\"\\n }\\n ],\\n \\"RecordEventFileExts\\": [\\n \\"\\"\\n ],\\n \\"Description\\": \\"\\",\\n \\"NetworkPrinter\\": \\"\\",\\n \\"EndUserCount\\": \\"\\",\\n \\"OrganizationCount\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribePolicyGroups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-18T03:49:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-03T16:22:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-16T11:29:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-19T08:52:30.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-27T09:48:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-24T09:36:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-14T11:32:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyGroups'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribePolicyGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'machine', + ], + 'DescribePrice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52841', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], + ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the regions supported by EDS.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", + 'description' => 'The type of the resource.', + 'enumValueTitles' => ['DesktopMonthPackage' => 'Monthly subscription cloud computers that use hourly limit plans.', 'Desktop' => '(Default) Pay-as-you-go cloud computers/monthly subscription cloud computers that use unlimited plans.', 'Bandwidth' => 'Premium bandwidth plans.', 'DesktopGroup' => 'Cloud computer shares.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+cds-135515****', + 'required' => false, + 'example' => 'Desktop', + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'InstanceType', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The team ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The team ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The specifications of the resource.'."\n" + ."\n" + .'- This parameter is required if you set `ResourceType` to `Desktop`. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) to query the available cloud computer types that correspond to the value of `DesktopTypeId`.'."\n" + ."\n" + .'- If you set `ResourceType` to `DesktopGroup`, set the value of this parameter to `large`.'."\n" + ."\n" + .'- If you set `ResourceType` to `Bandwidth`, you can leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'eds.general.2c2g', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'RootDiskSizeGib', 'in' => 'query', - 'schema' => [ - 'description' => 'The team name for fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Test Team 1'."\n", - ], + 'schema' => ['description' => 'The size of the system disk. Unit: GiB. If you set `ResourceType` to `Desktop`, you must specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'required' => false, 'example' => '80', 'title' => ''], ], [ - 'name' => 'ParentGroupId', + 'name' => 'UserDiskSizeGib', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent node. If a parent node ID is specified, the subnodes are queried. If you set the value of this parameter to root, the root node is queried.'."\n" - ."\n" - .'Default value: null. The default value indicates that all nodes are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cg-e70ga4ixp30ur****', - ], + 'schema' => ['description' => 'The size of the data disk. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '65536', 'minimum' => '0', 'example' => '100', 'title' => ''], ], [ - 'name' => 'DriveStatus', + 'name' => 'OsType', 'in' => 'query', 'schema' => [ - 'description' => 'The team space status. Valid values:'."\n" - ."\n" - .'* enabled'."\n" - .'* disabled'."\n" - ."\n" - .'Default value: enabled.'."\n", + 'description' => 'The OS type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows (default)'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'enabled', + 'example' => 'Windows', + 'title' => '', ], ], [ - 'name' => 'GroupType', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The team type.'."\n" - ."\n" - .'* org: organizational structure'."\n" - .'* directory: workspace'."\n" - ."\n" - .'Default value: null. The default value indicates that all types of teams are queried.'."\n", + 'description' => 'The billing cycle.', + 'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year', 'Hour' => 'Hour (default)'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'org', + 'example' => 'Hour', + 'title' => '', ], ], [ - 'name' => 'DriveType', + 'name' => 'Period', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'Specifies whether the space is increased.'."\n" - ."\n" - .'* binding: increased'."\n" - .'* unbound: not increased'."\n" - ."\n" - .'Default value: null. The default value indicates that all spaces are queried.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'binding', - ], + 'schema' => ['description' => 'The subscription duration. The valid values of this parameter vary based on the value of `PeriodUnit`.'."\n" + ."\n" + .'- If you set `PeriodUnit` to `Hour`, set the value of this parameter to 1.'."\n" + ."\n" + .'- If you set `PeriodUnit` to `Month`, set the value of this parameter to 1, 2, 3, or 6.'."\n" + ."\n" + .'- If you set `PeriodUnit` to `Year`, set the value of this parameter to 1, 2, or 3.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DirectoryId', + 'name' => 'Amount', + 'in' => 'query', + 'schema' => ['description' => 'The number of resources. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'InternetChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The workspace ID.'."\n", + 'description' => 'The metering method for network traffic.', + 'enumValueTitles' => ['PayByTraffic' => 'You are charged for the actually consumed traffic.', 'PayByBandwidth' => 'You are charged by a fixed bandwidth.'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', + 'example' => 'PayByTraffic', + 'title' => '', ], ], [ - 'name' => 'DirectoryName', + 'name' => 'Bandwidth', + 'in' => 'query', + 'schema' => ['description' => 'The maximum public bandwidth. Unit: Mbit/s.'."\n" + ."\n" + .'- Valid values if you set InternetChargeType to PayByBandwidth: 10 to 1000.'."\n" + ."\n" + .'- Valid values if you set InternetChargeType to InternetChargeType: 10 to 200.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '5120', 'minimum' => '1', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'RootDiskPerformanceLevel', + 'in' => 'query', + 'schema' => ['description' => 'Performance level of the system disk. You can configure the disk performance level when the cloud desktop instance type is graphics-optimized or high clock speed. For differences among performance levels of disks, see [](t583241.xdita#).', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], + ], + [ + 'name' => 'UserDiskPerformanceLevel', + 'in' => 'query', + 'schema' => ['description' => 'Performance level of the data disk. You can specify the disk performance level when the WUYING Workspace instance type is set to graphics-optimized or high clock speed. For differences between performance levels of disks, see [](t583241.xdita#).', 'type' => 'string', 'required' => false, 'example' => 'PL0', 'title' => ''], + ], + [ + 'name' => 'GroupDesktopCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of cloud computer shares. Default value: 1.'."\n" + ."\n" + .'> This parameter takes effect only if you set `ResourceType` to `DesktopGroup`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Duration', 'in' => 'query', 'schema' => [ - 'description' => 'The workspace name.'."\n", - 'type' => 'string', + 'description' => 'The type of hourly plan if you use the Monthly Subscription billing method. If you set `ResourceType` to `DesktopMonthPackage`, you must specify this parameter.', + 'enumValueTitles' => [120 => 'The 120-hour computing plan.', 250 => 'The 250-hour computing plan.'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'docRequired' => true, - 'example' => 'testDirectoryName ', + 'example' => '120', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'RootDiskCategory', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Valid values: 1 to 100'."\n" - .'* Default value: 20'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The category of the system disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'The ultra disk.', 'cloud_auto' => 'The standard SSD.', 'cloud_essd' => 'The Enterprise SSD (ESSD). Take note that only specific cloud computer types support ESSDs.'], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', + 'example' => '40', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'UserDiskCategory', 'in' => 'query', 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", + 'description' => 'The category of the data disk.', + 'enumValueTitles' => ['cloud_efficiency' => 'The ultra disk.', 'cloud_auto' => 'The standard SSD.', 'cloud_essd' => 'The ESSD. Take note that only specific cloud computer types support ESSDs.'], 'type' => 'string', 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lY3I2VNHLwy+nIoSXh****', + 'example' => '80', + 'title' => '', ], ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['description' => 'User ID of the resource owner in resale mode. This parameter is not required in non-resale mode.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1422724566551XXX', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'EF015AE5-B30A-5189-B519-735CEE40****', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CloudDriveGroups' => [ - 'description' => 'The list of team spaces.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The team space status. Valid values:'."\n" - ."\n" - .'* enabled'."\n" - .'* disabled'."\n" - ."\n" - .'Default value: enabled.'."\n", - 'type' => 'string', - 'example' => 'enabled', - ], - 'GroupId' => [ - 'description' => 'The team ID.'."\n", - 'type' => 'string', - 'example' => 'cg-e70ga4ixp30ur****', - ], - 'GroupName' => [ - 'description' => 'The name of the team space.'."\n", - 'type' => 'string', - 'example' => 'Test Team 1'."\n", - ], - 'DirectoryId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-959593****', - ], - 'DriveId' => [ - 'description' => 'The team space ID.'."\n", - 'type' => 'string', - 'example' => 'sh1234', - ], - 'CreateTime' => [ - 'description' => 'The time when the team space was created.'."\n", - 'type' => 'string', - 'example' => '2022-04-11T07:44:21Z', - ], - 'TotalSize' => [ - 'description' => 'The total capacity of the team space.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5368709120', - ], - 'UsedSize' => [ - 'description' => 'The capacity of the used space. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '1024000000', - ], - 'RecycleBinSize' => [ - 'type' => 'string', - ], - 'AdminUserIds' => [ - 'type' => 'string', - ], - 'OrgId' => [ - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B1175630-3C44-4389-A3C1-15639FFC8EBC', 'title' => ''], + 'PriceInfo' => [ + 'description' => 'The price details.', + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'description' => 'The details of the promotion rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the rule.', 'type' => 'string', 'example' => '买满1年，立享官网价格8.5折优惠。', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '587', 'title' => ''], + ], + 'description' => 'Activity rule information.', + 'title' => '', + 'example' => '', ], - 'AdminUserInfos' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'type' => 'string', - ], - 'NickName' => [ - 'type' => 'string', - ], - 'RealNickName' => [ - 'type' => 'string', - ], - 'Remark' => [ - 'type' => 'string', - ], - 'Phone' => [ - 'type' => 'string', - ], - 'Email' => [ - 'type' => 'string', - ], - 'JobNumber' => [ - 'type' => 'string', + 'title' => '', + 'example' => '', + ], + 'Price' => [ + 'description' => 'The price.', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discounted amount.', 'type' => 'number', 'format' => 'float', 'example' => '15.8', 'title' => ''], + 'Currency' => ['description' => 'The unit of currency (USD).', 'type' => 'string', 'example' => 'CNY/USD', 'title' => ''], + 'TradePrice' => ['description' => 'The actual price. The original price minus the discounted amount equals the actual price.', 'type' => 'number', 'format' => 'float', 'example' => '63.2', 'title' => ''], + 'Promotions' => [ + 'description' => 'The promotions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotion.', + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => ['description' => 'The description of the promotion.', 'type' => 'string', 'example' => '新品上市，立享优惠', 'title' => ''], + 'OptionCode' => ['description' => 'The description of the promotion rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Selected' => ['description' => 'Indicates whether an item is selected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'PromotionName' => ['description' => 'The promotion name.', 'type' => 'string', 'example' => 'Featured deals', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'OrderLines' => [ + 'description' => 'The orders.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The order.', 'type' => 'string', 'example' => '5376483****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SpPrice' => ['description' => 'The price under an effective savings plan.', 'type' => 'integer', 'format' => 'int64', 'example' => '50.00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'FreeCdsQuota' => ['description' => 'Indicates whether a free enterprise drive is available.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FreeCdsSize' => ['description' => 'The free capacity provided by the enterprise drive. Unit: GiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"EF015AE5-B30A-5189-B519-735CEE40****\\",\\n \\"Count\\": 0,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"enabled\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"测试团队1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"sh1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"RecycleBinSize\\": \\"1024000\\",\\n \\"AdminUserIds\\": \\"[\\\\\\"user01\\\\\\"]\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\",\\n \\"AdminUserInfos\\": [\\n {\\n \\"EndUserId\\": \\"user01\\",\\n \\"NickName\\": \\"张三\\",\\n \\"RealNickName\\": \\"张三\\",\\n \\"Remark\\": \\"张三\\",\\n \\"Phone\\": \\"12345678\\",\\n \\"Email\\": \\"123@aliyun.com\\",\\n \\"JobNumber\\": \\"12345\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCloudDriveGroups', - ], - 'ModifyCloudDriveGroups' => [ - 'summary' => 'Modifies team spaces.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query new purchase price', + 'summary' => 'Query the new purchase price of Elastic Desktop Service (EDS) products.', + 'changeSet' => [ + ['createdAt' => '2025-11-04T08:21:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-09T03:02:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-09T02:21:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-25T11:10:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-08T02:37:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B1175630-3C44-4389-A3C1-15639FFC8EBC\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 587\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY/USD\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"123456\\",\\n \\"PromotionName\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n },\\n \\"SpPrice\\": 50\\n },\\n \\"FreeCdsQuota\\": true,\\n \\"FreeCdsSize\\": 100\\n }\\n}","type":"json"}]', + ], + 'DescribeQosRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'CdsId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+cds-135515****', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the team space. Valid values:'."\n" - ."\n" - .'* enabled'."\n" - .'* disabled'."\n" - ."\n" - .'Default value: enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'disabled', - ], - ], - [ - 'name' => 'TotalSize', + 'name' => 'NetworkPackageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The total capacity of the team space.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '32212254720', - ], + 'schema' => ['description' => 'The network package ID.', 'type' => 'string', 'required' => true, 'example' => 'np-cxj99qb8d34vo****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'QosRuleName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the teams.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the team.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The QoS rule name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ @@ -24831,486 +22618,513 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => 'The returned results. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'QosRules' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'QosRuleId' => ['description' => 'The QoS rule ID.', 'type' => 'string', 'example' => 'qos-chvkz5ekzgcb6bo0f', 'title' => ''], + 'QosRuleName' => ['description' => 'The QoS rule name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'NetworkPackageId' => ['description' => 'The network package ID.', 'type' => 'string', 'example' => 'np-5cjh3sqs1ty3s02xq', 'title' => ''], + 'Upload' => ['description' => 'The upload bandwidth.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Download' => ['description' => 'The download bandwidth.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'DesktopGroupCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DesktopCount' => ['description' => 'The number of associated cloud desktops.', 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'description' => 'Details of a QoS rule.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of QoS rules.', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ModifyCloudDriveGroups', - ], - 'DeleteCloudDriveGroups' => [ - 'summary' => 'Deletes team spaces.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeQosRules', + 'summary' => 'Queries QoS rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeQosRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QosRules\\": [\\n {\\n \\"QosRuleId\\": \\"qos-chvkz5ekzgcb6bo0f\\",\\n \\"QosRuleName\\": \\"test\\",\\n \\"NetworkPackageId\\": \\"np-5cjh3sqs1ty3s02xq\\",\\n \\"Upload\\": \\"10\\",\\n \\"Download\\": \\"10\\",\\n \\"DesktopGroupCount\\": 0,\\n \\"DesktopCount\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRecordFile' => [ + 'summary' => 'Retrieve screen recording files from all regions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions that are supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-532033****', - ], + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the teams that you want to delete. You can delete multiple teams at a time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the team.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The ID of the end user.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Alice', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => 'The result of the operation. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true: The request is successful. false: The request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - 'Message' => [ - 'description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '20251218175715', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteCloudDriveGroups', - ], - 'CreateCloudDriveUsers' => [ - 'summary' => 'Creates the users of a cloud disk.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '20251218205715', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The status of the screen recording file. Valid values:'."\n" + ."\n" + .'- `0`: The file is uploaded.'."\n" + ."\n" + .'- `1`: The file is being uploaded.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'RecordType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-352282****', - ], + 'schema' => ['description' => 'The type of the screen recording. Valid values:'."\n" + ."\n" + .'- `alltime`: full-time recording'."\n" + ."\n" + .'- `period`: recording at intervals'."\n" + ."\n" + .'- `event`: event-triggered recording'."\n" + ."\n" + .'- `session`: session-based recording', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'alltime', 'title' => ''], ], [ - 'name' => 'UserMaxSize', + 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum storage space of an end user. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '1024', - ], + 'schema' => ['description' => 'The sorting basis. If you do not specify this parameter, the results are sorted by screen recording start time in descending order. Valid value:'."\n" + ."\n" + .'- `startTime`: the start time of a screen recording.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'startTime', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'OrderSort', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the end users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The sorting order. Valid values:'."\n" + ."\n" + .'- `asc`: ascending'."\n" + ."\n" + .'- `desc`: descending', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'asc', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the recording file.', 'type' => 'string', 'required' => false, 'example' => 'Task7', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'default' => 'desktop', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05F0A7AE-17F1-53DF-BD99-ABF936FA****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RecordFiles' => [ + 'description' => 'Details of the screen recording files.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a screen recording file.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The upload status of the screen recording file. Valid values:'."\n" + ."\n" + .'- `0`: uploaded.'."\n" + ."\n" + .'- `1`: uploading.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RecordExpire' => ['description' => 'The expiration time of the screen recording file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1774656000000', 'title' => ''], + 'RecordType' => ['description' => 'The recording type. Valid values:'."\n" + ."\n" + .'- `alltime`: continuous screen recording.'."\n" + ."\n" + .'- `period`: interval screen recording.'."\n" + ."\n" + .'- `event`: event-triggered screen recording.'."\n" + ."\n" + .'- `session`: session-based screen recording.', 'type' => 'integer', 'format' => 'int32', 'example' => 'period', 'title' => ''], + 'EndUserId' => ['description' => 'The name of the end user.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'RecordEndTime' => ['description' => 'The time when the screen recording ended. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-12-18T06:02:25Z', 'title' => ''], + 'RecordStartTime' => ['description' => 'The time when the screen recording started. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.', 'type' => 'string', 'example' => '2025-12-18T06:02:25Z', 'title' => ''], + 'FileName' => ['description' => 'The name of the screen recording file.', 'type' => 'string', 'example' => 'Task3', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-7yulhw1g1attet7d2', 'title' => ''], + 'FileSize' => ['description' => 'The file size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '139', 'title' => ''], + 'EventDetails' => [ + 'description' => 'The event details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data object.', + 'type' => 'object', + 'properties' => [ + 'EventTime' => ['description' => 'The time when the event occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'EventType' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'UserInput', 'title' => ''], + 'EventName' => ['description' => 'The event details.', 'type' => 'string', 'example' => '{\\n\\t\\"messageInfo\\" : \\"mouse_move\\",\\n\\t\\"messageType\\" : \\"UserInput\\"\\n}\\n"', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'fvt-ecd', 'title' => ''], + 'PolicyId' => ['description' => 'The ID of the policy.', 'type' => 'string', 'example' => 'pg-**', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the cloud desktop resides.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'resource', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05F0A7AE-17F1-53DF-BD99-ABF936FA****\\"\\n}","type":"json"}]', - 'title' => 'CreateCloudDriveUsers', - ], - 'DescribeCloudDriveUsers' => [ - 'summary' => 'Queries users of cloud disks in Cloud Drive Service.', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query the list of screen recording files across all regions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeRecordFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\",\\n \\"TotalCount\\": 2,\\n \\"RecordFiles\\": [\\n {\\n \\"Status\\": 1,\\n \\"RecordExpire\\": 1774656000000,\\n \\"RecordType\\": 0,\\n \\"EndUserId\\": \\"Alice\\",\\n \\"RecordEndTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"RecordStartTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"FileName\\": \\"Task3\\",\\n \\"DesktopId\\": \\"ecd-7yulhw1g1attet7d2\\",\\n \\"FileSize\\": 139,\\n \\"EventDetails\\": [\\n {\\n \\"EventTime\\": 60,\\n \\"EventType\\": \\"UserInput\\",\\n \\"EventName\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageInfo\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"mouse_move\\\\\\\\\\\\\\",\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageType\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"UserInput\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\\\n\\\\\\"\\"\\n }\\n ],\\n \\"DesktopName\\": \\"fvt-ecd\\",\\n \\"PolicyId\\": \\"pg-**\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"resource\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRecordings' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-066224****', - ], + 'schema' => ['description' => 'The maximum number of entries per page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The pagination token that is used in the request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'PolicyGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The policy ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud computer ID. If this parameter is not specified, the screen recording files on all cloud computers in the designated region will be queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-hlh41mk78dugw****', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query. Specify the time in the `YYYYMMDDhhmmss` format. The time must be in UTC+8.'."\n", 'type' => 'string', 'required' => false, 'example' => '20230424000000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query. Specify the time in the `YYYYMMDDhhmmss` format. The time must be in UTC+8.'."\n", 'type' => 'string', 'required' => false, 'example' => '20230424004441', 'title' => ''], + ], + [ + 'name' => 'NeedSignedUrl', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Specifies whether to return a URL.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false (default)'."\n", + 'type' => 'boolean', 'required' => false, - 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], + [ + 'name' => 'SignedUrlExpireMinutes', + 'in' => 'query', + 'schema' => ['description' => 'The validity period of the returned URL. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StandardStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time of the query. Specify the time in the ISO 8601 standard in the `yyyy-mm-ddthh:mm:ssz` format. The time must be in UTC+0.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-01-27T02:20:10Z', 'title' => ''], + ], + [ + 'name' => 'StandardEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the query. Specify the time in the ISO 8601 standard in the `yyyy-mm-ddthh:mm:ssz` format. The time must be in UTC+0.'."\n", 'type' => 'string', 'required' => false, 'example' => '2025-01-27T02:30:10Z', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F083AAE5-7AA9-53BB-9060-AFFB2C18****', - ], - 'CloudDriveUsers' => [ - 'description' => '', + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nbCQ7ar+fECeh1IuWQXi39R5eoJ68zWp99mTAKRRNRhw==', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '327CFE78-1C0D-51AC-A9C6-BCEDF0DD44D6', 'title' => ''], + 'Recordings' => [ + 'description' => 'The screen recording files.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The screen recording file.'."\n", 'type' => 'object', 'properties' => [ - 'UsedSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20490', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '不可用', - 'enabled' => '可用', - ], - 'example' => 'enabled', - ], - 'DriveId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8', - ], - 'TotalSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10240000', - ], - 'UserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'abc', - ], - 'UserName' => [ - 'description' => '', + 'EndTime' => ['description' => 'The end time of the recording.'."\n", 'type' => 'string', 'example' => '2023-04-10T07:26:06Z', 'title' => ''], + 'FilePath' => ['description' => 'The file path.'."\n", 'type' => 'string', 'example' => 'pg-4w5nk44zo5yl1****/1mk78dugw344.mp4', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the recording.'."\n", 'type' => 'string', 'example' => '2023-04-10T07:26:06Z', 'title' => ''], + 'RecordingType' => [ + 'description' => 'The type of event that triggers the recording.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* byaction_cmd_ft: triggered by copy-paste or file transfer events.'."\n" + .'* period: triggered at scheduled intervals.'."\n" + .'* session: triggered by session lifecycle monitoring.'."\n" + .'* byaction_commands: triggered by copy-paste only.'."\n" + .'* alltime: continuous recording.'."\n" + .'* byaction_file_transfer: triggered by file transfer only.'."\n", 'type' => 'string', - 'example' => 'abc', + 'enumValueTitles' => ['byaction_cmd_ft' => '', 'period' => '', 'session' => '', 'byaction_commands' => '', 'alltime' => '', 'byaction_file_transfer' => ''], + 'example' => 'alltime', + 'title' => '', ], - 'EndUserId' => [ - 'type' => 'string', + 'RecordingSize' => ['description' => 'The size of the screen recording file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1742845', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'example' => 'ecd-10v0vuvm616sk****', 'title' => ''], + 'EndUserIds' => [ + 'description' => 'The end user IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The end user ID.'."\n", 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'PolicyGroupId' => ['description' => 'The policy ID.'."\n", 'type' => 'string', 'example' => 'pg-6dn811rzrwh9w****', 'title' => ''], + 'DesktopName' => ['description' => 'The cloud computer name.'."\n", 'type' => 'string', 'example' => 'DemoComputer', 'title' => ''], + 'SignedUrl' => ['description' => 'The download URL of the screen recording file.'."\n", 'type' => 'string', 'example' => 'https://eds-recording-bucket-cn-hangzhou-137187566615****.oss-cn-hangzhou.aliyuncs.com/pg-28l5tdjd33txz****/ecd-e0so9m9u6chf1****_gftest001_alltime_s0_****.mp4?Expires=171256****&OSSAccessKeyId=STS.****&Signature=****4WyAA', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\",\\n \\"RequestId\\": \\"F083AAE5-7AA9-53BB-9060-AFFB2C18****\\",\\n \\"CloudDriveUsers\\": [\\n {\\n \\"UsedSize\\": 10485760,\\n \\"Status\\": \\"enabled\\",\\n \\"DriveId\\": \\"8\\",\\n \\"TotalSize\\": 104857600,\\n \\"UserId\\": \\"alice@cn-shanghai.148875033399****\\",\\n \\"UserName\\": \\"alice\\",\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCloudDriveUsers', - ], - 'ModifyCloudDriveUsers' => [ - 'summary' => 'Modifies users of a cloud disk in Cloud Drive Service.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nbCQ7ar+fECeh1IuWQXi39R5eoJ68zWp99mTAKRRNRhw==\\",\\n \\"RequestId\\": \\"327CFE78-1C0D-51AC-A9C6-BCEDF0DD44D6\\",\\n \\"Recordings\\": [\\n {\\n \\"EndTime\\": \\"2023-04-10T07:26:06Z\\",\\n \\"FilePath\\": \\"pg-4w5nk44zo5yl1****/1mk78dugw344.mp4\\",\\n \\"StartTime\\": \\"2023-04-10T07:26:06Z\\",\\n \\"RecordingType\\": \\"alltime\\",\\n \\"RecordingSize\\": 1742845,\\n \\"DesktopId\\": \\"ecd-10v0vuvm616sk****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"PolicyGroupId\\": \\"pg-6dn811rzrwh9w****\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"SignedUrl\\": \\"https://eds-recording-bucket-cn-hangzhou-137187566615****.oss-cn-hangzhou.aliyuncs.com/pg-28l5tdjd33txz****/ecd-e0so9m9u6chf1****_gftest001_alltime_s0_****.mp4?Expires=171256****&OSSAccessKeyId=STS.****&Signature=****4WyAA\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeRecordings', + 'summary' => 'Queries the details of screen recording files.', + 'changeSet' => [ + ['createdAt' => '2025-01-16T11:29:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-24T08:11:11.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordings'], + ], ], + 'ramActions' => [], + ], + 'DescribeRefundPrice' => [ + 'summary' => 'Query the refund amount for monthly subscription WUYING Workspaces.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID. Call [DescribeRegions](~~DescribeRegions~~) to get a list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'RefundType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'Refund type.', + 'enumValueTitles' => ['RemainRefund' => 'Refund the remaining balance and release resources.', 'RenewRefund' => 'Refund the renewal fee. This only modifies the instance expiration time.'], 'type' => 'string', - 'required' => true, + 'required' => false, 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-596198****', + 'example' => 'RemainRefund', + 'title' => '', ], ], [ - 'name' => 'Status', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The status of Cloud Drive Service users.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* disabled'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' unavailable'."\n" - ."\n" - .' '."\n" - ."\n" - .'* enabled'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' available'."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', + 'description' => 'A list of cloud desktop IDs. You can specify one or more IDs. The number of IDs (N) must be between 1 and 20.', + 'type' => 'array', + 'items' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UserMaxSize', + 'name' => 'ResellerOwnerUid', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum storage space of a user. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1024', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'PriceInfo' => [ + 'description' => 'Price details.', + 'type' => 'object', + 'properties' => [ + 'Currency' => ['description' => 'Currency unit (CNY).'."\n" + .'Currency unit (USD).', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'RefundFee' => ['description' => 'This refund amount.', 'type' => 'number', 'format' => 'float', 'example' => '3990.75', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'DescribeRefundPrice', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-26T07:17:11.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRefundPrice'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"RefundFee\\": 3990.75\\n }\\n}","type":"json"}]', + ], + 'DescribeRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'EndUserId', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AcceptLanguage', + 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 100, + 'description' => 'The display name of the region, which varies based on the current language.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], + 'example' => 'zh', + 'title' => '', ], ], ], @@ -25320,1213 +23134,1607 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D2E005C4-8CA3-5F1D-9917-E75BE3BF****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Regions' => [ + 'description' => 'The information about regions.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'ecd.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'LocalName' => ['description' => 'The display name of the region, which varies based on the current language.', 'type' => 'string', 'example' => '华东1（杭州）', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2E005C4-8CA3-5F1D-9917-E75BE3BF****\\"\\n}","type":"json"}]', - 'title' => 'ModifyCloudDriveUsers', - ], - 'DeleteCloudDriveUsers' => [ - 'summary' => 'Deletes users from a cloud disk in Cloud Drive Service.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeRegions', + 'summary' => 'Queries the Alibaba Cloud regions that are available for Elastic Desktop Service (EDS).', + 'changeSet' => [ + ['createdAt' => '2022-08-02T02:02:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LocalName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeRenewalPrice' => [ + 'summary' => 'Retrieves the renewal price for an Elastic Desktop Service product.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '75405', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~DescribeRegions~~) to get a list of regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID. The value for this parameter depends on the resource type:'."\n" + ."\n" + .'- If `ResourceType` is set to `Desktop`, set `InstanceId` to the cloud desktop ID.'."\n" + ."\n" + .'- If `ResourceType` is set to `DesktopGroup`, set `InstanceId` to the desktop pool ID.'."\n" + ."\n" + .'- If `ResourceType` is set to `Bandwidth`, set `InstanceId` to the premium bandwidth ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecd-6ldllk9zxcpfhs****', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The resource type.', + 'enumValueTitles' => ['Desktop' => 'A cloud desktop. \\[default]', 'Bandwidth' => 'Premium bandwidth.', 'DesktopGroup' => 'A desktop pool.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'Desktop', + 'title' => '', ], ], [ - 'name' => 'CdsId', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The time unit for the `Period` parameter.', + 'enumValueTitles' => ['Month' => 'month \\[default]', 'Year' => 'year'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-64326*****', + 'required' => false, + 'docRequired' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'EndUserId', + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The renewal duration. The valid values depend on the `PeriodUnit` parameter.'."\n" + ."\n" + .'- If `PeriodUnit` is set to `Month`, the valid values are 1, 2, 3, and 6.'."\n" + ."\n" + .'- If `PeriodUnit` is set to `Year`, the valid values are 1, 2, and 3.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ + 'description' => 'The instance IDs. The values to provide depend on the resource type (`ResourceType`).', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'bcl', - ], + 'items' => ['description' => 'The instance ID. For details, see the description of the `InstanceId` parameter.', 'type' => 'string', 'required' => false, 'example' => 'ecd-6ldllk9zxcpfhs****', 'title' => ''], 'required' => false, - 'docRequired' => true, 'maxItems' => 100, - 'description' => '', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****', 'title' => ''], + 'PriceInfo' => [ + 'description' => 'The price details.', + 'type' => 'object', + 'properties' => [ + 'Rules' => [ + 'description' => 'The promotion rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotion rule.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The rule description.', 'type' => 'string', 'example' => '买满1年，立享官网价格8.5折优惠。', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '29644', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Price' => [ + 'description' => 'The price.', + 'type' => 'object', + 'properties' => [ + 'OriginalPrice' => ['description' => 'The original price.', 'type' => 'number', 'format' => 'float', 'example' => '79.0', 'title' => ''], + 'DiscountPrice' => ['description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'example' => '15.8', 'title' => ''], + 'Currency' => ['description' => 'The unit of currency. The value is CNY.'."\n" + .'The unit of currency. The value is USD.', 'type' => 'string', 'example' => 'CNY', 'title' => ''], + 'TradePrice' => ['description' => 'The final price. This is the value of `OriginalPrice` minus `DiscountPrice`.', 'type' => 'number', 'format' => 'float', 'example' => '63.2', 'title' => ''], + 'Promotions' => [ + 'description' => 'The promotion details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The promotion details.', + 'type' => 'object', + 'properties' => [ + 'PromotionDesc' => ['description' => 'The promotion description.', 'type' => 'string', 'example' => '新品上市，立享优惠', 'title' => ''], + 'OptionCode' => ['description' => 'The promotion rule description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Selected' => ['description' => 'Indicates whether the promotion is selected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'PromotionId' => ['description' => 'The promotion ID.', 'type' => 'string', 'example' => 'promo_option', 'title' => ''], + 'PromotionName' => ['description' => 'The promotion name.', 'type' => 'string', 'example' => 'Featured deals', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OrderLines' => [ + 'description' => 'The order details.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The order details.', 'type' => 'string', 'example' => '5376483****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAEFFE4B-E87B-5F76-B165-9248F377****\\"\\n}","type":"json"}]', - 'title' => 'DeleteCloudDriveUsers', - ], - 'DescribeCloudDrivePermissions' => [ - 'summary' => 'Queries the permission settings on the enterprise drive.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年，立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 29644\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市，立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"promo_option\\",\\n \\"PromotionName\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'DescribeRenewalPrice', + 'changeSet' => [ + ['createdAt' => '2025-07-29T01:40:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-01T02:05:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-04T10:25:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-04T10:25:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeRenewalPrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'DescribeResourceByCenterPolicyId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PolicyGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The policy ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'ProductType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* app: cloud applications.'."\n" + .'* resourceGroup: resource groups.'."\n" + .'* desktop: cloud computers.'."\n" + .'* desktopGroup: cloud computer shares.'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-82414*****', + 'required' => false, + 'enumValueTitles' => ['app' => '', 'resourceGroup' => '', 'desktop' => '', 'desktopGroup' => ''], + 'example' => 'desktop', + 'title' => '', ], ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'* Maximum value: 100.'."\n" + .'* Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'A pagination token.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l69tQX7yFxx6/4dbooBAOc', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3', - ], - 'CloudDrivePermissionModels' => [ - 'description' => '', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****', 'title' => ''], + 'ResourceModelList' => [ + 'description' => 'The resources.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Permission' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CDS_DOWNLOAD', - ], - 'EndUsers' => [ - 'description' => '', + 'Status' => ['description' => 'The resource status.'."\n", 'type' => 'string', 'example' => 'Stopped', 'title' => ''], + 'Cpu' => ['description' => 'The number of vCPUs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'example' => 'desktop', 'title' => ''], + 'ProductType' => ['description' => 'The service type.'."\n", 'type' => 'string', 'example' => 'desktop', 'title' => ''], + 'OsType' => ['description' => 'The OS type.'."\n", 'type' => 'string', 'example' => 'Linux', 'title' => ''], + 'GpuCount' => ['description' => 'The number of GPUs.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.125', 'title' => ''], + 'Memory' => ['description' => 'The memory size. Unit: MiB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10240', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'example' => 'ecd-7o96aa08fr****', 'title' => ''], + 'ResourceName' => ['description' => 'The resource name.'."\n", 'type' => 'string', 'example' => 'O&M', 'title' => ''], + 'ProtocolType' => ['description' => 'The protocol type.'."\n", 'type' => 'string', 'example' => 'ASP', 'title' => ''], + 'DesktopType' => ['description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of the cloud computer types supported by Alibaba Cloud Workspace.'."\n", 'type' => 'string', 'example' => 'eds.enterprise_office.8c32g', 'title' => ''], + 'PayType' => ['description' => 'The billing method.'."\n", 'type' => 'string', 'example' => 'postPaid', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU type.'."\n", 'type' => 'string', 'example' => '2GiB', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-d7pasxsd3b9nhq**', 'title' => ''], + 'ResourceGroupName' => ['description' => 'The resource group name.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ResourceGroupRelCount' => ['description' => 'The number of associated resource groups'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'AppModelList' => [ + 'description' => 'The cloud applications.'."\n", 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppId' => ['description' => 'The application ID. This parameter is only applicable to cloud applications.'."\n", 'type' => 'string', 'example' => '18', 'title' => ''], + 'AppName' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => 'alipic-powergem', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'bcl', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ResourceRegionId' => ['description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'Count' => ['description' => 'The total number of resources.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3\\",\\n \\"CloudDrivePermissionModels\\": [\\n {\\n \\"Permission\\": \\"CDS_DOWNLOAD\\",\\n \\"EndUsers\\": [\\n \\"alice\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCloudDrivePermissions', - ], - 'ModifyCloudDrivePermission' => [ - 'summary' => 'Modifies the user permissions on Cloud Drive Service, and configures users who have the download permissions and upload and download permissions. By default, the users that are not configured the preceding permissions only have the upload permissions.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48174475-5EB2-5F99-A9E9-6F892D645****\\",\\n \\"ResourceModelList\\": [\\n {\\n \\"Status\\": \\"Stopped\\",\\n \\"Cpu\\": 64,\\n \\"ResourceType\\": \\"desktop\\",\\n \\"ProductType\\": \\"desktop\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"GpuCount\\": 0.125,\\n \\"Memory\\": 10240,\\n \\"ResourceId\\": \\"ecd-7o96aa08fr****\\",\\n \\"ResourceName\\": \\"O&M\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.8c32g\\",\\n \\"PayType\\": \\"postPaid\\",\\n \\"GpuSpec\\": \\"2GiB\\",\\n \\"ResourceGroupId\\": \\"rg-d7pasxsd3b9nhq**\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"ResourceGroupRelCount\\": 10,\\n \\"AppModelList\\": [\\n {\\n \\"AppId\\": \\"18\\",\\n \\"AppName\\": \\"alipic-powergem\\"\\n }\\n ],\\n \\"ResourceRegionId\\": \\"cn-shenzhen\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": \\"2\\"\\n}","type":"json"}]', + 'title' => 'DescribeResourceByCenterPolicyId', + 'summary' => 'Queries cloud resources that are associated with a global policy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeResourceByCenterPolicyId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeSessionStatistic' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-60911*****', - ], + 'schema' => ['description' => 'Specifies to search for session information by region ID. This parameter is used to filter desktop information of a specific region.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DownloadEndUserIds', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the users who have the download permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-259382****', 'title' => ''], ], [ - 'name' => 'DownloadUploadEndUserIds', + 'name' => 'StartTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the users who have the upload and download permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'efg', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1679449506572', 'title' => ''], ], [ - 'name' => 'NoDownloadNoUploadEndUserIds', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'string', 'required' => false, 'example' => '1677808889806', 'title' => ''], + ], + [ + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The query interval. Unit: seconds. Valid values:'."\n" + ."\n" + .'- 60'."\n" + ."\n" + .'- 120', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9197824D-AD4B-571F-94BB-C2E6D5855AB6', + 'TotalCount' => ['description' => 'The total number of sessions returned.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C5528624-C6ED-5CA4-A4A2-7C30DBF2****', 'title' => ''], + 'Statistic' => [ + 'description' => 'The statistics.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1690164443508', 'title' => ''], + 'Count' => ['description' => 'The total number of sessions in the time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9197824D-AD4B-571F-94BB-C2E6D5855AB6\\"\\n}","type":"json"}]', - 'title' => 'ModifyCloudDrivePermission', - ], - 'CreateCdsFile' => [ - 'summary' => 'Uploads a file to a cloud disk.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeSessionStatistic', + 'summary' => 'Queries the session statistics of a region.', + 'description' => '- This is a central operation and can be called only by using services in the China (Shanghai) region.'."\n" + ."\n" + .'- You can query session statistics for the past hour.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeSessionStatistic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"RequestId\\": \\"C5528624-C6ED-5CA4-A4A2-7C30DBF2****\\",\\n \\"Statistic\\": [\\n {\\n \\"TimePoint\\": 1690164443508,\\n \\"Count\\": 4\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeSnapshots' => [ + 'summary' => 'Queries the snapshots and their details for a cloud desktop.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. Call [](t2167755.xdita#)to get a list of regions that support Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-82414*****', - ], + 'schema' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'SnapshotId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testFile.txt', - 'maxLength' => 256, - 'minLength' => 1, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'schema' => ['description' => 'The snapshot ID.', 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****', 'title' => ''], ], [ - 'name' => 'FileType', + 'name' => 'SnapshotName', 'in' => 'query', - 'schema' => [ - 'description' => 'The file type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* file'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* folder'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'file' => '', - 'folder' => '', - ], - 'example' => 'file', - ], + 'schema' => ['description' => 'The display name of the snapshot. The name must be 2 to 127 characters long. It must start with a letter. It can contain digits, underscores (\\_), and hyphens (-). The name cannot start with `auto` to avoid naming conflicts with automatic snapshots.', 'type' => 'string', 'example' => 'Test data disk', 'required' => false, 'title' => ''], ], [ - 'name' => 'ParentFileId', + 'name' => 'SourceDiskType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the parent folder.'."\n", + 'description' => 'The disk from which to create the snapshot.'."\n" + ."\n" + .'> The value is case-insensitive.', + 'enumValueTitles' => ['Data' => 'The data disk', 'System' => 'The system disk'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => '637c9163b453b1a384874264ba79f3f9eab9****', + 'example' => 'system', + 'title' => '', ], ], [ - 'name' => 'FileLength', + 'name' => 'SnapshotType', 'in' => 'query', 'schema' => [ - 'description' => 'The file size. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2048', + 'description' => 'The snapshot type.', + 'enumValueTitles' => ['all' => 'All snapshot types. This is the default value.', 'auto' => 'Automatic snapshot', 'user' => 'Manually created snapshot'], + 'type' => 'string', + 'required' => false, + 'example' => 'user', + 'title' => '', ], ], [ - 'name' => 'FileHash', + 'name' => 'OsType', 'in' => 'query', 'schema' => [ - 'description' => 'The hash value of the SHA1 algorithm that is used by the file.'."\n", + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'The Linux operating system', 'Windows' => 'The Windows operating system'], 'type' => 'string', 'required' => false, - 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8****', + 'example' => 'Windows', + 'title' => '', ], ], [ - 'name' => 'ConflictPolicy', + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The creator.', 'type' => 'string', 'required' => false, 'example' => 'Administrator', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time to query for snapshots. The time follows the [ISO 8601](t10049.xdita#) standard and is in UTC. The format is `yyyy-mm-ddthh:mm:ssz`.', 'type' => 'string', 'required' => false, 'example' => '2020-11-30T06:32:31Z', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time to query for snapshots. The time follows the [ISO 8601](t10049.xdita#) standard and is in UTC. The format is `yyyy-mm-ddthh:mm:ssz`.', 'type' => 'string', 'required' => false, 'example' => '2020-11-31T06:32:31Z', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results. This is the NextToken value from the previous API call.', 'type' => 'string', 'required' => false, 'example' => '8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '100', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The policy that is used when the file that you want to upload has the same name as an existing file in the cloud disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* refuse'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' denies creating the file'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* auto_rename'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' automatically renames the file'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* ignore'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' allows the file to use the same name as the existing file in the cloud disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* over_write'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' overwrites the existing file in the cloud disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'refuse' => '', - 'auto_rename' => '', - 'ignore' => '', - 'over_write' => '', - ], - 'example' => 'ignore', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'Returns a collection of information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2BAFE05D-FFB9-5938-96D0-08017DB9****', - ], - 'FileModel' => [ - 'type' => 'object', - 'properties' => [ - 'UploadUrl' => [ - 'type' => 'string', - ], - 'FileId' => [ - 'type' => 'string', - ], - 'UploadId' => [ - 'type' => 'string', + 'NextToken' => ['description' => 'The token that marks the start of the next page of results. If NextToken is empty, no more pages exist.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'Snapshots' => [ + 'description' => 'A collection of snapshots.', + 'type' => 'array', + 'items' => [ + 'description' => 'The snapshot.', + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => 'The point in time at which the snapshot was created. The time follows the [ISO 8601](t10049.xdita#) standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the snapshot.', + 'enumValueTitles' => ['PROGRESSING' => 'Creating', 'FAILED' => 'Failed to create', 'ACCOMPLISHED' => 'Created'], + 'type' => 'string', + 'example' => 'ACCOMPLISHED', + 'title' => '', + ], + 'SnapshotType' => [ + 'description' => 'The type of the snapshot.', + 'enumValueTitles' => ['AUTO' => 'Automatic snapshot', 'USER' => 'Manual snapshot'], + 'type' => 'string', + 'example' => 'USER', + 'title' => '', + ], + 'SnapshotName' => ['description' => 'The name of the snapshot.', 'type' => 'string', 'example' => 'testSnapshotName', 'title' => ''], + 'Progress' => ['description' => 'The progress of creating the snapshot. Unit: %.', 'type' => 'string', 'example' => '100%', 'title' => ''], + 'Description' => ['description' => 'The description of the snapshot.', 'type' => 'string', 'example' => 'testDescription', 'title' => ''], + 'SnapshotId' => ['description' => 'The snapshot ID.', 'type' => 'string', 'example' => 's-2zeipxmnhej803x7****', 'title' => ''], + 'RemainTime' => ['description' => 'The remaining time to complete snapshot creation. Unit: seconds.'."\n" + ."\n" + .'> When `Status` is `PROGRESSING`, the value of `RemainTime` is `-1`. This indicates that the system is calculating the remaining time.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SourceDiskSize' => ['description' => 'The capacity of the source disk. Unit: GiB.', 'type' => 'string', 'example' => '150', 'title' => ''], + 'SourceDiskType' => [ + 'description' => 'The type of the source disk.', + 'enumValueTitles' => ['SYSTEM' => 'System disk', 'DATA' => 'Data disk'], + 'type' => 'string', + 'example' => 'SYSTEM', + 'title' => '', + ], + 'DesktopId' => ['description' => 'The ID of the cloud desktop to which the snapshot belongs.', 'type' => 'string', 'example' => 'ecd-g03l3tlm8djoj****', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DesktopStatus' => [ + 'description' => 'The status of the cloud desktop.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'DiskStatus' => [ + 'description' => 'Status of the disk to which the snapshot belongs.', + 'enumValueTitles' => ['Available' => 'In use', 'Deleted' => 'Deleted'], + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'Creator' => ['description' => 'The user who creates the snapshot.', 'type' => 'string', 'example' => 'Administrator', 'title' => ''], + 'ProtocolType' => [ + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud Adaptive Streaming Protocol (ASP)'], + 'type' => 'string', + 'example' => 'ASP', + 'title' => '', + ], + 'OsType' => [ + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux operating system', 'Windows' => 'Windows operating system'], + 'type' => 'string', + 'example' => 'Windows', + 'title' => '', + ], + 'VolumeEncryptionEnabled' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [](t22712.xdita#)operation to query the list of KMS keys.', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''], + 'DeletionTime' => ['description' => 'The snapshot creation time follows the [ISO 8601](t10049.xdita#) standard. It uses UTC+0 time and is formatted as `yyyy-mm-ddThh:mm:ssZ`.', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z'."\n", 'title' => ''], + 'RestorePointId' => ['description' => 'The ID of the restore point.', 'type' => 'string', 'example' => 'rp-btgmaa20wkcju****', 'title' => ''], + 'RestorePointName' => ['description' => 'The name of the restore point.', 'type' => 'string', 'example' => '数据盘备份', 'title' => ''], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BAFE05D-FFB9-5938-96D0-08017DB9****\\",\\n \\"FileModel\\": {\\n \\"UploadUrl\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E26977****\\",\\n \\"FileId\\": \\"646ec2f662b1e08f7a2b4d648982f906****\\",\\n \\"UploadId\\": \\"20BE155AC20943BE9D405B0997A9****\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateCdsFile', - 'description' => 'After the RAM permissions are authenticated, you can call the CreateCdsFile operation to obtain the upload URL of a file and upload the file to a cloud disk.'."\n", - ], - 'CompleteCdsFile' => [ - 'summary' => 'After you create an object upload task, call this operation to upload the object.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"DesktopName\\": \\"test\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DiskStatus\\": \\"Available\\",\\n \\"Creator\\": \\"Administrator\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"DeletionTime\\": \\"2020-12-20T14:52:28Z\\\\n\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the list and details of snapshots for cloud desktops', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-10T09:28:15.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-15T02:17:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-01T07:41:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-19T06:39:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:48.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:48.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSnapshots'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DescribeTemplates' => [ + 'summary' => 'Queries the details of cloud computer templates.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'TemplateIds', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The list of template IDs to query.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the template to query.', 'type' => 'string', 'required' => false, 'example' => 'b-216bi6zpvsy****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The username. You must specify at least one of `EndUserId` and `GroupId`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test0', - ], + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The template name used for the query.', 'type' => 'string', 'required' => false, 'example' => 'My cloud desktop template 001'], ], [ - 'name' => 'CdsId', - 'in' => 'query', + 'name' => 'TemplateType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", + 'title' => '', + 'description' => 'The templatetype to query. If this parameter is not specified, templates of all types are queried.', + 'enumValueTitles' => ['USER_TEMPLATE' => 'user-defined template.', 'SYSTEM_TEMPLATE' => 'system template provided by Alibaba Cloud.'], 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai+cds-465878****', + 'required' => false, + 'example' => 'USER_TEMPLATE', ], ], [ - 'name' => 'UploadId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the file upload task. Callable interface [CreateCdsFile](~~2247619~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6C48B55A1FAC4E1A9E0579059514****', - ], + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The cloud computer image ID. You can obtain the ID from the image management page. System images, custom images, and other image types are supported.', 'type' => 'string', 'required' => false, 'example' => 'm-dnz9xjgbm8*****', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '635a316c94f40f35f5354da29b2aee88c9d1****', - ], + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword. Fuzzy match is supported for the template ID and template name fields.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'GroupId', - 'in' => 'query', + 'name' => 'ProductType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the team space. You must specify at least one of `EndUserId` and `GroupId`.'."\n", + 'title' => '', + 'description' => 'The product type. Set this parameter to `CloudDesktop`.', + 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'], 'type' => 'string', 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', + 'example' => 'CloudDesktop', ], ], + [ + 'name' => 'BizRegionId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The region filter condition for the template query. '."\n" + ."\n" + .'> If this parameter is specified, region-specific configurations that do not match are excluded from the query results.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => '> This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number of the current page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of rows per page in a paged query. This parameter is used for paging.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'required' => false, 'example' => '20', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'ListResult', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****', + 'Data' => [ + 'description' => 'The list of queried template information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => ['description' => 'The creation time of the template (UTC).', 'type' => 'string', 'example' => '2025-04-25T05:18:46.000+00:00', 'title' => ''], + 'GmtModified' => ['description' => 'The last modification time of the template (UTC).', 'type' => 'string', 'example' => '2025-04-25T05:18:46.000+00:00', 'title' => ''], + 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'b-0caoeogs88y*****', 'title' => ''], + 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'My template 001', 'title' => ''], + 'Description' => ['description' => 'The template description.', 'type' => 'string', 'example' => 'My template', 'title' => ''], + 'TemplateType' => [ + 'description' => 'The templatetype.', + 'enumValueTitles' => ['USER_TEMPLATE' => 'user-defined template.', 'SYSTEM_TEMPLATE' => 'system template.'], + 'type' => 'string', + 'example' => 'USER_TEMPLATE', + 'title' => '', + ], + 'ProductType' => [ + 'description' => 'The product type.', + 'enumValueTitles' => ['CloudDesktop' => 'cloud computer.'], + 'type' => 'string', + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + 'SystemDiskSize' => ['description' => 'The system cloud disk size. Unit: GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'SystemDiskPerformanceLevel' => [ + 'description' => 'The system cloud disk type.', + 'enumValueTitles' => ['PL1' => 'ESSD PL1.', 'PL0' => 'ESSD PL0.', 'AutoPL' => 'SSD.'], + 'type' => 'string', + 'example' => 'AutoPL', + 'title' => '', + ], + 'DataDiskList' => [ + 'description' => 'The size and specification configurations of data cloud disks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => ['description' => 'The data cloud disk size. Unit: GiB.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'PerformanceLevel' => [ + 'description' => 'The performance level of the data cloud disk.', + 'enumValueTitles' => ['PL1' => 'ESSD PL1.', 'PL0' => 'ESSD PL0.', 'AutoPL' => 'SSD.'], + 'type' => 'string', + 'example' => 'AutoPL', + 'title' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ImageId' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'm-5q8ehbihx*****', 'title' => ''], + 'ImageType' => [ + 'description' => 'The image type.', + 'enumValueTitles' => ['User' => 'custom image.', 'Shared' => 'shared image.', 'System' => 'system image.', 'Community' => 'community image.'], + 'type' => 'string', + 'example' => 'User', + 'title' => '', + ], + 'DefaultLanguage' => [ + 'description' => 'The default startup language configured in the template.', + 'enumValueTitles' => ['en-US' => 'English.', 'zh-HK' => 'Traditional Chinese (Hong Kong).', 'zh-CN' => 'Simplified Chinese.', 'ja-JP' => 'Japanese.'], + 'type' => 'string', + 'example' => 'zh-CN', + 'title' => '', + ], + 'PolicyGroupId' => ['description' => 'The policy group ID.', 'type' => 'string', 'example' => 'pg-0caoeogkhz*****', 'title' => ''], + 'TimerGroupId' => ['description' => 'The scheduled task group ID.', 'type' => 'string', 'example' => 'bcc-dweha*****', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-a5fqjjqaejt***', 'title' => ''], + 'ResourceTagList' => [ + 'description' => 'The cloud computer tags in key-value format.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RegionConfigList' => [ + 'description' => 'The region-specific configuration parameters.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''], + 'SnapshotPolicyId' => ['description' => 'The snapshot policy ID.', 'type' => 'string', 'example' => 'sp-b9fasjuu0*****', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-beijing+dir-3040*****', 'title' => ''], + 'SubnetId' => ['description' => 'The subnet ID.', 'type' => 'string', 'example' => 'vsw-dgea1*****', 'title' => ''], + 'VolumeEncryptionEnable' => ['description' => 'Indicates whether disk encryption is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'VolumeEncryptionKey' => ['description' => 'The KMS key ID used when disk encryption is enabled.', 'type' => 'string', 'example' => '3bc77be0-cbce-4a29-b07b-13f16394****', 'title' => ''], + 'ResourceInstanceType' => ['description' => 'The cloud computer instance type ID.', 'type' => 'string', 'example' => 'eds.enterprise_office.4c8g', 'title' => ''], + 'MemorySize' => ['description' => 'The memory size. Unit: MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '8192', 'title' => ''], + 'CpuCount' => ['description' => 'The number of vCPUs included in the cloud computer instance type.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU memory information. This field is displayed only when the instance type is a graphics-accelerated type.', 'type' => 'string', 'example' => '4GiB', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1871984F-51F6-5588-BAF6-******', 'title' => ''], + 'SiteConfigList' => [ + 'description' => 'The site configuration management.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => [ + 'description' => 'The site name.', + 'enumValueTitles' => ['outside_mainland' => 'Hong Kong (China), Macao (China), Taiwan (China), and overseas.', 'mainland' => 'Chinese mainland.'], + 'type' => 'string', + 'example' => 'mainland', + 'title' => '', + ], + 'AppRuleId' => ['description' => 'The application control policy ID.', 'type' => 'string', 'example' => 'bwr-5a5371e0*******', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ChargeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Period' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PeriodUnit' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AutoPay' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'AutoRenew' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'UserDuration' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PostPaidAfterUsedUp' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '94', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of rows per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The operation result. A value of `success` indicates success. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is not returned when Code is `success`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1871984F-51F6-5588-BAF6-*******', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\"\\n}","type":"json"}]', - 'title' => 'CompleteCdsFile', - ], - 'CopyCdsFile' => [ - 'summary' => 'Makes a copy of a file or folder on a drive.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Query cloud computer template details', + 'changeSet' => [ + ['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"GmtModified\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"TemplateId\\": \\"b-0caoeogs88y*****\\",\\n \\"TemplateName\\": \\"My template 001\\",\\n \\"Description\\": \\"My template\\",\\n \\"TemplateType\\": \\"USER_TEMPLATE\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"SystemDiskSize\\": 80,\\n \\"SystemDiskPerformanceLevel\\": \\"AutoPL\\",\\n \\"DataDiskList\\": [\\n {\\n \\"Size\\": \\"100\\",\\n \\"PerformanceLevel\\": \\"AutoPL\\"\\n }\\n ],\\n \\"ImageId\\": \\"m-5q8ehbihx*****\\",\\n \\"ImageType\\": \\"User\\",\\n \\"DefaultLanguage\\": \\"zh-CN\\",\\n \\"PolicyGroupId\\": \\"pg-0caoeogkhz*****\\",\\n \\"TimerGroupId\\": \\"bcc-dweha*****\\",\\n \\"ResourceGroupId\\": \\"rg-a5fqjjqaejt***\\",\\n \\"ResourceTagList\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"RegionConfigList\\": [\\n {\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"SnapshotPolicyId\\": \\"sp-b9fasjuu0*****\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-3040*****\\",\\n \\"SubnetId\\": \\"vsw-dgea1*****\\",\\n \\"VolumeEncryptionEnable\\": false,\\n \\"VolumeEncryptionKey\\": \\"3bc77be0-cbce-4a29-b07b-13f16394****\\",\\n \\"ResourceInstanceType\\": \\"eds.enterprise_office.4c8g\\",\\n \\"MemorySize\\": 8192,\\n \\"CpuCount\\": 4,\\n \\"GpuSpec\\": \\"4GiB\\"\\n }\\n ],\\n \\"RequestId\\": \\"1871984F-51F6-5588-BAF6-******\\",\\n \\"SiteConfigList\\": [\\n {\\n \\"SiteId\\": \\"mainland\\",\\n \\"AppRuleId\\": \\"bwr-5a5371e0*******\\"\\n }\\n ],\\n \\"ChargeType\\": \\"\\",\\n \\"Period\\": 0,\\n \\"PeriodUnit\\": \\"\\",\\n \\"AutoPay\\": false,\\n \\"AutoRenew\\": false,\\n \\"UserDuration\\": \\"\\",\\n \\"PostPaidAfterUsedUp\\": false\\n }\\n ],\\n \\"TotalCount\\": 94,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1871984F-51F6-5588-BAF6-*******\\"\\n}","type":"json"}]', + ], + 'DescribeTimerGroup' => [ + 'summary' => 'Retrieves details for a specified configuration group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region list.', + 'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'CdsId', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the configuration group.', 'type' => 'string', 'required' => true, 'example' => 'cg-hs3i1w39o68ma****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-352282****', + 'title' => '', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'Data' => [ + 'description' => 'The details of the timer group.', + 'type' => 'object', + 'properties' => [ + 'GroupId' => ['description' => 'The ID of the timer group.', 'type' => 'string', 'example' => 'cg-75aazkg2tnqb2*****', 'title' => ''], + 'Name' => ['description' => 'The name of the timer group.', 'type' => 'string', 'example' => 'Scheduled task', 'title' => ''], + 'Description' => ['description' => 'The description of the timer group.', 'type' => 'string', 'example' => 'Scheduled task', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the timer group.', + 'enumValueTitles' => ['Timer' => 'scheduled task'], + 'type' => 'string', + 'example' => 'Timer', + 'title' => '', + ], + 'ProductType' => [ + 'description' => 'The product type that the timer group supports.', + 'enumValueTitles' => ['CLOUD_DESKTOP' => 'cloud computer'], + 'type' => 'string', + 'example' => 'CLOUD_DESKTOP', + 'title' => '', + ], + 'ConfigTimers' => [ + 'description' => 'The configurations of the scheduled tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a scheduled task.', + 'type' => 'object', + 'properties' => [ + 'TimerType' => [ + 'description' => 'The type of the scheduled task.', + 'enumValueTitles' => ['NoOperationDisconnect' => 'disconnect after inactivity', 'NoConnect' => 'A task triggered if no user connects. You must specify the `OperationType`.', 'TimerBoot' => 'start on schedule', 'TimerReset' => 'reset on schedule', 'NoOperationShutdown' => 'shut down after inactivity', 'NoOperationHibernate' => 'hibernate after inactivity', 'TimerShutdown' => 'shut down on schedule', 'NoOperationReboot' => 'restart after inactivity', 'TimerReboot' => 'restart on schedule'], + 'type' => 'string', + 'example' => 'TimerBoot', + 'title' => '', + ], + 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n", 'title' => ''], + 'Interval' => ['description' => 'The interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Enforce' => ['description' => 'Specifies whether to force the execution of the scheduled task. If set to `true`, the task runs regardless of the cloud computer\'s status or connection state.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ResetType' => [ + 'description' => 'The reset type for the scheduled reset task.', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => 'Reset the system disk.', 'RESET_TYPE_USER_DISK' => 'Reset the data disk.', 'RESET_TYPE_BOTH' => 'Reset both the system and data disks.'], + 'type' => 'string', + 'example' => 'RESET_TYPE_SYSTEM', + 'title' => '', + ], + 'AllowClientSetting' => ['description' => 'Whether to allow end users to configure the scheduled task.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OperationType' => [ + 'description' => 'The operation to perform when `TimerType` is set to `NoConnect`.', + 'enumValueTitles' => ['Hibernate' => 'hibernate', 'Shutdown' => 'shut down'], + 'type' => 'string', + 'example' => 'Shutdown', + 'title' => '', + ], + 'TriggerType' => [ + 'description' => 'The detection method for user inactivity.', + 'enumValueTitles' => ['Advanced' => 'smart detection', 'Standard' => 'standard detection'], + 'type' => 'string', + 'example' => 'Standard', + 'title' => '', + ], + 'ProcessWhitelist' => [ + 'description' => 'The process whitelist for smart detection. A scheduled task based on user inactivity does not run if a whitelisted process is running.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'example' => 'chrome', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'SegmentTimers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartCronExpression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndCronExpression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OperationType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Interval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TriggerType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProcessWhitelist' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Timezone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Enforce' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'ResetType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ImageId' => ['title' => '', 'description' => 'The image ID for a scheduled image-change task.', 'type' => 'string', 'example' => 'm-5b0vjqbiqu010XXXXXX'], + 'LockScreenTime' => ['title' => '', 'description' => 'The duration of user inactivity, in seconds, before the screen locks. This feature applies only to cloud computers joined to an Active Directory (AD) domain.', 'type' => 'integer', 'format' => 'int32', 'example' => '1800'], + 'AppointmentTimer' => ['title' => '', 'description' => 'The time to execute the scheduled task, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764660600967'], + 'PatchId' => ['type' => 'string', 'example' => 'KB5082063', 'description' => '', 'title' => ''], + 'CreateSnapshot' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + 'VerificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IpSegments' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'BindCount' => ['description' => 'The number of resources associated with the timer group.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the timer group.', + 'enumValueTitles' => ['AVAILABLE' => 'available', 'UNAVAILABLE' => 'deleted', 'DELETING' => 'deleting', 'UPDATING' => 'updating'], + 'type' => 'string', + 'example' => 'AVAILABLE', + 'title' => '', + ], + 'BindCountMap' => [ + 'description' => 'A map of associated resource counts, categorized by resource type.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The number of associated resources of a specific type.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'IsBind' => ['title' => '', 'description' => 'Indicates that resources cannot be bound to or unbound from this timer group.', 'type' => 'boolean', 'example' => ''], + 'IsUpdate' => ['title' => '', 'description' => 'Indicates that this timer group cannot be modified.', 'type' => 'boolean', 'example' => ''], + 'InnerTimerName' => ['title' => '', 'description' => 'An internal code used by the frontend to display the name of a system-scheduled task.', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE'], + 'InnerTimerDesc' => ['title' => '', 'description' => 'An internal code used by the frontend to display the description of a system-scheduled task.', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"cg-75aazkg2tnqb2*****\\",\\n \\"Name\\": \\"Scheduled task\\",\\n \\"Description\\": \\"Scheduled task\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"ConfigTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 0 16 ? * 1,2,3,4,5,6,7\\\\n\\",\\n \\"Interval\\": 10,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"Shutdown\\",\\n \\"TriggerType\\": \\"Standard\\",\\n \\"ProcessWhitelist\\": [\\n \\"chrome\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"SegmentTimers\\": [\\n {\\n \\"StartCronExpression\\": \\"\\",\\n \\"EndCronExpression\\": \\"\\",\\n \\"OperationType\\": \\"\\",\\n \\"Interval\\": 0,\\n \\"TriggerType\\": \\"\\",\\n \\"ProcessWhitelist\\": [\\n \\"\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"TimerOrder\\": 0,\\n \\"Timezone\\": \\"\\",\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"\\",\\n \\"ImageId\\": \\"m-5b0vjqbiqu010XXXXXX\\",\\n \\"LockScreenTime\\": 1800,\\n \\"AppointmentTimer\\": 1764660600967,\\n \\"PatchId\\": \\"KB5082063\\",\\n \\"CreateSnapshot\\": false,\\n \\"VerificationTime\\": 0,\\n \\"VerificationNotificationTime\\": 0,\\n \\"IpSegments\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"BindCount\\": 50,\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsBind\\": false,\\n \\"IsUpdate\\": false,\\n \\"InnerTimerName\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE\\",\\n \\"InnerTimerDesc\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query configuration group details', + 'changeSet' => [ + ['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-26T02:20:25.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DescribeUserConnectionRecords' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileId', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID. You can call the CreateCdsFile operation to query the file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '640985a0ca2f71f489d2497682ca0bf468de****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID that you want to use to access the cloud disk.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of the cloud computer pool.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'ParentFolderId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent folder of the folder to which you want to copy the file. If you want to copy the file to the root directory, set this parameter to root.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'root', - ], + 'schema' => ['description' => 'The ID of the authorized user.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'AutoRename', + 'name' => 'EndUserType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to automatically rename the file if a file that has the same name exists in the folder to which you want to copy the file. Default value: false.'."\n" + 'description' => 'The type of the user account.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" + .'- SIMPLE: convenience account'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .'* false'."\n" + .'- AD\\_CONNECTOR: enterprise AD account'."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n" + .' '."\n" ."\n" - .' '."\n", - 'type' => 'boolean', + .' ', + 'enumValueTitles' => ['SIMPLE' => '', 'AD_CONNECTOR' => ''], + 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', + 'docRequired' => false, + 'example' => 'SIMPLE', + 'title' => '', ], ], [ - 'name' => 'FileReceiverId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '目标复制文件所在的个人空间ID（即UserId，您可以在DescribeCloudDriveUsers接口返回的报文中获取。）或者目标复制文件所在的团队空间ID（即GroupId，您可以在DescribeCloudDriveGroups接口返回的报文中获取。）'."\n" - .'> FileReceiverId和FileReceiverType都为空时，默认复制到文件所在的个人空间。'."\n" - .'>', - 'type' => 'string', - 'required' => false, - 'example' => 'user02', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'FileReceiverType', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '文件所属的空间类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'user' => '个人空间', - 'group' => '团队空间', - ], - 'example' => 'user', - ], + 'schema' => ['description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ConnectStartTimeFrom', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The time when the cloud desktop starts to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631239200000', 'title' => ''], + ], + [ + 'name' => 'ConnectStartTimeTo', + 'in' => 'query', + 'schema' => ['description' => 'The time when the cloud desktop starts to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631241000000', 'title' => ''], + ], + [ + 'name' => 'ConnectEndTimeFrom', + 'in' => 'query', + 'schema' => ['description' => 'The time when the cloud desktop stops to be connected, which is the minimum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631266200000', 'title' => ''], + ], + [ + 'name' => 'ConnectEndTimeTo', + 'in' => 'query', + 'schema' => ['description' => 'The time when the cloud desktop stops to be connected, which is the maximum value for condition filtering. The value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631268000000', 'title' => ''], + ], + [ + 'name' => 'ConnectDurationFrom', + 'in' => 'query', + 'schema' => ['description' => 'The duration when the cloud desktop is connected, which is the minimum value for condition filtering.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'ConnectDurationTo', + 'in' => 'query', + 'schema' => ['description' => 'The duration when the cloud desktop is connected, which is the maximum value for condition filtering.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-138dsptkrt00u****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '93AD30C1-16B8-5C54-AD23-A51FF53F****', - ], - 'Code' => [ - 'description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'CopyCdsFileModel' => [ - 'description' => 'The details about the file copying.'."\n", - 'type' => 'object', - 'properties' => [ - 'AsyncTaskId' => [ - 'description' => 'The ID of the asynchronous task. This parameter is not returned if you copy a file. This parameter is returned if you copy a folder in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and details of an asynchronous task.'."\n", - 'type' => 'string', - 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d31****', - ], - 'FileId' => [ - 'description' => 'The ID of the copied file or folder.'."\n", - 'type' => 'string', - 'example' => '6400727cb878821bcb414615a609b4072463****', - ], - ], + 'NextToken' => ['description' => 'The token that is used to start the next query.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03', 'title' => ''], + 'ConnectionRecords' => [ + 'description' => 'The connection records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The connection record.', + 'type' => 'object', + 'properties' => [ + 'ConnectionRecordId' => ['description' => 'The ID of the connection record.', 'type' => 'string', 'example' => '528', 'title' => ''], + 'ConnectStartTime' => ['description' => 'The time when the end user connected to the cloud computer.', 'type' => 'string', 'example' => '2022-01-19T10:12:38Z', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud computer to which the end user connected.', 'type' => 'string', 'example' => 'demoComputer', 'title' => ''], + 'ConnectDuration' => ['description' => 'The connection duration. Unit: milliseconds.', 'type' => 'string', 'example' => '1800000', 'title' => ''], + 'ConnectEndTime' => ['description' => 'The time when the end user disconnected from the cloud computer.', 'type' => 'string', 'example' => '2022-02-27T20:03:13Z', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud computer to which the end user connected.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"93AD30C1-16B8-5C54-AD23-A51FF53F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": \\"true\\",\\n \\"CopyCdsFileModel\\": {\\n \\"AsyncTaskId\\": \\"4221bf6e6ab43a255edc4463bffa6f5f5d31****\\",\\n \\"FileId\\": \\"6400727cb878821bcb414615a609b4072463****\\"\\n }\\n}","type":"json"}]', - 'title' => 'CopyCdsFile', - ], - 'ListCdsFiles' => [ - 'summary' => 'Queries the list of files in the network disk and obtain the download link of the file.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeUserConnectionRecords', + 'summary' => 'Queries the connection records of an authorized user to cloud computers in a cloud computer pool.', + 'changeSet' => [ + ['createdAt' => '2022-05-13T03:56:50.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserConnectionRecords'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUserConnectionRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\",\\n \\"ConnectionRecords\\": [\\n {\\n \\"ConnectionRecordId\\": \\"528\\",\\n \\"ConnectStartTime\\": \\"2022-01-19T10:12:38Z\\",\\n \\"DesktopName\\": \\"demoComputer\\",\\n \\"ConnectDuration\\": \\"1800000\\",\\n \\"ConnectEndTime\\": \\"2022-02-27T20:03:13Z\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeUsersInGroup' => [ + 'summary' => 'This operation queries the details of all authorized users in a cloud desktop group, including their usernames, email addresses, phone numbers, and the IDs of their authorized cloud desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EndUserId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user to which the network disk is assigned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testUser', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to get a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], + 'schema' => ['description' => 'The shared cloud desktop ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8ttn55ujj8nj8****', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-320357****', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ParentFileId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The parent folder ID. You can obtain the value by using the response parameter `FileId` of this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '63636837e47e5a24a8a940218bef395c210e****', - ], + 'schema' => ['description' => 'The token to start the next query. An empty value indicates that all results have been returned.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'FileIds', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the files to be queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the file to be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[\\"635d3c12f70beed7b6f84a9bb7bd51aad910****\\"]', - ], - 'required' => false, - 'maxItems' => 50, - ], + 'schema' => ['description' => 'The ID of the authorized user.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'OrderType', + 'name' => 'ConnectState', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting method of the files.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateTimeDesc: sorts the by creation time in descending order.'."\n" - .'* ModifiedTimeAsc: sort the by modification time in ascending order.'."\n" - .'* NameDesc: sorts the by file name in descending order.'."\n" - .'* SizeAsc: sorts by file size in ascending order.'."\n" - .'* ModifiedTimeDesc: sort the by modification time in descending order.'."\n" - .'* CreateTimeAsc: sorts the by creation time in ascending order.'."\n" - .'* SizeDesc: sorts by file size in descending order.'."\n" - .'* NameAsc: sorts by file name in ascending order.'."\n", - 'type' => 'string', + 'description' => 'The connection status of the user.', + 'enumValueTitles' => ['Disconnected', 'Connected'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - 'CreateTimeDesc' => '', - 'ModifiedTimeAsc' => '', - 'NameDesc' => '', - 'SizeAsc' => '', - 'ModifiedTimeDesc' => '', - 'CreateTimeAsc' => '', - 'SizeDesc' => '', - 'NameAsc' => '', - ], - 'example' => 'CreateTimeDesc', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'Status', + 'name' => 'QueryUserDetail', 'in' => 'query', 'schema' => [ - 'description' => 'The file status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* available: returns only normal file.'."\n" - .'* uploading: returns only the of objects that are being uploaded.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to query user details.', + 'enumValueTitles' => ['true' => 'Queries user details. (Default)', 'false' => 'Does not query user details.'], + 'type' => 'boolean', + 'default' => 'true', 'required' => false, - 'enumValueTitles' => [ - 'available' => '', - 'uploading' => '', - ], - 'example' => 'available', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The query token. Set the value to the value of the `NextToken` parameter returned in the last call to the operation. You do not need to set this parameter when you call the operation for the first time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'WyI2Mzg4MjAwMzFhNGQwZWVmN2I3MjRkZjZhZjAyMWU4YzY1MmRjZmUyIiwibiIsIm4iLDEsLTEsMTY2OTg2NTQ3NTMxMiwiNjM4ODIwMDNlNTU0YmZiZjFkYTk0MmEyYTZhMjEyZDkxODdjMjAy****', - ], + 'schema' => ['description' => 'The string for a partial match query. Results that contain this string are returned.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'OrgId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '100', - ], + 'schema' => ['description' => 'The ID of the organization to which the user belongs.', 'type' => 'string', 'required' => false, 'example' => 'org-d0fua2oyukw8j****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'EndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the logon region. You can call the [DescribeRegions](~~196646~~) operation to obtain the list of regions supported by cloud computers.'."\n", - 'type' => 'string', + 'description' => 'A list of authorized user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the authorized user. Only exact matches are supported.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'example' => 'cn-hangzhou', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The collection of returned information.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token used to start the next query. If the `NextToken` is empty, the next query does not exist.'."\n", - 'type' => 'string', - 'example' => 'WyI2MzhmMjA2ZTFmZGZlZGVjZDk3OTRlNzVhZmIwMDFiZmM5NWQ3YTgwIiwibiIsIm4iLDEsLTEsMTY3MDMyNDMzNTAzMSwiNjM4ZjIwNmZjNDFkMzIwOTZmZWU0NGYxODkwY2I5ZjI0Mjg0NzM2****', - ], - 'RequestId' => [ - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '40D86754-20FD-53DC-A9B8-25F7FECC****', - ], - 'Count' => [ - 'description' => 'The total number of file list entries.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Code' => [ - 'description' => 'The response parameters. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'Error message. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'FileModels' => [ - 'description' => 'The files.'."\n", + 'NextToken' => ['description' => 'The token to start the next query.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'UsersCount' => ['description' => 'The total number of authorized users in the cloud desktop group who meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OnlineUsersCount' => ['description' => 'The total number of authorized users in the cloud desktop group who meet the query conditions and are connected to a cloud desktop.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'UserOuPath' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndUsers' => [ + 'description' => 'A list of authorized user information.', 'type' => 'array', 'items' => [ - 'description' => 'The file information.'."\n", + 'description' => 'The information of an authorized user.', 'type' => 'object', 'properties' => [ - 'ContentType' => [ - 'description' => 'The content type of the file.'."\n", - 'type' => 'string', - 'example' => 'application/json', - ], - 'FileType' => [ - 'description' => 'The file type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* file'."\n" - .'* folder'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'file' => '', - 'folder' => '', - ], - 'example' => 'file', - ], - 'FileExtension' => [ - 'description' => 'The filename extension.'."\n", - 'type' => 'string', - 'example' => 'pdf', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '637725ff2f63db8470984e6c92c692b87d52****', - ], - 'Creator' => [ - 'description' => 'The file creator.'."\n", - 'type' => 'string', - 'example' => 'user01', - ], - 'OpenTime' => [ - 'description' => 'The time when the file was last opened.'."\n", - 'type' => 'string', - 'example' => '2022-09-06T07:27:08Z', - ], - 'ParentId' => [ - 'description' => 'The ID of the parent folder.'."\n", - 'type' => 'string', - 'example' => '3343213ff2f63db8470984e6c92c3213dfdw****'."\n", - ], - 'Modifier' => [ - 'description' => 'Modifier.'."\n", - 'type' => 'string', - 'example' => 'user02', - ], - 'Description' => [ - 'description' => 'The file description.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'Name' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'fvt-appcenterp4qwa', - ], - 'DownloadUrl' => [ - 'description' => 'The download link. The default validity period is 15 minutes.'."\n", - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], - 'Sha1' => [ - 'description' => 'The SHA1 hash of the data file.'."\n", - 'type' => 'string', - 'example' => 'EA4942AA8761213890A5C386F88E6464D2C3****', - ], - 'OpenTimeStamp' => [ - 'description' => 'The timestamp that indicates the time when the file was last opened.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '168951245231', - ], - 'RegionId' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to obtain the list of regions supported by cloud computers.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'FilePath' => [ - 'description' => 'The file path.'."\n", - 'type' => 'string', - 'example' => 'isv/1019236948660053/temp/', - ], - 'Size' => [ - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '102400', - ], - 'Category' => [ - 'description' => 'File type classification. The network disk will classify files according to their suffix and MIME Type. The main categories are `doc`, `image`, `audio` and `video`.'."\n", - 'type' => 'string', - 'example' => 'image', - ], - 'Md5' => [ - 'description' => 'The MD5 hash of the object.'."\n", + 'EndUserId' => ['description' => 'The ID of the authorized user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'EndUserEmail' => ['description' => 'The email address of the authorized user.', 'type' => 'string', 'example' => 'alice@example.com', 'title' => ''], + 'DesktopName' => ['description' => 'The name of the cloud desktop.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'ConnectionStatus' => [ + 'description' => 'The connection status.', + 'enumValueTitles' => ['Disconnected', 'Connecting'], 'type' => 'string', - 'example' => '63c83ececb4e6926c51448fc5ecb****', + 'example' => '1', + 'title' => '', ], - 'Thumbnail' => [ - 'description' => 'The URL of the thumbnail.'."\n", + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'EndUserType' => [ + 'description' => 'The user account type.', + 'enumValueTitles' => ['SIMPLE' => 'Convenience account', 'AD_CONNECTOR' => 'Enterprise Active Directory (AD) account'], 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', + 'example' => 'SIMPLE', + 'title' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the file was created.'."\n", - 'type' => 'string', - 'example' => '2022-09-06T07:27:08Z', + 'EndUserPhone' => ['description' => 'The phone number of the authorized user.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], + 'EndUserName' => ['description' => 'The username of the authorized user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ExternalInfo' => [ + 'description' => 'Additional information.', + 'type' => 'object', + 'properties' => [ + 'ExternalName' => ['description' => 'The external name.', 'type' => 'string', 'example' => 'nameDemo', 'title' => ''], + 'JobNumber' => ['description' => 'The employee ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ModifiedTime' => [ - 'description' => 'The time when the file was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-09-06T07:27:08Z', + 'UserSetPropertiesModels' => [ + 'description' => 'A list of user seat information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The user seat information.', + 'type' => 'object', + 'properties' => [ + 'UserId' => ['description' => 'The user ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => 'nameDemo', 'title' => ''], + 'PropertyId' => ['description' => 'The property ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'PropertyKey' => ['description' => 'The property name.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'PropertyType' => [ + 'description' => 'The property type.', + 'enumValueTitles' => [1 => 'System property', 'Custom property'], + 'type' => 'integer', + 'format' => 'int32', + 'exclusiveMinimum' => false, + 'example' => '1', + 'title' => '', + ], + 'PropertyValues' => [ + 'description' => 'An array of property values.', + 'type' => 'array', + 'items' => [ + 'description' => 'A property value object.', + 'type' => 'object', + 'properties' => [ + 'PropertyValueId' => ['description' => 'The property value ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'PropertyValue' => ['description' => 'The property value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'UserDesktopId' => ['description' => 'The ID of the virtual cloud desktop assigned to the user.', 'type' => 'string', 'example' => 'ud-i896ze8hazpvl****', 'title' => ''], + 'EndUserRemark' => ['description' => 'The user remarks.', 'type' => 'string', 'example' => 'Note', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the enterprise AD account.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'UserPrincipalName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayNameNew' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\\\n\\",\\n \\"RequestId\\": \\"40D86754-20FD-53DC-A9B8-25F7FECC****\\",\\n \\"Count\\": \\"2\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"FileModels\\": [\\n {\\n \\"ContentType\\": \\"application/json\\",\\n \\"FileType\\": \\"file\\",\\n \\"FileExtension\\": \\"pdf\\",\\n \\"FileId\\": \\"637725ff2f63db8470984e6c92c692b87d52****\\",\\n \\"Creator\\": \\"demo_user01@cn-shanghai.148875033399****\\",\\n \\"OpenTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ParentId\\": \\"3343213ff2f63db8470984e6c92c3213dfdw****\\\\n\\",\\n \\"Modifier\\": \\"demo_user02@cn-shanghai.148875033399****\\",\\n \\"Description\\": \\"test1\\",\\n \\"Name\\": \\"SampleFile.pdf\\",\\n \\"DownloadUrl\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Sha1\\": \\"EA4942AA8761213890A5C386F88E6464D2C3****\\",\\n \\"OpenTimeStamp\\": 168951245231,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"FilePath\\": \\"isv/1019236948660053/temp/\\",\\n \\"Size\\": 102400,\\n \\"Category\\": \\"image\\",\\n \\"Md5\\": \\"63c83ececb4e6926c51448fc5ecb****\\",\\n \\"Thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"CreateTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ModifiedTime\\": \\"2022-09-06T07:27:08Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListCdsFiles', - ], - 'GetAsyncTask' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeUsersInGroup', + 'changeSet' => [ + ['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-10T09:08:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-17T03:44:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-13T08:12:45.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-04-13T08:12:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersInGroup'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UsersCount\\": 1,\\n \\"OnlineUsersCount\\": 0,\\n \\"UserOuPath\\": \\"\\",\\n \\"UserGroupName\\": \\"\\",\\n \\"EndUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EndUserEmail\\": \\"alice@example.com\\",\\n \\"DesktopName\\": \\"testName\\",\\n \\"ConnectionStatus\\": \\"1\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"EndUserType\\": \\"SIMPLE\\",\\n \\"EndUserPhone\\": \\"1381111****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"nameDemo\\",\\n \\"JobNumber\\": \\"123\\"\\n },\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 123,\\n \\"UserName\\": \\"nameDemo\\",\\n \\"PropertyId\\": 123,\\n \\"PropertyKey\\": \\"key\\",\\n \\"PropertyType\\": 1,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 123,\\n \\"PropertyValue\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"UserDesktopId\\": \\"ud-i896ze8hazpvl****\\",\\n \\"EndUserRemark\\": \\"Note\\",\\n \\"DisplayName\\": \\"alice\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeUsersPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'CdsId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+cds-135515****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AsyncTaskId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The asynchronous task ID. This parameter is not returned if you copy files. This parameter is returned if you copy folders in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and information about an asynchronous task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '81a8a07a-aec4-4dd5-80da-ae69e482****', - ], + 'schema' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-gq8u6whi9f6k8****', 'title' => ''], ], ], 'responses' => [ @@ -26534,688 +24742,552 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The operation result. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Failed: The task failed.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running: The task was running.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PartialSucceed: The task did not completely succeed.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Succeed: The task succeeded.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Failed' => '', - 'Running' => '', - 'PartialSucceed' => '', - 'Succeed' => '', - ], - 'example' => 'Failed', - ], - 'TotalProcess' => [ - 'description' => 'The total number of asynchronous tasks to be processed, such as the amount of files to be downloaded and packaged on the server.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'Url' => [ - 'description' => 'The URL to download data generated by the asynchronous task. Example: the URL to package and download tasks on the server.'."\n", - 'type' => 'string', - 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', - ], - 'ErrCode' => [ - 'description' => 'The error code of the asynchronous task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'InternalError', - ], - 'AsyncTaskId' => [ - 'description' => 'The asynchronous task ID.'."\n", - 'type' => 'string', - 'example' => '000e89fb-cf8f-11e9-8ab4-b6e98080****', - ], - 'Message' => [ - 'description' => 'The error message of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => 'The request has been failed due to some unknown error. Please try again later.', - ], - 'ConsumedProcess' => [ - 'description' => 'The total number of asynchronous tasks that are processed. Example: the number of files that are packaged and downloaded on the server.'."\n", - 'type' => 'string', - 'example' => '100', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'F7B4B17B-5C8A-514C-AA4D-F8090E3A63E9', 'title' => ''], + 'DesktopUsers' => [ + 'description' => 'The authorized users of the cloud computer.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the user.'."\n", + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => 'The display name of the end user.'."\n", 'type' => 'string', 'example' => 'demo_user01_1488****', 'title' => ''], + 'Password' => ['description' => 'The password of the end user.'."\n", 'type' => 'string', 'example' => '3q8p-NDey-2Nac-TWcQ-****', 'title' => ''], + 'EndUserId' => ['description' => 'The ID of the end user.'."\n", 'type' => 'string', 'example' => 'demo_user01', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"Failed\\",\\n \\"TotalProcess\\": 1000,\\n \\"Url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"ErrCode\\": 0,\\n \\"AsyncTaskId\\": \\"000e89fb-cf8f-11e9-8ab4-b6e98080****\\",\\n \\"Message\\": \\"The request failed due to some unknown errors. Please try again later.\\",\\n \\"ConsumedProcess\\": \\"100\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetAsyncTask', - 'summary' => 'When you call the CopyCdsFile operation to copy a folder, the operation returns AsyncTaskId. Call this operation specifying the obtained AsyncTaskId, and you can query the information about the asynchronous task.', - ], - 'ModifyCdsFile' => [ - 'summary' => 'Modifies the attributes of a disk file or folder, such as the file name.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7B4B17B-5C8A-514C-AA4D-F8090E3A63E9\\",\\n \\"DesktopUsers\\": [\\n {\\n \\"DisplayName\\": \\"demo_user01_1488****\\",\\n \\"Password\\": \\"3q8p-NDey-2Nac-TWcQ-****\\",\\n \\"EndUserId\\": \\"demo_user01\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeUsersPassword', + 'summary' => 'Queries the passwords for the accounts within a cloud computer image. For example, when the Chrome browser on the cloud computer queries the cached password, it requires the end user to enter the password for identity verification.', + 'changeSet' => [ + ['createdAt' => '2022-08-04T10:18:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersPassword'], + ], ], + 'ramActions' => [], + ], + 'DescribeVirtualMFADevices' => [ + 'summary' => 'Retrieves the virtual multi-factor authentication (MFA) device associated with an Active Directory (AD) account.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who uses the network disk.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The enterprise drive ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-64326*****', - ], + 'schema' => ['description' => 'The maximum number of entries to return. Valid values: 1 to 500. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '100', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', - ], + 'schema' => ['description' => 'The pagination token. If a response is truncated, use the returned `NextToken` to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test.txt'."\n", - 'maxLength' => 1024, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-269345****', 'title' => ''], ], [ - 'name' => 'ConflictPolicy', + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The processing policy when a file with the same name appears.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* refuse: If you want to create a file that uses the same name as an existing file in the cloud, the system denies your request and returns the details of the existing file.'."\n" - .'* auto_rename: automatically renames a file if the file has the same name as an existing file in the cloud. By default, the current point in time is appended to the end of the original file name. Example: xxx20240102\\_150405.'."\n" - .'* ignore: allows the file to be with the same name.'."\n" - .'* over_write: After you create a file that uses the same name as an existing file in the cloud, the new file overwrites the existing file.'."\n", - 'type' => 'string', + 'description' => 'The list of Active Directory (AD) account usernames.', + 'type' => 'array', + 'items' => ['description' => 'An Active Directory (AD) account username.', 'type' => 'string', 'required' => false, 'example' => 'testuser', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'refuse' => '', - 'auto_rename' => '', - 'ignore' => '', - 'over_write' => '', - ], - 'example' => 'ignore', - 'default' => 'refuse', - 'enum' => [ - 'refuse', - 'auto_rename', - 'ignore', - ], + 'example' => 'testuser', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Code' => [ - 'description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Specifies whether data is returned.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* false: Data fails to be returned.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' : Data is returned.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - ' false' => '', - 'true' => '', + 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is empty, no more results are available.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403', 'title' => ''], + 'VirtualMFADevices' => [ + 'description' => 'A list of virtual MFA devices.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a virtual MFA device.', + 'type' => 'object', + 'properties' => [ + 'SerialNumber' => ['description' => 'The serial number of the virtual MFA device.', 'type' => 'string', 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', 'title' => ''], + 'GmtUnlock' => ['description' => 'The time when the locked virtual MFA device is automatically unlocked. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC, as specified by the [ISO 8601](~~25696~~) standard.', 'type' => 'string', 'example' => '2020-12-21T15:21:28Z', 'title' => ''], + 'EndUserId' => ['description' => 'The AD username of the bound user.', 'type' => 'string', 'example' => 'usertest', 'title' => ''], + 'ConsecutiveFails' => ['description' => 'The number of consecutive failed attempts to bind or authenticate the virtual MFA device.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The workspace ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-269345****', 'title' => ''], + 'status' => [ + 'description' => 'The status of the virtual MFA device.', + 'enumValueTitles' => ['LOCKED' => 'locked', 'UNBOUND' => 'unbound', 'NORMAL' => 'normal'], + 'type' => 'string', + 'example' => 'NORMAL', + 'title' => '', + ], + 'DirectoryId' => ['description' => '> This parameter is in private preview.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'GmtEnabled' => ['description' => 'The time when the virtual MFA device was enabled. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and in UTC, as specified by the [ISO 8601](~~25696~~) standard.', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z', 'title' => ''], + 'AdUser' => [ + 'type' => 'object', + 'properties' => [ + 'EndUser' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayNameNew' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserPrincipalName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned error message. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ModifyCdsFile', - ], - 'MoveCdsFile' => [ - 'summary' => 'Moves a file or folder on the drive to a new location.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeVirtualMFADevices', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-08-23T16:26:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-07T02:59:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVirtualMFADevices'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeVirtualMFADevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as\\",\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\",\\n \\"VirtualMFADevices\\": [\\n {\\n \\"SerialNumber\\": \\"a25f297f-f2e1-4a44-bbf1-5f48a6e5****\\",\\n \\"GmtUnlock\\": \\"2020-12-21T15:21:28Z\\",\\n \\"EndUserId\\": \\"usertest\\",\\n \\"ConsecutiveFails\\": 1,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-269345****\\",\\n \\"status\\": \\"NORMAL\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"GmtEnabled\\": \\"2020-12-20T14:52:28Z\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeZones' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [](t2167755.xdita#)to get the list of regions supported by EDS.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'ZoneType', 'in' => 'query', + 'schema' => ['description' => 'The zone type to query. Default value: `AvailabilityZone`. This queries standard cloud zones.', 'type' => 'string', 'required' => false, 'example' => 'AvailabilityZone', 'title' => ''], + ], + [ + 'name' => 'VpcAccessZone', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-346063****', + 'description' => 'The response elements.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Zones' => [ + 'description' => 'The information about the zones.', + 'type' => 'array', + 'items' => [ + 'description' => 'The zone.', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'DescribeZones', + 'summary' => 'Queries the zones supported by Elastic Desktop Service (EDS) in a region.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeZones'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeZones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DetachCen' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'FileId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', 'in' => 'query', + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '63f3257b68b018170b194d87b875512d108f****', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]', + 'title' => 'DetachCen', + 'summary' => 'Unbinds an advanced office network from a CEN instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachCen'], + ], + ], + 'ramActions' => [], + ], + 'DetachEndUser' => [ + 'summary' => 'Unbinds a hardware client from a user.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'DeviceId', + 'in' => 'query', + 'schema' => ['description' => 'The serial number (SN) of the hardware client.'."\n", 'type' => 'string', 'required' => true, 'example' => '12OERSLDO7M3****', 'title' => ''], + ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID that you want to use to access the cloud disk.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of the user that you want to unbind from the hardware client.'."\n", 'type' => 'string', 'required' => true, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'ParentFolderId', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent folder that you want to move. If you want to remove the root folder, set the value to root.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '6409848a6da91d6240604e7ba7337d85ba8a1****', - ], + 'schema' => ['description' => 'The ID of the convenient office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], ], [ - 'name' => 'ConflictPolicy', + 'name' => 'AdDomain', + 'in' => 'query', + 'schema' => ['description' => 'The address of the Active Directory (AD) office network.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****', 'title' => ''], + ], + [ + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The processing mode of files that have the same name.'."\n" + 'description' => 'The type of the client.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* '."\n" - ."\n" - .' refuse'."\n" - ."\n" - .' '."\n" - ."\n" - .' : If you want to create a file that uses the same name as an existing file in the cloud, the system denies your request and returns the details of the existing file.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' auto_rename'."\n" - ."\n" - .' '."\n" - ."\n" - .' : If you want to create a file that uses the same name as an existing file in the cloud, the system renames the file that you want to create by appending the current time point.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' ignore'."\n" - ."\n" - .' '."\n" - ."\n" - .' : The system allows you to create a file that uses the same name as an existing file in the cloud.'."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' over_write'."\n" - ."\n" - .' '."\n" - ."\n" - .' : After you create a file that uses the same name as an existing file in the cloud, the new file overwrites the existing file.'."\n" - ."\n" - .' '."\n", + .'* 1: hardware client.'."\n", 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'refuse' => '', - 'auto_rename' => '', - 'ignore' => '', - 'over_write' => '', - ], - 'example' => 'ignore', + 'required' => true, + 'enumValueTitles' => [1 => ''], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The group ID.', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* '."\n" - ."\n" - .' true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The result of the modification. A value of success indicates that the modification is successful. If the modification failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'MoveCdsFileModel' => [ - 'description' => 'The response object when you move a file.'."\n", - 'type' => 'object', - 'properties' => [ - 'AsyncTaskId' => [ - 'description' => 'The ID of the asynchronous task. This parameter is not returned if you copy files. This parameter is returned if you copy folders in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and details of an asynchronous task.'."\n", - 'type' => 'string', - 'example' => 'fe307518-825a-4c8b-a69c-958f0e8a****', - ], - 'Exist' => [ - 'description' => 'Indicates whether the file exists.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* '."\n" - ."\n" - .' true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* '."\n" - ."\n" - .' false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - 'FileId' => [ - 'description' => 'The ID of the file.'."\n", - 'type' => 'string', - 'example' => '63636837e47e5a24a8a940218bef395c210e****', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"MoveCdsFileModel\\": {\\n \\"AsyncTaskId\\": \\"fe307518-825a-4c8b-a69c-958f0e8a****\\",\\n \\"Exist\\": false,\\n \\"FileId\\": \\"63636837e47e5a24a8a940218bef395c210e****\\"\\n }\\n}","type":"json"}]', - 'title' => 'MoveCdsFile', - ], - 'DownloadCdsFile' => [ - 'summary' => 'Obtains the download link of the target file.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'DetachEndUser', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachEndUser'], + ], ], + 'ramActions' => [], + ], + 'DisableDesktopsInGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer share.', 'type' => 'string', 'required' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], + ], + [ + 'name' => 'DesktopIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computers.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'maxItems' => 1000, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'CdsId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The enterprise drive ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-643267****', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '34FB4D97-C0D9-5534-ABC6-90C7EBD5****'], + ], + 'example' => '', ], ], + ], + 'title' => 'DisableDesktopsInGroup', + 'summary' => 'Disables specific cloud computers in a cloud computer share. After you call this operation to disable specific cloud computers, they enter the unavailable state.', + 'changeSet' => [ + ['createdAt' => '2022-03-02T07:11:28.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDesktopsInGroup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '63f3257b68b018170b194d87b875512d108f****', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:DisableDesktopsInGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34FB4D97-C0D9-5534-ABC6-90C7EBD5****\\"\\n}","type":"json"}]', + ], + 'DisconnectDesktopSessions' => [ + 'summary' => 'Disconnects cloud computer sessions.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndUserId', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Sessions', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The team ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', + 'description' => 'The session details.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The end user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud desktop ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-90g15fkhsxxxn****', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PreCheck', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform precheck. If you perform precheck, the system does not disconnect from desktop sessions. Only the sessions that do not meet specific conditions are returned.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E3ED9519-DD73-5C86-9C0A-43C9281C****', - ], - 'Message' => [ - 'description' => 'The response message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DownloadFileModel' => [ - 'description' => 'The download URL of the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamUrl' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DownloadUrl' => [ - 'description' => 'The download URL.'."\n", - 'type' => 'string', - 'example' => 'https://pds-XXXX-bj-1693807057.oss-cn-beijing.aliyuncs.com/A0SKfLOp%2F2%2F6662612e0570fb2bdd5549759716d433439f0572%2F6662612ee3804e4901794928b14f9a7477640ee7?di=XXXX&dr=1030&f=667d5a322ebf7409e91c485d808fb3bd8a73efbb&response-content-disposition=attachment%3B%20', - ], - 'Size' => [ - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1594642', - ], - 'DownloadType' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ExpirationSecond' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ExpirationTime' => [ - 'description' => 'The validity period of the download URL.'."\n", - 'type' => 'string', - 'example' => '2024-07-18T02:55:49.795Z', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => '667d5a322ebf7409e91c485d808fb3bd8a73efbb', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2507CFA8-FEAB-5208-98F5-5E028C50XXXX', 'title' => ''], + 'InvalidSessions' => [ + 'description' => 'The list of invalid sessions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => 'The end user ID.'."\n", 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud desktop ID.'."\n", 'type' => 'string', 'example' => 'ecd-2jv6wugbkp65p****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3ED9519-DD73-5C86-9C0A-43C9281C****\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"DownloadFileModel\\": {\\n \\"StreamUrl\\": \\"无\\",\\n \\"DownloadUrl\\": \\"https://pds-****-bj-169380****.oss-cn-beijing.aliyuncs.com/A0SK****?di=****&dr=1030&f=667d****&response-content-disposition=attachment%3B%20\\",\\n \\"Size\\": 1594642,\\n \\"DownloadType\\": \\"无\\",\\n \\"ExpirationSecond\\": \\"无\\",\\n \\"ExpirationTime\\": \\"2024-07-18T02:55:49.795Z\\",\\n \\"FileId\\": \\"667d5a322ebf7409e91c485d808fb3bd8a73****\\"\\n }\\n}","type":"json"}]', - 'title' => 'DownloadCdsFile', - ], - 'DeleteCdsFile' => [ - 'summary' => 'Delete files or folders from the network disk.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2507CFA8-FEAB-5208-98F5-5E028C50XXXX\\",\\n \\"InvalidSessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopId\\": \\"ecd-2jv6wugbkp65p****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DisconnectDesktopSessions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisconnectDesktopSessions'], + ], ], + 'ramActions' => [], + ], + 'DissociateNetworkPackage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27226,53 +25298,76 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'NetworkPackageId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the premium bandwidth plan. You can call the [DescribeNetworkPackages](~~216079~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'np-*********', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the user who uses the network disk.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'DissociateNetworkPackage', + 'summary' => 'Unbinds a premium bandwidth plan from an office network.', + 'changeSet' => [ + ['createdAt' => '2022-05-30T01:26:35.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateNetworkPackage'], + ], + ], + 'ramActions' => [], + ], + 'DownloadCdsFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-066224****', - ], + 'schema' => ['description' => 'The enterprise drive ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-643267****', 'title' => ''], ], [ 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', - ], + 'schema' => ['description' => 'The file ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63f3257b68b018170b194d87b875512d108f****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user****', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], + 'schema' => ['description' => 'The team ID.', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], ], ], 'responses' => [ @@ -27280,631 +25375,451 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5CC5E450-FC43-4F5B-B540-9964BD31****', - ], - 'Code' => [ - 'description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the operation was successful.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Indicates whether the data is returned.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E3ED9519-DD73-5C86-9C0A-43C9281C****', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DownloadFileModel' => [ + 'description' => 'The download URL of the file.', + 'type' => 'object', + 'properties' => [ + 'StreamUrl' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download URL.', 'type' => 'string', 'example' => 'https://pds-****-bj-169380****.oss-cn-beijing.aliyuncs.com/A0SK****?di=****&dr=1030&f=667d****&response-content-disposition=attachment%3B%20', 'title' => ''], + 'Size' => ['description' => 'The size of the file. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1594642', 'title' => ''], + 'DownloadType' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'ExpirationSecond' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], + 'ExpirationTime' => ['description' => 'The validity period of the download URL.', 'type' => 'string', 'example' => '2024-07-18T02:55:49.795Z', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => '667d5a322ebf7409e91c485d808fb3bd8a73****', 'title' => ''], ], - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'Error message. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD31****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteCdsFile', - ], - 'CreateCdsFileShareLink' => [ - 'summary' => 'Creates a file sharing task.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DownloadCdsFile', + 'summary' => 'Obtains the download link of the target file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadCdsFile'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DownloadCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3ED9519-DD73-5C86-9C0A-43C9281C****\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"DownloadFileModel\\": {\\n \\"StreamUrl\\": \\"无\\",\\n \\"DownloadUrl\\": \\"https://pds-****-bj-169380****.oss-cn-beijing.aliyuncs.com/A0SK****?di=****&dr=1030&f=667d****&response-content-disposition=attachment%3B%20\\",\\n \\"Size\\": 1594642,\\n \\"DownloadType\\": \\"无\\",\\n \\"ExpirationSecond\\": \\"无\\",\\n \\"ExpirationTime\\": \\"2024-07-18T02:55:49.795Z\\",\\n \\"FileId\\": \\"667d5a322ebf7409e91c485d808fb3bd8a73****\\"\\n }\\n}","type":"json"}]', + ], + 'ExportClientEvents' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CdsId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+cds-135515****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SharePwd', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The length of the access code. Valid values: 6 to 8. Unit: bytes. If you leave this parameter empty or set it to null, no access code is required. If you use a token to share files, you do not need to configure this parameter. The access code can contain only visible ASCII characters.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '12345678', - 'maxLength' => 8, - 'minLength' => 0, - ], + 'schema' => ['description' => 'The ID of the endpoint user.', 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], ], [ - 'name' => 'Expiration', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the file sharing link expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If this parameter is set to "", the file sharing link never expires.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2020-06-28T11:33:00.000+08:00', - ], + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the file sharing task. The description must be 0 to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - 'maxLength' => 1024, - 'minLength' => 0, - ], - ], - [ - 'name' => 'ShareName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file sharing task. If you leave this parameter empty, the file name that corresponds to the first ID in the file ID list is used. The name must be 0 to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'view.txt', - 'maxLength' => 128, - 'minLength' => 0, - ], + 'schema' => ['description' => 'The cloud computer name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ - 'name' => 'DisablePreview', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to prohibit the preview of the files that are being shared.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' prohibits file preview'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' allows file preview'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'DisableSave', + 'name' => 'OfficeSiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to prohibit the dump of the files that are being shared.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' prohibits file dump'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' allows file dump'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The office network name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'DisableDownload', + 'name' => 'EventType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to prohibit the download of the files that are being shared.'."\n" + 'description' => 'The type of the event that you want to query. If you provide multiple values for EventTypes, the response will include events of all the specified types. If you provide no values for EventTypes and EventType, the response will include all events in the designated region.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' prohibits file download'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' :'."\n" - ."\n" - .' '."\n" - ."\n" - .' allows file download'."\n" - ."\n" - .' '."\n" - ."\n" - .' .'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'PreviewLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be previewed. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be previewed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '99999', - 'minimum' => '0', - 'example' => '100', - ], - ], - [ - 'name' => 'SaveLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be dumped. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be dumped.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'* DESKTOP_STOP: the shutdown event.'."\n" + .'* GET_LITE_CONNECTION_TICKET: the event of retrieving the connection ticket.'."\n" + .'* DESKTOP_DISCONNECT: the session disconnection event.'."\n" + .'* CLIENT_LOGIN: the user logon event.'."\n" + .'* GET_CONNECTION_TICKET: the connection credential retrieval event.'."\n" + .'* DESKTOP_REBOOT: the restart event.'."\n" + .'* DESKTOP_CONNECT: the session establishment event.'."\n" + .'* DESKTOP_START: the start event.'."\n", + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'maximum' => '99999', - 'minimum' => '0', - 'example' => '100', + 'enumValueTitles' => ['DESKTOP_STOP' => '', 'GET_LITE_CONNECTION_TICKET' => '', 'DESKTOP_DISCONNECT' => '', 'CLIENT_LOGIN' => '', 'GET_CONNECTION_TICKET' => '', 'DESKTOP_REBOOT' => '', 'DESKTOP_CONNECT' => '', 'DESKTOP_START' => ''], + 'example' => 'CLIENT_LOGIN', + 'title' => '', ], ], [ - 'name' => 'DownloadLimit', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be downloaded. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '99999', - 'minimum' => '0', - 'example' => '100', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'If you do not specify a value for this parameter, all events that occurred before the point in time that you specify for `EndTime` are queried.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-03-23T04:10:21Z', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'If you do not specify a value for this parameter, the current time is used.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-03-23T07:11:01Z', 'title' => ''], ], [ - 'name' => 'FileIds', + 'name' => 'EventTypes', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'repeatList', 'schema' => [ - 'description' => 'The file IDs.'."\n", + 'description' => 'The types of the events that you want to query. You can include multiple event types, and the response will return events matching the specified types or all events if none are specified.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The file ID.'."\n", + 'description' => 'The type of the event that you want to query.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DESKTOP_STOP: the shutdown event.'."\n" + .'* GET_LITE_CONNECTION_TICKET: the event of retrieving the connection ticket.'."\n" + .'* DESKTOP_DISCONNECT: the session disconnection event.'."\n" + .'* CLIENT_LOGIN: the user logon event.'."\n" + .'* GET_CONNECTION_TICKET: the connection credential retrieval event.'."\n" + .'* DESKTOP_REBOOT: the restart event.'."\n" + .'* DESKTOP_CONNECT: the session establishment event.'."\n" + .'* DESKTOP_START: the start event.'."\n", 'type' => 'string', 'required' => false, - 'example' => '['."\n" - .' "4221bf6e6ab43c255edc4463bf3a6f5f5d31****"'."\n" - .']', + 'enumValueTitles' => ['DESKTOP_STOP' => '', 'GET_LITE_CONNECTION_TICKET' => '', 'DESKTOP_DISCONNECT' => '', 'CLIENT_LOGIN' => '', 'GET_CONNECTION_TICKET' => '', 'DESKTOP_REBOOT' => '', 'DESKTOP_CONNECT' => '', 'DESKTOP_START' => ''], + 'example' => 'CLIENT_LOGIN', + 'title' => '', ], 'required' => false, - 'docRequired' => true, - 'maxItems' => 100, + 'maxItems' => 50, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GroupId', + 'name' => 'LangType', 'in' => 'query', 'schema' => [ + 'description' => 'The language displayed on the frontend page. The backend uses this setting to define the language of exported files.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* zh-CN: Simplified Chinese.'."\n" + .'* en-GB: British English.'."\n", 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['zh-CN' => '', 'en-GB' => ''], + 'example' => 'zh-CN', + 'title' => '', ], ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'* Maximum value: 5000.'."\n" + .'* Default value: 5000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - '$ref' => '#/components/schemas/CdsFileShareLinkModel', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'Url' => ['description' => 'The download URL of the exported files.'."\n", 'type' => 'string', 'example' => 'https://cn-shanghai-servicemanager.oss-cn-shanghai.aliyuncs.com/A0_CLIENT_EVENT/EDS_Events%20List_20220519234611_w5HuD83KGs.csv?Expires=1652975773&OSSAccessKeyId=****&Signature=4erMG*********k%3D', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Description\\": \\"\\",\\n \\"SaveLimit\\": 0,\\n \\"DownloadCount\\": 0,\\n \\"Creator\\": \\"\\",\\n \\"SaveCount\\": 0,\\n \\"DisableSave\\": true,\\n \\"SharePwd\\": \\"\\",\\n \\"DisablePreview\\": true,\\n \\"AccessCount\\": 0,\\n \\"ShareId\\": \\"\\",\\n \\"DownloadLimit\\": 0,\\n \\"Status\\": \\"\\",\\n \\"DriveId\\": \\"\\",\\n \\"ModifiyTime\\": \\"\\",\\n \\"DisableDownload\\": true,\\n \\"Expiration\\": \\"\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 0,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"\\",\\n \\"ShareName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ShareLink\\": \\"\\"\\n },\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateCdsFileShareLink', - ], - 'DescribeCdsFileShareLinks' => [ - 'summary' => 'Queries file sharing links of a cloud disk in Cloud Drive Service.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"https://cn-shanghai-servicemanager.oss-cn-shanghai.aliyuncs.com/A0_CLIENT_EVENT/EDS_Events%20List_20220519234611_w5HuD83KGs.csv?Expires=1652975773&OSSAccessKeyId=****&Signature=4erMG*********k%3D\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ExportClientEvents', + 'summary' => 'Exports events that occur on a cloud desktop from an Alibaba Cloud Workspace client.', + 'changeSet' => [ + ['createdAt' => '2022-11-22T03:44:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-20T05:16:56.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportClientEvents'], + ], ], + 'ramActions' => [], + ], + 'ExportDesktopGroupInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'CdsId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-532033****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ShareId', + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the office network.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-467671****', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer share.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CloudComputerPool01', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the security policy.', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], + ], + [ + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the file sharing link.'."\n", + 'description' => 'The billing method of the cloud computer share.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- PostPaid: pay-as-you-go.'."\n" + ."\n" + .'- PrePaid: subscription.', + 'enumValueTitles' => ['PostPaid' => '', 'PrePaid' => ''], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => '7JQX1Fs****'."\n", + 'example' => 'PrePaid', + 'title' => '', ], ], [ - 'name' => 'Creators', + 'name' => 'ExpiredTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The users that create the file sharing links.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user that creates the file sharing link.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], - 'required' => false, - 'docRequired' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], + 'schema' => ['description' => 'The expiration date of the subscription cloud computer share.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59Z', 'title' => ''], ], [ - 'name' => 'ShareName', + 'name' => 'DesktopGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The sharing name for fuzzy search.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computer shares.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer share. You can specify 1 to 100 IDs of cloud computer shares.', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'user', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Status', + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The file sharing status. Valid values: ● disabled: canceled ● enabled: valid'."\n", - 'type' => 'string', + 'description' => 'The IDs of the users to be authorized.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the user to be authorized. You can specify 1 to 100 user IDs.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => 'disabled', - 'enum' => [ - 'enabled', - 'disabled', - ], + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'LangType', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum number of resources to return. Valid values: 1 to 100. Default value: 100. The number of returned resources must be less than or equal to the specified number.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The language of the response.', + 'enumValueTitles' => ['zh-CN' => '', 'en-GB' => ''], + 'type' => 'string', 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '100', + 'example' => 'zh-CN', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies the marker after which the returned list begins. If this parameter is not specified, all results are returned. Default value: null.'."\n", - 'type' => 'string', + 'description' => 'The tags. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. You cannot specify an empty string as a tag key. A tag key can be up to 128 characters in length and cannot start with `acs:` or `aliyun`. The tag key cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. You can specify an empty string as a tag key. A tag value can be up to 128 characters in length and cannot start with `acs:`. The tag value cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The file sharing entity.'."\n", - '$ref' => '#/components/schemas/CdsFileShareLinkModel', - ], - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The operation result. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Url' => ['description' => 'The download URL of the XLSX file that contains cloud computer shares. The XLSX file provides the following information:'."\n" + ."\n" + .'- Cloud computer share ID/name'."\n" + ."\n" + .'- Office network ID/name'."\n" + ."\n" + .'- Cloud computer share template'."\n" + ."\n" + .'- vCPUs/Memory size'."\n" + ."\n" + .'- System disk/Data disk'."\n" + ."\n" + .'- Security policy name'."\n" + ."\n" + .'- Number of authorized users'."\n" + ."\n" + .'- Billing method'."\n" + ."\n" + .'- Creation time'."\n" + ."\n" + .'- Expiration time', 'type' => 'string', 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ExportDesktopGroup.UnknowError', 'errorMessage' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"\\",\\n \\"SaveLimit\\": 0,\\n \\"DownloadCount\\": 0,\\n \\"Creator\\": \\"\\",\\n \\"SaveCount\\": 0,\\n \\"DisableSave\\": true,\\n \\"SharePwd\\": \\"\\",\\n \\"DisablePreview\\": true,\\n \\"AccessCount\\": 0,\\n \\"ShareId\\": \\"\\",\\n \\"DownloadLimit\\": 0,\\n \\"Status\\": \\"\\",\\n \\"DriveId\\": \\"\\",\\n \\"ModifiyTime\\": \\"\\",\\n \\"DisableDownload\\": true,\\n \\"Expiration\\": \\"\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 0,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"\\",\\n \\"ShareName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ShareLink\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DescribeCdsFileShareLinks', - ], - 'ModifyCdsFileShareLink' => [ - 'summary' => 'Modify the file sharing settings.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ExportDesktopGroupInfo', + 'summary' => 'Exports cloud computer shares and saves the list as an XLSX file. Each entry includes the ID and name of the cloud computer share, the ID and name of the office network, the cloud computer share template, and the name of the security policy.', + 'changeSet' => [ + ['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-02T07:06:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-13T03:21:30.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopGroupInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ExportDesktopGroupInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********\\",\\n \\"RequestId\\": \\"24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC\\"\\n}","type":"json"}]', + ], + 'ExportDesktopListInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CdsId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai+cds-135515****', - ], - ], - [ - 'name' => 'ShareId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the file sharing task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7JQX1Fs****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SharePwd', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The length of the access code. Valid values: 6 to 8. Unit: bytes. If you leave this parameter empty or set it to null, no access code is required. If you use a token to share files, you do not need to configure this parameter. The access code can contain only visible ASCII characters.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '12345678', - 'maxLength' => 8, - 'minLength' => 6, - ], + 'schema' => ['description' => 'The ID of the cloud computer pool to which the cloud computers belong.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5***', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'DesktopStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The sharing status.'."\n" + 'description' => 'The status of the cloud computers.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* disabled: The sharing task is canceled.'."\n" + .'* Stopped'."\n" ."\n" .' '."\n" ."\n" @@ -27912,141 +25827,111 @@ ."\n" .' '."\n" ."\n" - .'* enabled: The sharing task is valid.'."\n" + .'* Starting'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - 'enum' => [ - 'disabled', - 'enabled', - ], - ], - ], - [ - 'name' => 'Expiration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the file sharing link expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If this parameter is set to "", the file sharing link never expires.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2022-07-20T06:30:22.365Z', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the file sharing task. The description must be 0 to 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testDescription', - 'maxLength' => 1024, - 'minLength' => 0, - ], - ], - [ - 'name' => 'ShareName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file sharing task. If you do not configure this parameter, the sharing task name is the first ID that is returned in the file_id_list value.'."\n" + .' '."\n" ."\n" - .'> The sharing task name must be 0 to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '', - 'maxLength' => 128, - 'minLength' => 0, - ], - ], - [ - 'name' => 'DisablePreview', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to prohibit the preview of the files that are being shared.'."\n" + .'* Rebuilding'."\n" ."\n" - .'Valid values:'."\n" + .' '."\n" ."\n" - .'* true'."\n" + .' '."\n" ."\n" .' '."\n" ."\n" + .'* Running'."\n" + ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .'* false'."\n" + .' '."\n" + ."\n" + .'* Stopping'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'DisableSave', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to prohibit the dump of the files that are being shared.'."\n" + .' '."\n" ."\n" - .'Valid values:'."\n" + .'* Expired'."\n" ."\n" - .'* false'."\n" + .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" + .'* Deleted'."\n" + ."\n" .' '."\n" ."\n" - .'* true'."\n" + .' '."\n" ."\n" .' '."\n" ."\n" + .'* Pending'."\n" + ."\n" .' '."\n" ."\n" - .' '."\n", - 'type' => 'boolean', + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - ' false' => '', - 'true' => '', - ], - 'example' => 'false', + 'enumValueTitles' => ['Stopped' => '', 'Starting' => '', 'Rebuilding' => '', 'Running' => '', 'Stopping' => '', 'Expired' => '', 'Deleted' => '', 'Pending' => ''], + 'example' => 'Running', + 'title' => '', ], ], [ - 'name' => 'DisableDownload', + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that is used for the next query. If this parameter is empty, all results are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'UserName', + 'in' => 'query', + 'schema' => ['description' => 'The username of the end user who is using the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the policy that is attached to the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy', 'title' => ''], + ], + [ + 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to prohibit the download of the files that are being shared.'."\n" + 'description' => 'The billing method of the cloud computer.'."\n" ."\n" - .'Valid values:'."\n" + .'Default value: Postpaid. Valid values:'."\n" ."\n" - .'* false'."\n" + .'* Postpaid: pay-as-you-go'."\n" ."\n" .' '."\n" ."\n" @@ -28054,222 +25939,182 @@ ."\n" .' '."\n" ."\n" - .'* true'."\n" + .'* PrePaid: subscription'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - ' false' => '', - 'true' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'PreviewLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be previewed. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'SaveLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be dumped. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100', - ], - ], - [ - 'name' => 'DownloadLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The limit on the number of times that the shared files can be downloaded. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => '0', + 'enumValueTitles' => ['PostPaid' => '', 'PrePaid' => ''], + 'example' => 'PostPaid', + 'title' => '', ], ], [ - 'name' => 'PreviewCount', + 'name' => 'ExpiredTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of times that the shared files are previewed. The value of this parameter must be equal to or greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The time when a subscription cloud computer expires.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59Z', 'title' => ''], ], [ - 'name' => 'SaveCount', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of times that the shared files are dumped. The value of this parameter must be equal to or greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of the cloud computers. You can specify 1 to 100 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DownloadCount', + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of times that the shared files are downloaded. The value of this parameter must be equal to or greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of the end users of the cloud computer. You can specify 1 to 100 IDs.'."\n" + ."\n" + .'> During a specific period of time, only one user can connect to and use the cloud computer.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of an end user of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ReportCount', + 'name' => 'LangType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of times that the shared files are reported. The value of this parameter must be equal to or greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The language in which the cloud computer is displayed in the console UI. You can export the list of cloud computers in the specified language.'."\n" + ."\n" + .'Default value: zh-CN. Valid values:'."\n" + ."\n" + .'* zh-CN: Simplified Chinese'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* en-GB: British English'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'enumValueTitles' => ['zh-CN' => '', 'en-GB' => ''], + 'example' => '`zh-CN`', + 'title' => '', ], ], [ - 'name' => 'VideoPreviewCount', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of times that the videos are previewed in the shared files. The value of this parameter must be equal to or greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The tags that are added to the cloud computer. A tag is a key-value pair that consists of a tag key and a tag value. Tags are used to identify resources. You can use tags to manage cloud computers by group. This facilitates search and batch operations. For more information, see [Use tags to manage cloud computers](~~203781~~).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '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 cannot contain only spaces.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag value cannot start with `acs:` or `aliyun`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The modification result. The value success indicates that the modification is successful. If the modification failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The data information.'."\n", - '$ref' => '#/components/schemas/CdsFileShareLinkModel', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', - ], - 'Success' => [ - 'description' => 'The request status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false: The request fails.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], + 'Url' => ['description' => 'The URL of the exported file of the cloud computer list.'."\n", 'type' => 'string', 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ExportDesktop.UnknowError', 'errorMessage' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Description\\": \\"\\",\\n \\"SaveLimit\\": 0,\\n \\"DownloadCount\\": 0,\\n \\"Creator\\": \\"\\",\\n \\"SaveCount\\": 0,\\n \\"DisableSave\\": true,\\n \\"SharePwd\\": \\"\\",\\n \\"DisablePreview\\": true,\\n \\"AccessCount\\": 0,\\n \\"ShareId\\": \\"\\",\\n \\"DownloadLimit\\": 0,\\n \\"Status\\": \\"\\",\\n \\"DriveId\\": \\"\\",\\n \\"ModifiyTime\\": \\"\\",\\n \\"DisableDownload\\": true,\\n \\"Expiration\\": \\"\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 0,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"\\",\\n \\"ShareName\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ShareLink\\": \\"\\"\\n },\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ModifyCdsFileShareLink', - ], - 'CancelCdsFileShareLink' => [ - 'summary' => 'Cancels a file sharing task.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\n D3DFB159-0FAD-5C96-9E1F-DDBF15534B71\\n","errorExample":""}]', + 'title' => 'ExportDesktopListInfo', + 'summary' => 'Exports a cloud computer list as a CSV file.', + 'description' => 'The cloud computer list exported by calling this operation is saved as a CSV file. Each entry of data of a cloud computer includes the following fields:'."\n" + ."\n" + .'* Cloud computer ID and name'."\n" + .'* Office network ID and name'."\n" + .'* The instance type, OS and protocol of the cloud computer'."\n" + .'* System disk and data disk of the cloud computer'."\n" + .'* The status'."\n" + .'* Purchase method'."\n" + .'* The time when the cloud computer expires'."\n" + .'* Remaining duration and total duration'."\n" + .'* Number of assigned users and number of current users'."\n" + .'* Office network type'."\n" + .'* The time when the cloud computer was created'."\n" + .'* Tags'."\n" + .'* Encryption status'."\n" + .'* IP'."\n" + .'* The hostname'."\n", + 'changeSet' => [ + ['createdAt' => '2022-10-14T06:26:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-07T06:26:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-02T07:06:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-13T03:21:30.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopListInfo'], + ], ], + 'ramActions' => [], + ], + 'GetAsyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'systemTags' => [], 'parameters' => [ [ 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud disk.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+cds-352282****', - ], + 'schema' => ['description' => 'The ID of the cloud disk.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****', 'title' => ''], ], [ - 'name' => 'ShareId', + 'name' => 'AsyncTaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the file sharing task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7JQX1Fsw****', - ], + 'schema' => ['description' => 'The asynchronous task ID. This parameter is not returned if you copy files. This parameter is returned if you copy folders in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and information about an asynchronous task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '81a8a07a-aec4-4dd5-80da-ae69e482****', 'title' => ''], ], ], 'responses' => [ @@ -28277,238 +26122,152 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The operation result. The value success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message that is returned if the request failed. This parameter is not returned if the value of Code is `success`.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n", 'type' => 'string', - 'example' => 'success', + 'example' => 'true', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'title' => '', ], + 'Code' => ['description' => 'The operation result. If the request was successful, a success message is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ 'description' => 'The data information.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The task status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Failed: The task failed.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Running: The task was running.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* PartialSucceed: The task did not completely succeed.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* Succeed: The task succeeded.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'enumValueTitles' => ['Failed' => '', 'Running' => '', 'PartialSucceed' => '', 'Succeed' => ''], + 'example' => 'Failed', + 'title' => '', + ], + 'TotalProcess' => ['description' => 'The total number of asynchronous tasks to be processed, such as the amount of files to be downloaded and packaged on the server.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'Url' => ['description' => 'The URL to download data generated by the asynchronous task. Example: the URL to package and download tasks on the server.'."\n", 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], + 'ErrCode' => ['description' => 'The error code of the asynchronous task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => 'InternalError', 'title' => ''], + 'AsyncTaskId' => ['description' => 'The asynchronous task ID.'."\n", 'type' => 'string', 'example' => '000e89fb-cf8f-11e9-8ab4-b6e98080****', 'title' => ''], + 'Message' => ['description' => 'The error message of the asynchronous task.'."\n", 'type' => 'string', 'example' => 'The request failed due to some unknown errors. Please try again later.', 'title' => ''], + 'ConsumedProcess' => ['description' => 'The total number of asynchronous tasks that are processed. Example: the number of files that are packaged and downloaded on the server.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'GetAsyncTask', + 'summary' => 'When you call the CopyCdsFile operation to copy a folder, the operation returns AsyncTaskId. Call this operation specifying the obtained AsyncTaskId, and you can query the information about the asynchronous task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsyncTask'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CancelCdsFileShareLink', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": \\"true\\",\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"Status\\": \\"Failed\\",\\n \\"TotalProcess\\": 1000,\\n \\"Url\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"ErrCode\\": 0,\\n \\"AsyncTaskId\\": \\"000e89fb-cf8f-11e9-8ab4-b6e98080****\\",\\n \\"Message\\": \\"The request failed due to some unknown errors. Please try again later.\\",\\n \\"ConsumedProcess\\": \\"100\\"\\n }\\n}","type":"json"}]', ], - 'AddFilePermission' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetConnectionTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who uses the network disk.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of the end user of the cloud computer. The end user must be the current end user of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-352282****', - ], + 'schema' => ['description' => 'The password of the current end user of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'Ab123456', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', - ], + 'schema' => ['description' => 'The ID of the cloud computer connection task.', 'type' => 'string', 'required' => false, 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', 'title' => ''], ], [ - 'name' => 'MemberList', + 'name' => 'DesktopId', 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'json', - 'schema' => [ - 'description' => 'The users that you want to authorize to use the cloud disk.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user that you want to authorize.'."\n", - 'type' => 'object', - 'properties' => [ - 'RoleId' => [ - 'title' => '角色ID ', - 'description' => 'You can set permissions by specifying roles or by customizing operation permissions. This field is used to set permissions by specifying roles. This field is mutually exclusive with `ActionList`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SystemFileEditorWithoutShareLink: The role that can edit but cannot share files.'."\n" - .'* SystemFileUploaderAndDownloaderWithShareLink: The role that can upload, download, and share files.'."\n" - .'* SystemFileDownloader: The role that can download files.'."\n" - .'* SystemFileEditorWithoutDelete: The role that can edit but cannot edit files.'."\n" - .'* SystemFileOwner: The role that can collaborate with others on files.'."\n" - .'* SystemFileDownloaderWithShareLink: The role that can download and share files.'."\n" - .'* SystemFileUploaderAndViewer: The role that can preview and upload files.'."\n" - .'* SystemFileViewer: The role that can preview files.'."\n" - .'* SystemFileEditor: The role that can edit files.'."\n" - .'* SystemFileUploaderWithShareLink: The role that can upload and share files.'."\n" - .'* SystemFileUploader: The role that can upload files.'."\n" - .'* SystemFileUploaderAndDownloader: The role that can upload and download files.'."\n" - .'* SystemFileMetaViewer: The role that can view file list.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'SystemFileEditorWithoutShareLink' => '', - 'SystemFileUploaderAndDownloaderWithShareLink' => '', - 'SystemFileDownloader' => '', - 'SystemFileEditorWithoutDelete' => '', - 'SystemFileOwner' => '', - 'SystemFileDownloaderWithShareLink' => '', - 'SystemFileUploaderAndViewer' => '', - 'SystemFileViewer' => '', - 'SystemFileEditor' => '', - 'SystemFileUploaderWithShareLink' => '', - 'SystemFileUploader' => '', - 'SystemFileUploaderAndDownloader' => '', - 'SystemFileMetaViewer' => '', - ], - 'example' => 'SystemFileUploaderAndDownloader', - ], - 'ExpireTime' => [ - 'title' => '过期时间', - 'description' => 'The time when the authorization expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. The value never expires. You can specify a value that is predefined by the system for this parameter. Example: 4775500800000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4775500800000', - ], - 'DisinheritSubGroup' => [ - 'title' => '子用户组是否继承', - 'description' => 'Specifies whether the users of the child group can inherit the folder permissions.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'CdsIdentity' => [ - 'title' => '用户对象', - 'description' => 'The user of the cloud disk.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '用户ID', - 'description' => 'The ID of the convenience user.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user01', - ], - 'Type' => [ - 'title' => '用户类型', - 'description' => 'The user type.'."\n" - ."\n" - .'Set the value to TENANT_ADMIN.'."\n" - ."\n" - .'* IT_Group: group.'."\n" - .'* IT_User: user.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'IT_Group' => '', - 'IT_User' => '', - ], - 'example' => 'IT_User', - 'default' => 'IT_User', - 'enum' => [ - 'IT_User', - 'IT_Group', - ], - ], - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - 'docRequired' => false, - ], + 'schema' => ['description' => 'The ID of the cloud computer for which you want to generate a connection credential. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], + 'schema' => ['description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.', 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', 'title' => ''], + ], + [ + 'name' => 'CommandContent', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The command that you want to run to configure a custom application in user mode. After you obtain the credential, the application is automatically started. Parameter description in the command:'."\n" + ."\n" + .'- appPath: the path of the application startup file. Example: `"C:\\Program Files (x86)\\000\\000.exe"`. Use double slashes (\\) as the delimiter. Type of the parameter value: string.'."\n" + ."\n" + .'- appParameter: the startup arguments of the application. Example: `"meetingid 000 meetingname aaa"`. Separate multiple arguments with spaces. Type of the parameter value: string.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "startApplication": {'."\n" + .' "startApplicationList": ['."\n" + .' {'."\n" + .' "sessionName": "",'."\n" + .' "appList": ['."\n" + .' {'."\n" + .' "appPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe",'."\n" + .' "appParameter": "www.example.com www.example1.com"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ @@ -28516,29 +26275,95 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'TaskStatus' => [ + 'description' => 'The task status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- FAILED: The credential fails to be obtained.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- RUNNING: The credential is being obtained.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- FINISHED: The credential is obtained.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['FAILED' => '', 'RUNNING' => '', 'FINISHED' => ''], 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'example' => 'FINISHED', + 'title' => '', ], + 'Ticket' => ['description' => 'The credentials for connecting to the cloud computer.', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the cloud computer connection task.', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', 'title' => ''], + 'TaskCode' => ['description' => 'Before you use the credential, you must Base64 decode the content of the credential, save the credential as an xxx.ica file, and then open the file. Python sample code:'."\n" + ."\n" + .'```'."\n" + .'import base64'."\n" + .'response = {'."\n" + .' "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",'."\n" + .' "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",'."\n" + .'}'."\n" + .'f = open (\'xxx.ica\', \'w\')'."\n" + .'out = base64.b64decode(response[\'Ticket\'])'."\n" + .'f.write(out)'."\n" + .'f.close()'."\n" + .'```', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', 'title' => ''], + 'TaskMessage' => ['description' => 'The ID of the connection task.', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', 'title' => ''], + 'DesktopId' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'AddFilePermission', - 'summary' => 'Adds a shared folder to the network disk.', - 'description' => 'You can call this operation to share a specific folder with other users. You can also configure the folder permissions.'."\n", - ], - 'ListFilePermission' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'GetConnectionTicket', + 'summary' => 'Obtains the credential that is used to connect to a cloud desktop.', + 'description' => 'The cloud computer must be in the Running state. The ticket obtained by calling this operation will expire in 10 minutes.', + 'changeSet' => [ + ['createdAt' => '2024-11-13T06:38:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-28T12:16:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-23T06:16:16.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 30, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetConnectionTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n}","type":"json"}]', + ], + 'GetCoordinateTicket' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28549,2913 +26374,2800 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~436773~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'CoId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who uses the drive.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], + 'schema' => ['description' => 'The ID of the stream collaboration. You can obtain the value of this parameter based on the value of `Coid` that is returned by the `ApplyCoordinationForMonitoring` operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'co-0sot77uale3****', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-346063****', - ], + 'schema' => ['description' => 'The ID of the cloud computer connection task. The first time you initiate the request, you do not need to specify the ID of the cloud computer connection task. If no ticket is returned after you initiate the first request, you must specify the value of taskId that is returned for the first request in the subsequent request.', 'type' => 'string', 'required' => false, 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****', 'title' => ''], ], [ - 'name' => 'FileId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to get the file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', - ], + 'schema' => ['description' => 'The name of the convenience user account. If you initiate the request as an administrator, you do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'UserType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-c3acvkkbsfkte****', - ], - ], - ], - 'responses' => [ + 'description' => 'The type of the user.'."\n" + ."\n" + .'Set the value to TENANT\\_ADMIN.'."\n" + ."\n" + .'- The value of'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' TENANT\\_ADMIN'."\n" + ."\n" + .' '."\n" + ."\n" + .' specifies an administrator.', + 'enumValueTitles' => ['TENANT_ADMIN' => ''], + 'type' => 'string', + 'required' => true, + 'example' => 'TENANT_ADMIN', + 'title' => '', + ], + ], + ], + 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", + 'CoId' => ['description' => 'The ID of the stream collaboration.', 'type' => 'string', 'example' => 'co-0sot77uale3****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'TaskStatus' => [ + 'description' => 'The task status.'."\n" + ."\n" + .'Possible values:'."\n" + ."\n" + .'- Finished'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Running'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['Finished' => 'Finished', 'Failed' => 'Failed', 'Running' => 'Running'], 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'FilePermissions' => [ - 'description' => 'The permissions on the shared file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The member that is granted the permissions on the shared file.'."\n", - '$ref' => '#/components/schemas/FilePermissionMember', - ], + 'example' => 'Finished', + 'title' => '', ], + 'TaskId' => ['description' => 'The ID of the cloud computer connection task.', 'type' => 'string', 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****', 'title' => ''], + 'Ticket' => ['description' => 'The credentials of the stream collaboration.', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FilePermissions\\": [\\n {\\n \\"RoleId\\": \\"\\",\\n \\"ExpireTime\\": 0,\\n \\"DisinheritSubGroup\\": true,\\n \\"CdsIdentity\\": {\\n \\"Id\\": \\"\\",\\n \\"Type\\": \\"\\"\\n }\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListFilePermission', - 'summary' => 'Queries the permissions on a shared file on a drive.', - ], - 'RemoveFilePermission' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'GetCoordinateTicket', + 'summary' => 'Get the stream collaboration credentials for remote assistance or shared collaboration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCoordinateTicket'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:GetCoordinateTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Finished\\",\\n \\"TaskId\\": \\"39cc15e5-6998-4b9f-9b2c-7a4cc3e2****\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\"\\n}","type":"json"}]', + ], + 'GetDesktopGroupDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', - ], + 'schema' => ['description' => 'Region ID. Call [](t2167755.xdita#)to list regions that support Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CdsId', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the enterprise drive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+cds-066224****', - ], + 'schema' => ['description' => 'The ID of the cloud computer share.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], - [ - 'name' => 'MemberList', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The users that you want to authorize to use the cloud disk.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user that you want to authorize.'."\n", - 'type' => 'object', - 'properties' => [ - 'RoleId' => [ - 'description' => 'You can set permissions by specifying roles or by customizing operation permissions. This field is used to set permissions by specifying roles. This field is mutually exclusive with `ActionList`.'."\n" + 'description' => 'Response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1B5268CE-5EB3-545F-9F38-A8BCF710****', 'title' => ''], + 'Desktops' => [ + 'description' => 'Information about the cloud computer share.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Cloud computer share status.', + 'enumValueTitles' => ['Unpaid', 'Normal', 'Overdue or expired'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CreationTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2020-11-06T08:28Z', 'title' => ''], + 'PayType' => [ + 'description' => 'Billing method.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '', + ], + 'ResetType' => [ + 'description' => 'Cloud computer reset type.', + 'enumValueTitles' => ['No reset', 'Reset system disk only', 'Reset user disk only', 'Reset both system and user disks'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'LoadPolicy' => [ + 'description' => 'Traffic steering policy for multi-session, multi-cloud computer deployments.', + 'enumValueTitles' => ['Depth-first', 'Breadth-first'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'PolicyGroupName' => ['description' => 'The name of the policy that is associated with the cloud computer share.', 'type' => 'string', 'example' => 'All enabled policy', 'title' => ''], + 'Creator' => ['description' => 'Alibaba Cloud account ID of the creator.', 'type' => 'string', 'example' => '155177335370****', 'title' => ''], + 'MaxDesktopsCount' => ['description' => '- For pay-as-you-go cloud computers, this is the maximum number of cloud computers that can be created.'."\n" ."\n" - .'Valid values:'."\n" + .'- For subscription cloud computers, this is the sum of the initial purchase count (`BuyDesktopsCount`) and the number of cloud computers allowed for automatic creation.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'AllowAutoSetup' => [ + 'description' => 'Whether to allow automatic creation of subscription cloud computers.', + 'enumValueTitles' => ['Disabled', 'Enabled'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'ResType' => [ + 'description' => 'Resource type. Only Elastic Compute Service (ECS) is supported.', + 'enumValueTitles' => ['ECS'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'SystemDiskSize' => ['description' => 'System disk capacity in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], + 'PolicyGroupId' => ['description' => 'ID of the policy associated with the cloud computer share.', 'type' => 'string', 'example' => 'pg-9cktlowtxfl6****', 'title' => ''], + 'OwnBundleId' => ['description' => 'Cloud computer template ID.', 'type' => 'string', 'example' => 'b-1se9fb37r5tfq****', 'title' => ''], + 'GpuCount' => ['description' => 'Number of GPU cores.', 'type' => 'number', 'format' => 'float', 'example' => '4', 'title' => ''], + 'AllowBufferCount' => ['description' => 'Number of pre-started, idle cloud computers reserved for immediate connection. Applies only to pay-as-you-go cloud computers. Valid values:'."\n" + ."\n" + .'- 0: No reservation'."\n" + ."\n" + .'- N: Reserve N cloud computer(s) (1 ≤ N ≤ 100)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Memory' => ['description' => 'Memory size in MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], + 'GpuSpec' => ['description' => 'GPU specification.', 'type' => 'string', 'example' => 'NVIDIA T4', 'title' => ''], + 'DirectoryId' => ['description' => 'Directory ID (office network ID).', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'OwnBundleName' => ['description' => 'Cloud computer template name.', 'type' => 'string', 'example' => 'BundleDemo', 'title' => ''], + 'DataDiskCategory' => ['description' => 'User disk type.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'DesktopGroupName' => ['description' => 'The name of the cloud computer share that you want to query.', 'type' => 'string', 'example' => 'CloudComputerPool01'."\n", 'title' => ''], + 'BindAmount' => ['description' => 'Maximum concurrent sessions per cloud computer in multi-session, multi-cloud computer deployments.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'OwnType' => [ + 'description' => 'Cloud computer share type.', + 'enumValueTitles' => ['Single-session cloud computer', 'Multi-session cloud computers'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'title' => '', + ], + 'SystemDiskCategory' => ['description' => 'System disk type.', 'type' => 'string', 'example' => 'cloud_essd', 'title' => ''], + 'OfficeSiteId' => ['description' => 'Office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-990541****', 'title' => ''], + 'KeepDuration' => ['description' => 'Time to keep a disconnected session active. Unit: milliseconds. Valid range: 180000 (3 minutes) to 345600000 (4 days). A value of 0 means keep indefinitely.'."\n" ."\n" - .'* SystemFileEditorWithoutShareLink: the role that has the permissions to edit files but cannot share files.'."\n" - .'* SystemFileUploaderAndDownloaderWithShareLink: the role that has the permissions to upload, download, and share files.'."\n" - .'* SystemFileDownloader: the role that has the permissions to download files.'."\n" - .'* SystemFileEditorWithoutDelete: the role that has the permissions to edit files but cannot delete files.'."\n" - .'* SystemFileOwner: the role that has the permissions to collaborate with others.'."\n" - .'* SystemFileDownloaderWithShareLink: the role that has the permissions to download and share files'."\n" - .'* SystemFileUploaderAndViewer: the role that has the permissions to preview or upload files.'."\n" - .'* SystemFileViewer: the role that has the permissions to preview files.'."\n" - .'* SystemFileEditor: the role that has the permissions to edit files'."\n" - .'* SystemFileUploaderWithShareLink: the role that has the permissions to upload or share files.'."\n" - .'* SystemFileUploader: the role that has the permission to upload files.'."\n" - .'* SystemFileUploaderAndDownloader: the role that has the permissions to upload or download files.'."\n" - .'* SystemFileMetaViewer: the role that has the permissions to view files'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'SystemFileEditorWithoutShareLink' => '', - 'SystemFileUploaderAndDownloaderWithShareLink' => '', - 'SystemFileDownloader' => '', - 'SystemFileEditorWithoutDelete' => '', - 'SystemFileOwner' => '', - 'SystemFileDownloaderWithShareLink' => '', - 'SystemFileUploaderAndViewer' => '', - 'SystemFileViewer' => '', - 'SystemFileEditor' => '', - 'SystemFileUploaderWithShareLink' => '', - 'SystemFileUploader' => '', - 'SystemFileUploaderAndDownloader' => '', - 'SystemFileMetaViewer' => '', + .'If a session disconnects due to user action or other reasons, the timer starts at disconnection. If no reconnection occurs within this duration, the session logs off and unsaved data is destroyed. If the user reconnects successfully within this duration, they resume the original session and access all previously saved data.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000', 'title' => ''], + 'MinDesktopsCount' => ['description' => '- For pay-as-you-go cloud computers, this is the minimum number of cloud computers to create.'."\n" + ."\n" + .'- For subscription cloud computers, this equals `BuyDesktopsCount`, the initial purchase count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataDiskSize' => ['description' => 'User disk capacity in GiB.', 'type' => 'string', 'example' => '80', 'title' => ''], + 'DesktopGroupId' => ['description' => 'Cloud computer share ID.', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****', 'title' => ''], + 'OfficeSiteName' => ['description' => 'Name of the office network where the cloud computer share resides.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DirectoryType' => [ + 'description' => 'Directory type.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'SIMPLE', + 'title' => '', ], - 'example' => 'SystemFileUploaderAndDownloader', - ], - 'CdsIdentity' => [ - 'description' => 'The permission information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The user ID or group ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '249dsfseee643h33g3dv****', - ], - 'Type' => [ - 'description' => 'The object type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IT_Group: group.'."\n" - .'* IT_User: user.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'IT_Group' => '', - 'IT_User' => '', + 'Cpu' => ['description' => 'vCPU count.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Comments' => ['description' => 'Remarks.', 'type' => 'string', 'example' => 'comment', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'Account system type of the office network.', + 'enumValueTitles' => ['PERSONAL' => 'Personal office network', 'SIMPLE' => 'Simple office network', 'AD_CONNECTOR' => 'Active Directory (AD) office network', 'RAM' => 'RAM office network'], + 'type' => 'string', + 'example' => 'SIMPLE', + 'title' => '', + ], + 'TimerInfos' => [ + 'description' => 'List of scheduled tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The scheduled time.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Status.', + 'enumValueTitles' => [1 => 'Enabled', 'Disabled', 'Deleted'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'CronExpression' => ['description' => 'Cron expression.', 'type' => 'string', 'example' => '0 58 11 ? * 2', 'title' => ''], + 'TimerType' => [ + 'description' => 'Scheduled task type.', + 'enumValueTitles' => [1 => 'Scheduled reset', 'Scheduled start', 'Scheduled stop', 'Scheduled restart'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'Forced' => ['description' => 'Whether to force execute this scheduled task.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'example' => 'IT_User', - 'default' => 'IT_User', - 'enum' => [ - 'IT_User', - 'IT_Group', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RatioThreshold' => ['description' => 'Session occupancy threshold used to trigger auto scaling for multi-session, multi-cloud computer deployments. Session occupancy is calculated as:'."\n" + ."\n" + .'`Session occupancy = (Bound sessions / (Total cloud computers × Max sessions per cloud computer)) × 100%`'."\n" + ."\n" + .'When occupancy reaches this threshold, new cloud computers are created. When occupancy falls below this threshold, excess cloud computers are deleted.', 'type' => 'number', 'format' => 'float', 'example' => '0.85', 'title' => ''], + 'ConnectDuration' => ['description' => 'Maximum time a session remains connected. The session disconnects automatically when this duration is reached. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600000', 'title' => ''], + 'IdleDisconnectDuration' => ['description' => 'Time after which an idle session disconnects. If no keyboard or mouse activity occurs during this period, the session disconnects. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '900000', 'title' => ''], + 'Version' => ['description' => 'The version number of the cloud computer share.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'StopDuration' => ['description' => 'Idle shutdown time. The cloud computer shuts down automatically after being idle for this duration. If a user connects after shutdown, the cloud computer starts automatically. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000', 'title' => ''], + 'ProfileFollowSwitch' => ['description' => 'Whether to enable user profile roaming.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'NasFileSystemID' => ['description' => 'NAS file system ID used for user profile roaming.', 'type' => 'string', 'example' => '0783b4****', 'title' => ''], + 'NasFileSystemName' => ['description' => 'NAS file system name used for user profile roaming.', 'type' => 'string', 'example' => 'abcd', 'title' => ''], + 'TimingStrategyInfo' => ['description' => 'Scheduled application information.', 'type' => 'string', 'example' => 'abcd', 'title' => ''], + 'ScaleTimerInfos' => [ + 'description' => 'Scheduled scaling task information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Scheduled scaling task information.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Scheduled scaling task type.', + 'enumValueTitles' => ['drop' => 'Scale-down policy', 'normal' => 'Normal policy', 'peak' => 'Peak policy', 'rise' => 'Scale-up policy'], + 'type' => 'string', + 'example' => 'rise', + 'title' => '', + ], + 'Cron' => ['description' => 'Cron expression for the scheduled scaling task.', 'type' => 'string', 'example' => '0 0 0 * * ? ', 'title' => ''], + 'LoadPolicy' => [ + 'description' => 'Traffic steering policy for multi-session, multi-cloud computer deployments.', + 'enumValueTitles' => ['Depth-first', 'Breadth-first'], + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'title' => '', + ], + 'BuyResAmount' => ['description' => 'Scaling parameter: Number of cloud computers to buy. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'MinResAmount' => ['description' => 'Scaling parameter: Minimum number of cloud computers. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'MaxResAmount' => ['description' => 'Scaling parameter: Maximum number of cloud computers. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'KeepDuration' => ['description' => 'Time to keep a disconnected session active. Unit: milliseconds. Valid range: 180000 (3 minutes) to 345600000 (4 days). A value of 0 means keep indefinitely.'."\n" + ."\n" + .'If a session disconnects due to user action or other reasons, the timer starts at disconnection. If no reconnection occurs within this duration, the session logs off and unsaved data is destroyed. If the user reconnects successfully within this duration, they resume the original session and access all previously saved data.', 'type' => 'integer', 'format' => 'int64', 'example' => '180000', 'title' => ''], + 'RatioThreshold' => ['description' => 'Session occupancy threshold used to trigger auto scaling for multi-session, multi-cloud computer deployments. Session occupancy is calculated as:'."\n" + ."\n" + .'`Session occupancy = (Bound sessions / (Total cloud computers × Max sessions per cloud computer)) × 100%`'."\n" + ."\n" + .'When occupancy reaches this threshold, new cloud computers are created. When occupancy falls below this threshold, excess cloud computers are deleted.', 'type' => 'number', 'format' => 'float', 'example' => '0.85', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => true, + 'PolicyGroupIds' => [ + 'description' => 'The IDs of the policies that are associated with the cloud computer share.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the policy associated with the cloud computer share.', 'type' => 'string', 'example' => 'pd-abcd***', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PolicyGroupNames' => [ + 'description' => 'A list of policy names associated with cloud computer share.', + 'type' => 'array', + 'items' => ['description' => 'Policy names associated with the cloud computer share.', 'type' => 'string', 'example' => 'All enabled policy', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'BuyDesktopsCount' => ['description' => 'Initial purchase count for subscription cloud computers. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'ImageId' => ['description' => 'Image ID.', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], + 'ExpiredTime' => ['description' => 'Expiration time for subscription cloud computers.', 'type' => 'string', 'example' => '2021-12-31T15:59Z', 'title' => ''], + 'OsType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProtocolType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExpiredTimes' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'EnvType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EnvId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => true, - 'docRequired' => false, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'GetDesktopGroupDetail', + 'summary' => 'Queries the details of a cloud computer share.', + 'changeSet' => [ + ['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDesktopGroupDetail'], + ], + ], + 'ramActions' => [ [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the team space.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-1fbmvrc7ug5m7****', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetDesktopGroupDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1B5268CE-5EB3-545F-9F38-A8BCF710****\\",\\n \\"Desktops\\": {\\n \\"Status\\": 1,\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"PayType\\": \\"PrePaid\\",\\n \\"ResetType\\": 0,\\n \\"LoadPolicy\\": 0,\\n \\"PolicyGroupName\\": \\"All enabled policy\\",\\n \\"Creator\\": \\"155177335370****\\",\\n \\"MaxDesktopsCount\\": 3,\\n \\"AllowAutoSetup\\": 1,\\n \\"ResType\\": 0,\\n \\"SystemDiskSize\\": 80,\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"OwnBundleId\\": \\"b-1se9fb37r5tfq****\\",\\n \\"GpuCount\\": 4,\\n \\"AllowBufferCount\\": 1,\\n \\"Memory\\": 4096,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"OwnBundleName\\": \\"BundleDemo\\",\\n \\"DataDiskCategory\\": \\"cloud_essd\\",\\n \\"DesktopGroupName\\": \\"CloudComputerPool01\\\\n\\",\\n \\"BindAmount\\": 2,\\n \\"OwnType\\": 0,\\n \\"SystemDiskCategory\\": \\"cloud_essd\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-990541****\\",\\n \\"KeepDuration\\": 180000,\\n \\"MinDesktopsCount\\": 1,\\n \\"DataDiskSize\\": \\"80\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"Cpu\\": 4,\\n \\"Comments\\": \\"comment\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"TimerInfos\\": [\\n {\\n \\"Status\\": 1,\\n \\"CronExpression\\": \\"0 58 11 ? * 2\\",\\n \\"TimerType\\": 1,\\n \\"Forced\\": false\\n }\\n ],\\n \\"RatioThreshold\\": 0.85,\\n \\"ConnectDuration\\": 3600000,\\n \\"IdleDisconnectDuration\\": 900000,\\n \\"Version\\": 2,\\n \\"StopDuration\\": 180000,\\n \\"ProfileFollowSwitch\\": false,\\n \\"NasFileSystemID\\": \\"0783b4****\\",\\n \\"NasFileSystemName\\": \\"abcd\\",\\n \\"TimingStrategyInfo\\": \\"abcd\\",\\n \\"ScaleTimerInfos\\": [\\n {\\n \\"Type\\": \\"rise\\",\\n \\"Cron\\": \\"0 0 0 * * ? \\",\\n \\"LoadPolicy\\": 1,\\n \\"BuyResAmount\\": 5,\\n \\"MinResAmount\\": 1,\\n \\"MaxResAmount\\": 100,\\n \\"KeepDuration\\": 180000,\\n \\"RatioThreshold\\": 0.85\\n }\\n ],\\n \\"PolicyGroupIds\\": [\\n \\"pd-abcd***\\"\\n ],\\n \\"PolicyGroupNames\\": [\\n \\"All enabled policy\\"\\n ],\\n \\"BuyDesktopsCount\\": 5,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"OsType\\": \\"\\",\\n \\"ProtocolType\\": \\"\\",\\n \\"ExpiredTimes\\": [\\n \\"\\"\\n ],\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetOfficeSiteSsoStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The object that is returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB', + 'SsoStatus' => [ + 'description' => 'Indicates whether SSO is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'false', + 'enumValueTitles' => ['true' => '开启SSO', 'false' => '关闭SSO'], + 'title' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\"\\n}","type":"json"}]', - 'title' => 'RemoveFilePermission', - 'summary' => 'Unshare a folder on the network disk.', - ], - 'CreateAndBindNasFileSystem' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetOfficeSiteSsoStatus', + 'summary' => 'Queries whether single sign-on (SSO) is enabled for an office network.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOfficeSiteSsoStatus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SsoStatus\\": false,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9C013BF3-BA83-400E-85DF-861804F0948A\\n false\\n","errorExample":""}]', + ], + 'GetSpMetadata' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FileSystemName', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the NAS file system.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'szy-asp-upm-test', - ], + 'schema' => ['description' => 'The workspace ID. This parameter is the same as `OfficeSiteId`. We recommend that you use `OfficeSiteId` to replace `DirectoryId`. You can specify only `DirectoryId` or `OfficeSiteId`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-400695****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the NAS file system.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'newDescription', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****', 'title' => ''], ], - [ - 'name' => 'StorageType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The storage type of the NAS file system. Valid values:'."\n" - ."\n" - .'* Capacity'."\n" - .'* Performance'."\n" - ."\n" - .'Default value: Capacity.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Capacity', + 'description' => 'The information that is returned.', + 'type' => 'object', + 'properties' => [ + 'SpMetadata' => ['description' => 'The metadata of the SP.', 'type' => 'string', 'example' => '', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'GetSpMetadata', + 'summary' => 'Obtains the metadata of a Security Assertion Markup Language (SAML) 2.0-based service provider (SP).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSpMetadata'], + ], + ], + 'ramActions' => [ [ - 'name' => 'EncryptType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to encrypt data in the NAS file system. You can use keys that are hosted by Key Management Service (KMS) to encrypt data in a file system. When you read and write the encrypted data, the data is automatically decrypted. Valid values:'."\n" - ."\n" - .'* 0: does not encrypt data in the NAS file system.'."\n" - .'* 1: encrypts data in the NAS file system by using a NAS-managed key. ` If you set `FileSystemType` to `standard` or `extreme`, you can use a NAS-managed key to encrypt data in a NAS file system.`'."\n" - .'* 2: encrypts data in the NAS file system by using a KMS-managed key. `If` you set FileSystemType` to `extreme`, you can use a KMS-managed key to encrypt data in a NAS file system.`'."\n" - ."\n" - .'Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '0', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetSpMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SpMetadata\\": \\"\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'HibernateDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing+dir-15657*****', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'DesktopGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the desktop group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dg-fh0vdzyh6rdc*****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserIds', + 'name' => 'DesktopId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of users.'."\n", + 'description' => 'The IDs of the cloud desktops. You can specify 1 to 20 cloud desktop IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bcl', - ], - 'required' => false, - 'maxItems' => 10000, + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-eumyo1qzxscjf****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '101AE027-8299-5E6E-A782-6C91C962****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', - 'title' => 'CreateAndBindNasFileSystem', - 'summary' => 'Creates a NAS file system and associate it with the office network of the shared cloud computer.', - ], - 'CreateNASFileSystem' => [ - 'summary' => 'Create a NAS file system.', - 'methods' => [ - 'post', - 'get', + 'title' => 'HibernateDesktops', + 'summary' => 'Hibernates cloud desktops.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HibernateDesktops'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:HibernateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"101AE027-8299-5E6E-A782-6C91C962****\\"\\n}","type":"json"}]', + ], + 'ListCdsFiles' => [ + 'summary' => 'Queries the list of files in the network disk and obtain the download link of the file.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'Region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the user to which the network disk is assigned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Workspace ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'schema' => ['description' => 'The ID of the team space.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'Name of the NAS file system.'."\n" - .'The file name must follow these rules:'."\n" - .'- Length: 2 to 128 English or Chinese characters.'."\n" - .'- Must start with an uppercase or lowercase letter or a Chinese character, cannot start with http:// or https://.'."\n" - .'- Can include numbers, underscores (_), or hyphens (-).', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testNAS', - ], + 'schema' => ['description' => 'The ID of the enterprise drive.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-320357****', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ParentFileId', + 'in' => 'query', + 'schema' => ['description' => 'The parent folder ID. You can obtain the value by using the response parameter `FileId` of this operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '63636837e47e5a24a8a940218bef395c210e****', 'title' => ''], + ], + [ + 'name' => 'FileIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Description of the NAS file system.', - 'type' => 'string', + 'description' => 'The IDs of the files to be queried.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the file to be queried.'."\n", 'type' => 'string', 'required' => false, 'example' => '[\\"635d3c12f70beed7b6f84a9bb7bd51aad910****\\"]', 'title' => ''], 'required' => false, - 'docRequired' => true, - 'example' => 'testDescription', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'StorageType', + 'name' => 'OrderType', 'in' => 'query', 'schema' => [ - 'description' => 'Storage specification type of the NAS file system. Allowed values:'."\n" + 'description' => 'The sorting method of the files.'."\n" ."\n" - .'- Capacity: Capacity type.'."\n" - .'- Performance: Performance type.'."\n" + .'Valid values:'."\n" ."\n" - .'Default value: Capacity', + .'* CreateTimeDesc: sorts the by creation time in descending order.'."\n" + .'* ModifiedTimeAsc: sort the by modification time in ascending order.'."\n" + .'* NameDesc: sorts the by file name in descending order.'."\n" + .'* SizeAsc: sorts by file size in ascending order.'."\n" + .'* ModifiedTimeDesc: sort the by modification time in descending order.'."\n" + .'* CreateTimeAsc: sorts the by creation time in ascending order.'."\n" + .'* SizeDesc: sorts by file size in descending order.'."\n" + .'* NameAsc: sorts by file name in ascending order.'."\n", 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'Capacity', + 'enumValueTitles' => ['CreateTimeDesc' => '', 'ModifiedTimeAsc' => '', 'NameDesc' => '', 'SizeAsc' => '', 'ModifiedTimeDesc' => '', 'CreateTimeAsc' => '', 'SizeDesc' => '', 'NameAsc' => ''], + 'example' => 'CreateTimeDesc', + 'title' => '', ], ], [ - 'name' => 'EncryptType', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'Whether the file system is encrypted. Uses KMS service-managed keys to encrypt the file system\'s on-disk data. No decryption is required when reading and writing encrypted data. Possible values and their meanings:'."\n" + 'description' => 'The file status.'."\n" ."\n" - .'- 0: Not encrypted.'."\n" - .'- 1: Encrypted using NAS-managed keys.'."\n" + .'Valid values:'."\n" ."\n" - .'Default value: 0', + .'* available: returns only normal file.'."\n" + .'* uploading: returns only the of objects that are being uploaded.'."\n", 'type' => 'string', 'required' => false, - 'example' => '0', + 'enumValueTitles' => ['available' => '', 'uploading' => ''], + 'example' => 'available', + 'title' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The query token. Set the value to the value of the `NextToken` parameter returned in the last call to the operation. You do not need to set this parameter when you call the operation for the first time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the logon region. You can call the [DescribeRegions](~~196646~~) operation to obtain the list of regions supported by cloud computers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Return object.', 'type' => 'object', 'properties' => [ - 'FileSystemId' => [ - 'description' => 'ID of the NAS file system.', - 'type' => 'string', - 'example' => '04f314****', + 'NextToken' => ['description' => 'The token used to start the next query. If the `NextToken` is empty, the next query does not exist.'."\n", 'type' => 'string', 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'."\n", 'title' => ''], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '40D86754-20FD-53DC-A9B8-25F7FECC****', 'title' => ''], + 'Count' => ['description' => 'The total number of file list entries.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'Code' => ['description' => 'The response parameters. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'Error message. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', ], - 'FileSystemName' => [ - 'description' => 'Name of the NAS file system.', - 'type' => 'string', - 'example' => 'testNAS', - ], - 'MountTargetDomain' => [ - 'description' => 'Mount point domain.', - 'type' => 'string', - 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com', - ], - 'RequestId' => [ - 'description' => 'Request ID.', - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', - ], - 'OfficeSiteId' => [ - 'description' => 'Workspace ID.', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', + 'FileModels' => [ + 'description' => 'The files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The file information.'."\n", + 'type' => 'object', + 'properties' => [ + 'ContentType' => ['description' => 'The content type of the file.'."\n", 'type' => 'string', 'example' => 'application/json', 'title' => ''], + 'FileType' => [ + 'description' => 'The file type.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* file'."\n" + .'* folder'."\n", + 'type' => 'string', + 'enumValueTitles' => ['file' => '', 'folder' => ''], + 'example' => 'file', + 'title' => '', + ], + 'FileExtension' => ['description' => 'The filename extension.'."\n", 'type' => 'string', 'example' => 'pdf', 'title' => ''], + 'FileId' => ['description' => 'The file ID.'."\n", 'type' => 'string', 'example' => '637725ff2f63db8470984e6c92c692b87d52****', 'title' => ''], + 'Creator' => ['description' => 'The file creator.'."\n", 'type' => 'string', 'example' => 'demo_user01@cn-shanghai.148875033399****', 'title' => ''], + 'OpenTime' => ['description' => 'The time when the file was last opened.'."\n", 'type' => 'string', 'example' => '2022-09-06T07:27:08Z', 'title' => ''], + 'ParentId' => ['description' => 'The ID of the parent folder.'."\n", 'type' => 'string', 'example' => '3343213ff2f63db8470984e6c92c3213dfdw****'."\n", 'title' => ''], + 'Modifier' => ['description' => 'Modifier.'."\n", 'type' => 'string', 'example' => 'demo_user02@cn-shanghai.148875033399****', 'title' => ''], + 'Description' => ['description' => 'The file description.'."\n", 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'Name' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'SampleFile.pdf', 'title' => ''], + 'DownloadUrl' => ['description' => 'The download link. The default validity period is 15 minutes.'."\n", 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], + 'Sha1' => ['description' => 'The SHA1 hash of the data file.'."\n", 'type' => 'string', 'example' => 'EA4942AA8761213890A5C386F88E6464D2C3****', 'title' => ''], + 'OpenTimeStamp' => ['description' => 'The timestamp that indicates the time when the file was last opened.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '168951245231', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to obtain the list of regions supported by cloud computers.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'FilePath' => ['description' => 'The file path.'."\n", 'type' => 'string', 'example' => 'isv/1019236948660053/temp/', 'title' => ''], + 'Size' => ['description' => 'The size of the file. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '102400', 'title' => ''], + 'Category' => ['description' => 'File type classification. The network disk will classify files according to their suffix and MIME Type. The main categories are `doc`, `image`, `audio` and `video`.'."\n", 'type' => 'string', 'example' => 'image', 'title' => ''], + 'Md5' => ['description' => 'The MD5 hash of the object.'."\n", 'type' => 'string', 'example' => '63c83ececb4e6926c51448fc5ecb****', 'title' => ''], + 'Thumbnail' => ['description' => 'The URL of the thumbnail.'."\n", 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the file was created.'."\n", 'type' => 'string', 'example' => '2022-09-06T07:27:08Z', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the file was last modified.'."\n", 'type' => 'string', 'example' => '2022-09-06T07:27:08Z', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FileSystemId\\": \\"04f314****\\",\\n \\"FileSystemName\\": \\"testNAS\\",\\n \\"MountTargetDomain\\": \\"04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]', - 'title' => 'CreateNASFileSystem', - 'description' => ''."\n" - .'- Each standard workspace can create one NAS file system to meet the need for sharing files between cloud desktops in the workspace.'."\n" - .'- The system will automatically create a general-purpose NAS file system (with storage specifications of Capacity and Performance, with capacities of 10 PiB and 1 PiB respectively) and generate a default mount point.'."\n" - .'- The NAS file system uses pay-as-you-go by default. You need to pay for the actual storage usage. You can also purchase resource packages to offset the storage usage.'."\n" - ."\n" - .'For more information, see [Creating Shared Storage NAS](~~214481~~).'."\n" - .''."\n" - ."\n" - .''."\n" - .'- Each standard workspace can create one NAS file system to meet the need for sharing files between cloud desktops in the workspace.'."\n" - .'- The system will automatically create a general-purpose NAS file system (with storage specifications of Capacity and Performance, with capacities of 10 PiB and 1 PiB respectively) and generate a default mount point.'."\n" - .'- The NAS file system uses pay-as-you-go by default. You need to pay for the actual storage usage. You can also purchase storage packages to offset the storage usage.'."\n" - ."\n" - .'For more information, see [Creating Shared Storage NAS](~~214481~~).'."\n" - .'', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - 'translator' => 'machine', - ], - 'DescribeNASFileSystems' => [ - 'summary' => 'Queries the information about File Storage NAS (NAS) file systems.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\\\n\\",\\n \\"RequestId\\": \\"40D86754-20FD-53DC-A9B8-25F7FECC****\\",\\n \\"Count\\": \\"2\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"FileModels\\": [\\n {\\n \\"ContentType\\": \\"application/json\\",\\n \\"FileType\\": \\"file\\",\\n \\"FileExtension\\": \\"pdf\\",\\n \\"FileId\\": \\"637725ff2f63db8470984e6c92c692b87d52****\\",\\n \\"Creator\\": \\"demo_user01@cn-shanghai.148875033399****\\",\\n \\"OpenTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ParentId\\": \\"3343213ff2f63db8470984e6c92c3213dfdw****\\\\n\\",\\n \\"Modifier\\": \\"demo_user02@cn-shanghai.148875033399****\\",\\n \\"Description\\": \\"test1\\",\\n \\"Name\\": \\"SampleFile.pdf\\",\\n \\"DownloadUrl\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Sha1\\": \\"EA4942AA8761213890A5C386F88E6464D2C3****\\",\\n \\"OpenTimeStamp\\": 168951245231,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"FilePath\\": \\"isv/1019236948660053/temp/\\",\\n \\"Size\\": 102400,\\n \\"Category\\": \\"image\\",\\n \\"Md5\\": \\"63c83ececb4e6926c51448fc5ecb****\\",\\n \\"Thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"CreateTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ModifiedTime\\": \\"2022-09-06T07:27:08Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListCdsFiles', + 'changeSet' => [ + ['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-16T10:59:10.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCdsFiles'], + ], ], + 'ramActions' => [], + ], + 'ListDirectoryUsers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. To get a list of regions that WUYING Workspace supports, call [DescribeRegions](~~196646~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], + 'schema' => ['description' => 'The string for a fuzzy search. The operation returns all results that contain this string.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The AD directory ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The token that determines the start point of the query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The token used to start the next query. If this value is empty, no more results are available.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'FileSystemId', + 'name' => 'MaxResults', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the NAS file systems.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the NAS file system.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04f314****', - ], - 'required' => false, - 'example' => '04f314****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'MatchCompatibleProfile', + 'name' => 'OUPath', + 'in' => 'query', + 'schema' => ['description' => 'The path of the organizational unit (OU) in the AD domain. You can call [ListUserAdOrganizationUnits](~~311259~~) to obtain the OU path.', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers', 'title' => ''], + ], + [ + 'name' => 'AssignedInfo', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is not publicly available. You can only set this parameter to `1` or leave it empty.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SortType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to include only NAS file systems that support the User Profile Management (UPM) feature in the query results.'."\n", - 'type' => 'boolean', + 'description' => 'The sorting method.', + 'enumValueTitles' => ['asc' => 'Lists users with assigned cloud desktops last.', 'desc' => 'Lists users with assigned cloud desktops first.'], + 'type' => 'string', 'required' => false, - 'example' => 'false', + 'example' => 'asc', + 'title' => '', ], ], + [ + 'name' => 'IncludeAssignedUser', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return only users who are assigned cloud desktops.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that determines the start point of the next query. This parameter is empty if no additional results exist.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', - ], - 'FileSystems' => [ - 'description' => 'The NAS file systems.'."\n", + 'NextToken' => ['description' => 'The token that is used to start the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Users' => [ + 'description' => 'An array that consists of the users in the AD directory. If the AD directory contains only the Administrator and Guest users, an empty \\`Users\\` array is returned.', 'type' => 'array', 'items' => [ - 'description' => 'The NAS file system.'."\n", + 'description' => 'The user object.', 'type' => 'object', 'properties' => [ - 'Capacity' => [ - 'description' => 'The total capacity of the NAS file system. Unit: GiB.'."\n" - ."\n" - .'* The Capacity type has 10 PiB of storage, which is equal to 10,485,760 GiB.'."\n" - .'* The Performance type has 1 PiB of storage, which is equal to 1,048,576 GiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10485760', - ], - 'MountTargetStatus' => [ - 'description' => 'The status of the mount target. The possible values include:'."\n" - ."\n" - .'* Pending: The mount target is being created.'."\n" - .'* Active: The mount target is enabled.'."\n" - .'* Inactive: The mount target is disabled.'."\n" - .'* Deleting: The mount target is being deleted.'."\n" - .'* Invalid: The mount target is invalid.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Active' => '', - 'Inactive' => '', - 'Pending' => '', - 'Deleting' => '', - 'Invalid' => '', - ], - 'example' => 'Active', - ], - 'CreateTime' => [ - 'description' => 'The time when the NAS file system was created.'."\n", - 'type' => 'string', - 'example' => '2021-05-10T11:39Z', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'SupportAcl' => [ - 'description' => 'Indicates whether the Server Message Block (SMB) access control list (ACL) feature was enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'StorageType' => [ - 'description' => 'The storage type of the NAS file system. Valid values:'."\n" - ."\n" - .'* Capacity'."\n" - .'* Performance'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Capacity' => '', - 'Performance' => '', - ], - 'example' => 'Capacity', - ], - 'OfficeSiteName' => [ - 'description' => 'The name of the office network.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'FileSystemId' => [ - 'description' => 'The ID of the NAS file system.'."\n", - 'type' => 'string', - 'example' => '04f314****', - ], - 'FileSystemType' => [ - 'description' => 'The type of the NAS file system. The only valid value is `standard`.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - ], - 'example' => 'standard', - ], - 'FileSystemName' => [ - 'description' => 'The name of the NAS file system.'."\n", - 'type' => 'string', - 'example' => 'testNAS', - ], - 'MeteredSize' => [ - 'description' => 'The used capacity of the NAS file system. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'MountTargetDomain' => [ - 'description' => 'The domain name of the mount target.'."\n", - 'type' => 'string', - 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com', - ], - 'Description' => [ - 'description' => 'The description of the NAS file system.'."\n", - 'type' => 'string', - 'example' => 'testDescription', - ], - 'ZoneId' => [ - 'description' => 'The ID of the zone where the NAS file system resides.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou-f', - ], - 'FileSystemStatus' => [ - 'description' => 'The status of the NAS file system. The possible values include:'."\n" - ."\n" - .'* Pending: The NAS file system is being created.'."\n" - .'* Running: The NAS file system is running.'."\n" - .'* Stopped: The NAS file system is stopped.'."\n" - .'* Deleting: The NAS file system is being deleted.'."\n" - .'* Deleted: The NAS file system is deleted.'."\n" - .'* Invalid: The NAS file system is invalid.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => '', - 'Running' => '', - 'Deleted' => '', - 'Pending' => '', - 'Deleting' => '', - 'Invalid' => '', - ], - 'example' => 'Running', - ], - 'EncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ProfileCompatible' => [ - 'description' => 'Indicates whether the User Profile Management (UPM) feature is supported.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'DesktopGroups' => [ - 'description' => 'The cloud computer shares that are associated with the UPM-supported NAS file systems.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer share.'."\n", - 'type' => 'object', - 'properties' => [ - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'dg-9eeyf15b25nyl****', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'test_dg', - ], - ], - ], - ], - 'Scene' => [ - 'description' => 'The storage type of the NAS file system.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Upm: the UPM-supported NAS file system.'."\n" - .'* ShareNas: the shared NAS file system.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Upm' => 'UPM NAS', - 'ShareNas' => '', - ], - 'example' => 'Upm', - ], - 'AppInstanceGroups' => [ - 'description' => 'The application delivery groups that are associated with the UPM-supported NAS file systems.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The application delivery group that is associated with the UPM-supported NAS file system.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppInstanceGroupId' => [ - 'description' => 'The ID of the delivery group.'."\n", - 'type' => 'string', - 'example' => 'aig-0bz55ibznu9p7****', - ], - 'AppInstanceGroupName' => [ - 'description' => 'The name of the delivery group.'."\n", - 'type' => 'string', - 'example' => 'DemoDeliveryGroup', - ], - ], - ], - ], - 'AllowOperateUserDrive' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'boolean', - ], - 'OfficeSites' => [ - 'description' => 'The office networks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The office network.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'OfficeSiteName' => [ - 'description' => 'The name of the office network.'."\n", - 'type' => 'string', - 'example' => 'DemoOfficeNetwork', - ], - ], - ], - ], - ], + 'EndUser' => ['description' => 'The username.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'Alice', 'title' => ''], + 'AssignedDesktopNumber' => ['description' => 'The number of assigned cloud desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'user@example.com', 'title' => ''], + 'Phone' => ['description' => 'The mobile phone number.', 'type' => 'string', 'example' => '130********', 'title' => ''], + 'DisplayNameNew' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserPrincipalName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"FileSystems\\": [\\n {\\n \\"Capacity\\": 10485760,\\n \\"MountTargetStatus\\": \\"Active\\",\\n \\"CreateTime\\": \\"2021-05-10T11:39Z\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"SupportAcl\\": false,\\n \\"StorageType\\": \\"Capacity\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"FileSystemId\\": \\"04f314****\\",\\n \\"FileSystemType\\": \\"standard\\",\\n \\"FileSystemName\\": \\"testNAS\\",\\n \\"MeteredSize\\": 0,\\n \\"MountTargetDomain\\": \\"04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"ZoneId\\": \\"cn-hangzhou-f\\",\\n \\"FileSystemStatus\\": \\"Running\\",\\n \\"EncryptionEnabled\\": false,\\n \\"ProfileCompatible\\": false,\\n \\"DesktopGroups\\": [\\n {\\n \\"DesktopGroupId\\": \\"dg-9eeyf15b25nyl****\\",\\n \\"DesktopGroupName\\": \\"test_dg\\"\\n }\\n ],\\n \\"Scene\\": \\"Upm\\",\\n \\"AppInstanceGroups\\": [\\n {\\n \\"AppInstanceGroupId\\": \\"aig-0bz55ibznu9p7****\\",\\n \\"AppInstanceGroupName\\": \\"DemoDeliveryGroup\\"\\n }\\n ],\\n \\"AllowOperateUserDrive\\": true,\\n \\"OfficeSites\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n false\\n testDescription\\n Capacity\\n cn-hangzhou-f\\n 2021-05-10T11:39Z\\n Active\\n 0\\n cn-hangzhou+dir-363353****\\n 04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\n 10485760\\n standard\\n Running\\n testNAS\\n 04f314****\\n test\\n cn-hangzhou\\n\\n269BDB16-2CD8-4865-84BD-11C40BC21DB0\\ncaeba0bbb2be03f84eb48b699f0a4883\\n","errorExample":""}]', - 'title' => 'DescribeNASFileSystems', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyNASDefaultMountTarget' => [ - 'summary' => 'Modifies the mount target of a File Storage NAS (NAS) file system.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"Alice\\",\\n \\"DisplayName\\": \\"Alice\\",\\n \\"AssignedDesktopNumber\\": 2,\\n \\"Email\\": \\"user@example.com\\",\\n \\"Phone\\": \\"130********\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDirectoryUsers', + 'summary' => 'If you use an Active Directory (AD) directory to connect to your enterprise AD, call this operation to retrieve user information from your enterprise AD.', + 'changeSet' => [ + ['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-06T14:19:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDirectoryUsers'], + ], ], + 'ramActions' => [], + ], + 'ListFilePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FileSystemId', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the NAS file system.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '04f314****', - ], + 'schema' => ['description' => 'The ID of the user who uses the drive.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], ], [ - 'name' => 'MountTargetDomain', + 'name' => 'CdsId', 'in' => 'query', - 'schema' => [ - 'description' => 'The domain name of the mount target.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0bf744****-xo***.cn-hangzhou.nas.aliyuncs.com', - ], + 'schema' => ['description' => 'The ID of the enterprise drive.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-346063****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to get the file ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the team space.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-c3acvkkbsfkte****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'FilePermissions' => [ + 'description' => 'The permissions on the shared file.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The member that is granted the permissions on the shared file.'."\n", '$ref' => '#/components/schemas/FilePermissionMember', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyNASDefaultMountTarget', - 'description' => 'When you create a NAS file system, a mount target is automatically generated. By default, the mount target does not need to be changed. If the mount target is deleted by misoperation, you must specify a new mount target for the NAS file system in the workspace. You can call the [CreateMountTarget](~~62621~~) operation to create a mount target.'."\n", - ], - 'ResetNASDefaultMountTarget' => [ - 'summary' => 'Resets the mount target of a File Storage NAS (NAS) file system.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListFilePermission', + 'summary' => 'Queries the permissions on a shared file on a drive.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFilePermission'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FilePermissions\\": [\\n {\\n \\"RoleId\\": \\"SystemFileEditor\\",\\n \\"ExpireTime\\": 1633598866642,\\n \\"DisinheritSubGroup\\": true,\\n \\"CdsIdentity\\": {\\n \\"Id\\": \\"16435bdf934248b788b7b3771ee9****\\",\\n \\"Type\\": \\"IT_User\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstalledApps' => [ + 'summary' => 'Queries applications installed on a cloud computer.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ecd-39clsqyxr****', 'title' => ''], ], [ - 'name' => 'FileSystemId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the NAS file system.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '3a6ef4****', - ], + 'schema' => ['description' => 'The number of entries per page.\\'."\n" + .'Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.\\'."\n" + .'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned information.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The unique ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], + 'Apps' => [ + 'description' => 'The information about the application.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application details.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test_app', 'title' => ''], + 'AppVersion' => ['description' => 'The application version.'."\n", 'type' => 'string', 'example' => '2.0.1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ResetNASDefaultMountTarget', - 'description' => 'When you create a NAS file system, a mount target is automatically generated. By default, you do not need to modify the mount target of the NAS file system. If the mount target is disabled, you need to reset the mount target of the NAS file system.'."\n", - ], - 'DeleteNASFileSystems' => [ - 'summary' => 'Deletes NAS file systems.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 94,\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"test_app\\",\\n \\"AppVersion\\": \\"2.0.1\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListInstalledApps', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListOfficeSiteOverview' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ForceRefresh', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID of the NAS file system that you want to delete.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'Specifies whether to refresh the cache.', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'FileSystemId', + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Valid values: 1 to 100'."\n" + ."\n" + .'- Default value: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that determines the start point of the next query. If this is your first query or no next query is to be sent, skip this parameter. If a next query is to be sent, set the parameter to the value of NextToken that is returned from the last call.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the NAS file systems that you want to delete.'."\n", + 'description' => 'The office network IDs. You can specify IDs of 1 to 100 office networks.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the NAS file system that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04f314****', - ], - 'required' => true, - 'example' => '04f314****', + 'items' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'required' => false, + 'example' => 'cn-hangzhou+dir-363353****', 'maxItems' => 100, + 'title' => '', + ], + ], + [ + 'name' => 'QueryRange', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query scope. Cloud computers in a cloud computer pool are pooled cloud computers.'."\n" + ."\n" + .'Default values:'."\n" + ."\n" + .'- 1 (default): queries non-pooled cloud computers in the office network.'."\n" + ."\n" + .'- 2: queries pooled cloud computers in the office network.'."\n" + ."\n" + .'- 3: queries all cloud computers in the office network.', + 'enumValueTitles' => [1 => '', '', ''], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object that is returned.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'NextToken' => ['description' => 'The token that is used to start the next query. If this parameter is empty, all results are returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'OfficeSiteOverviewResults' => [ + 'description' => 'The office network information.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details about the workspace.', + 'type' => 'object', + 'properties' => [ + 'OfficeSiteStatus' => [ + 'description' => 'The office network status.'."\n" + ."\n" + .'Default values:'."\n" + ."\n" + .'- CONFIGUSERFAILED'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- REGISTERING'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- REGISTERED'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- NEEDCONFIGTRUST'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CONFIGUSERING'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CONFIGTRUSTFAILED'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- ERROR'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- CONFIGTRUSTING'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- NEEDCONFIGUSER'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['CONFIGUSERFAILED' => '', 'REGISTERING' => '', 'REGISTERED' => '', 'NEEDCONFIGTRUST' => '', 'CONFIGUSERING' => '', 'CONFIGTRUSTFAILED' => '', 'ERROR' => '', 'CONFIGTRUSTING' => '', 'NEEDCONFIGUSER' => ''], + 'type' => 'string', + 'example' => 'REGISTERED', + 'title' => '', + ], + 'TotalEdsCount' => ['description' => 'The total number of cloud computers in the office network.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalEdsCountForGroup' => ['description' => 'The total number of cloud computers in the cloud computer pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WillExpiredEdsCount' => ['description' => 'The number of cloud computers that are about to expire in the office network.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WillExpiredEdsCountForGroup' => ['description' => 'The number of cloud computers that are about to expire in the cloud computer pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'RunningEdsCount' => ['description' => 'The number of cloud computers that are running in the office network.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RunningEdsCountForGroup' => ['description' => 'The number of running cloud computers in the cloud computer pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OfficeSiteName' => ['description' => 'The office network name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'VpcType' => [ + 'description' => 'The office network type and its suitable VPC type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- standard (default): standard, exclusive VPC'."\n" + ."\n" + .'- customized: custom, user VPC'."\n" + ."\n" + .'- basic: basic, shared VPC', + 'enumValueTitles' => ['standard' => '', 'customized' => '', 'basic' => ''], + 'type' => 'string', + 'example' => 'standard', + 'title' => '', + ], + 'HasExpiredEdsCount' => ['description' => 'The number of expired cloud computers in the office network.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'HasExpiredEdsCountForGroup' => ['description' => 'The number of expired cloud computers in the cloud computer pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region where the office network resides.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteNASFileSystems', - 'description' => 'Before you delete a File Storage NAS (NAS) file system, make sure that the data you want to retain is backed up.'."\n" - ."\n" - .'>If a NAS file system is deleted, data stored in the NAS file system cannot be restored. Proceed with caution when you delete NAS file systems.>', + 'title' => 'ListOfficeSiteOverview', + 'summary' => 'Queries information about an office network, including its status, cloud computer quantity, virtual private cloud (VPC) type, and more.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTemplate' => [ - 'summary' => 'Creates a custom cloud computer template. A cloud computer template (or simply "template") simplifies the process of creating cloud computers by providing a predefined set of configurations. This eliminates the need to manually configure each setting, saving significant time and effort.', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-04-13T07:45:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-05T08:49:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteOverview'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListOfficeSiteOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteOverviewResults\\": [\\n {\\n \\"OfficeSiteStatus\\": \\"REGISTERED\\",\\n \\"TotalEdsCount\\": 1,\\n \\"TotalEdsCountForGroup\\": 1,\\n \\"WillExpiredEdsCount\\": 0,\\n \\"WillExpiredEdsCountForGroup\\": 0,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"RunningEdsCount\\": 1,\\n \\"RunningEdsCountForGroup\\": 1,\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"VpcType\\": \\"standard\\",\\n \\"HasExpiredEdsCount\\": 0,\\n \\"HasExpiredEdsCountForGroup\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListOfficeSiteUsers' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TemplateName', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name. It must meet the following criteria:'."\n" - ."\n" - .'* It can be 2 to 126 characters in length.'."\n" - .'* It must begin with a letter and cannot start with `http://` or `https://`.'."\n" - .'* It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). Note: Periods (.) are not supported in the name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '', - 'maxLength' => 126, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~DescribeRegions~~) to get a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The template description. It must meet the following criteria:'."\n" - ."\n" - .'* It can be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n" - .'* It can contain letters, digits, and special characters, including spaces. Note: You can use carriage returns to break lines.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 256, - 'minLength' => 2, - ], + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The query string for fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => '*jin*', 'title' => ''], ], [ - 'name' => 'ProductType', - 'in' => 'formData', - 'schema' => [ - 'title' => '产品类型', - 'description' => 'The service type. Set the value to `CloudDesktop`.'."\n" - ."\n" - .'*'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '', - ], - 'example' => 'CloudDesktop', - ], + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID. Only office networks that use enterprise AD accounts are supported.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'BizType', - 'in' => 'formData', - 'schema' => [ - 'title' => '业务类型', - 'description' => '> This parameter is not publicly available.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: the Enterprise edition.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - ], - 'example' => '1', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token for the next page of results. Leave this empty for the first query. For subsequent queries, use the NextToken value from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'SystemDiskSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '系统盘配置', - 'description' => 'The size of the system disk. Unit: GiB. Valid values: 40 to 500. Increments: 10 GiB.'."\n" - ."\n" - .'> The system disk size must be at least as large as the configured image size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2040', - 'minimum' => '40', - 'example' => '80', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'- Maximum value: 100.'."\n" + ."\n" + .'- Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SystemDiskPerformanceLevel', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The performance level (PL) of the system disk.'."\n" - ."\n" - .'> Only cloud computers of the Graphics or High Frequency type support Enterprise SSDs (ESSDs).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1: a PL1 ESSD.'."\n" - .'* PL0: a PL0 ESSD.'."\n" - .'* AutoPL: an AutoPL ESSD.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PL1' => '', - 'PL0' => '', - 'AutoPL' => '', - ], - 'example' => 'AutoPL', - ], + 'name' => 'OUPath', + 'in' => 'query', + 'schema' => ['description' => 'The path of the organizational unit (OU) in the AD domain.', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers', 'title' => ''], ], [ - 'name' => 'DataDiskList', - 'in' => 'formData', - 'style' => 'flat', + 'name' => 'AssignedInfo', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'IncludeAssignedUser', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The data disks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Size' => [ - 'description' => 'The size of the data disk. Unit: GiB. Valid values: 40 to 2040. Increments: 10 GiB.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Keep in mind** that the larger the ESSD disk capacity, the higher the available PL (for example, PL2 is available for disks larger than 460 GiB). A higher PL comes with a higher cost. Select an ESSD based on your specific needs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2040', - 'minimum' => '40', - 'example' => '40', - ], - 'PerformanceLevel' => [ - 'description' => 'The PL of the data disk. Default value: `AutoPL`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'AutoPL', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token to start the next query. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0', 'title' => ''], + 'Users' => [ + 'description' => 'An array that consists of the AD accounts.
'."\n" + .'If the enterprise AD contains only the Administrator and Guest users, an empty Users array is returned.
', + 'type' => 'array', + 'items' => [ + 'description' => 'The username of the Active Directory user.', + 'type' => 'object', + 'properties' => [ + 'EndUser' => ['description' => 'The username of the AD account.', 'type' => 'string', 'example' => 'aduser', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the AD account.', 'type' => 'string', 'example' => 'aduser', 'title' => ''], + 'AssignedDesktopNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Email' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Phone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserPrincipalName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayNameNew' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"aduser\\",\\n \\"DisplayName\\": \\"aduser\\",\\n \\"AssignedDesktopNumber\\": 0,\\n \\"Email\\": \\"\\",\\n \\"Phone\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListOfficeSiteUsers', + 'summary' => 'Queries information about Active Directory (AD) accounts in an AD office network (formerly known as a workspace) that is connected to an AD domain.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteUsers'], + ], + ], + 'ramActions' => [], + ], + 'ListTagResources' => [ + 'summary' => 'Queries the list of tags that are added to cloud computers.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '镜像id', - 'description' => 'The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desktopimage-windows-server-2022-64-asp', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DefaultLanguage', - 'in' => 'formData', - 'schema' => [ - 'title' => '默认语言', - 'description' => 'The default language of cloud computers during startup. This parameter takes effect only when cloud computers are created from system images.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', - 'in' => 'formData', + 'name' => 'ResourceType', + 'in' => 'query', 'schema' => [ - 'title' => '策略ID', - 'description' => 'The ID of the policy group.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => 'Cloud computer'], 'type' => 'string', - 'required' => false, - 'example' => 'pg-8hlryfn331******', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::GWS::INSTANCE', + 'title' => '', ], ], [ - 'name' => 'TimerGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '中心定时任务组ID', - 'description' => 'The ID of the scheduled task group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0caoeogrk9m5****', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The token that determines the start point of the next query.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the resources, that is, the IDs of the cloud computers. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the resource, that is, the ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], 'required' => false, - 'example' => 'rg-4knxmfneq1e******', + 'example' => 'ecd-ia2zw38bi6cm7****', + 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'ResourceTagList', - 'in' => 'formData', - 'style' => 'flat', + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags added to cloud computers. Specify tags in key-value pairs. You can specify up to 20 tags.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'department', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'design', - ], + 'Key' => ['description' => 'The tag key. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], + 'Value' => ['description' => 'The tag value. Valid values of N: 1 to 20.', 'type' => 'string', 'required' => false, 'example' => 'design', 'title' => ''], ], 'required' => false, - 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RegionConfigList', - 'in' => 'formData', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The regions of the template. You can create cloud computers by using a template only within the same region as the template itself.'."\n" - ."\n" - .'> You can specify up to 20 regions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'SnapshotPolicyId' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-35fvn8m21pnx2****', - ], - 'ResourceInstanceType' => [ - 'description' => 'The ID of the cloud computer type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eds.enterprise_office.8c16g', - ], - 'VolumeEncryptionEnable' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* false (default): disables disk encryption.'."\n" - .'* true: enables disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', + 'description' => 'The returned information.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token that determines the start point of the next query. If this parameter is empty, no next query is to be sent.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', 'title' => ''], + 'TagResources' => [ + 'description' => 'The resources and their tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about a resource and its tag.', + 'type' => 'object', + 'properties' => [ + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'design', 'title' => ''], + 'ResourceType' => [ + 'description' => 'The resource type.', + 'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => 'Cloud computer'], + 'type' => 'string', + 'example' => 'ALIYUN::GWS::INSTANCE', + 'title' => '', + ], + 'ResourceId' => ['description' => 'The ID of the resource, that is, the ID of the cloud computer.', 'type' => 'string', 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'department', 'title' => ''], ], - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that you want to use to encrypt disks. You can call the [ListKeys](~~28951~~) operation to query KMS keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a7b3c0c8-b3a2-4876-b1cc-*********', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-709******', - ], - 'SubnetId' => [ - 'description' => 'The subnet ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1yiu**********', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, - 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Queries the list of tags that are added to cloud computers', + 'description' => '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`.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"design\\",\\n \\"ResourceType\\": \\"ALIYUN::GWS::INSTANCE\\",\\n \\"ResourceId\\": \\"ecd-ia2zw38bi6cm7****\\",\\n \\"TagKey\\": \\"department\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTransferFileDownloadUrl' => [ + 'summary' => 'Retrieves the download URLs for transferred files.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'SiteConfigList', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '数据是客户端用户操作时产生，无法通过用例获取', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => 'trt-hffhi4nmqoi4****', 'title' => ''], + ], + [ + 'name' => 'FileIds', + 'in' => 'query', 'style' => 'flat', 'schema' => [ - 'description' => '区域配置管理', + 'description' => 'The list of file IDs to query.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SiteId' => [ - 'description' => '站点ID。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outside_mainland' => '港澳台和海外', - 'mainland' => '中国内地（大陆）', - ], - 'example' => 'mainland', - ], - 'AppRuleId' => [ - 'description' => '应用管控策略ID', - 'type' => 'string', - 'required' => false, - 'example' => 'bwr-5a5371e0db954d********', - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The ID of the file to query.', 'type' => 'string', 'required' => false, 'example' => 'trf-i4pz8emx2k2fr****', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ChargeType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'PostPaid', - 'PrePaid', + 'description' => 'The response elements.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F1F01499-8F3D-5657-91AD-48177EB****', 'title' => ''], + 'Urls' => [ + 'description' => 'The list of download URL information for the files.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about a file download URL.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'trf-i4pz8emx2k2fr****', 'title' => ''], + 'Url' => ['description' => 'The download URL of the file.', 'type' => 'string', 'example' => 'http://xxsy-transfer.oss-cn-beijing.aliyuncs.com/xxxx', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the file.', + 'enumValueTitles' => ['UPLOADING' => 'The file is being uploaded.', 'DELETING' => 'The file is being deleted.', 'DELETED' => 'The file is deleted.', 'UPLOADED' => 'The file is uploaded.'], + 'type' => 'string', + 'example' => 'DELETED', + 'title' => '', + ], + 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'document.txt', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Obtain the download URL of the transfer file', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Period', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '6', - 'minimum' => '1', - ], - ], - [ - 'name' => 'PeriodUnit', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'Month', - 'Year', - 'Week', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListTransferFileDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1F01499-8F3D-5657-91AD-48177EB****\\",\\n \\"Urls\\": [\\n {\\n \\"FileId\\": \\"trf-i4pz8emx2k2fr****\\",\\n \\"Url\\": \\"http://xxsy-transfer.oss-cn-beijing.aliyuncs.com/xxxx\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"FileName\\": \\"document.txt\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListTransferFiles' => [ + 'summary' => 'Queries the file information of a file transmission task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AutoPay', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '数据是客户端用户操作时产生，无法通过用例获取', 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'AutoRenew', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the transmission task.', 'type' => 'string', 'required' => false, 'example' => 'trt-03tdwg4tcuwdzv****', 'title' => ''], ], [ - 'name' => 'UserDuration', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enum' => [ - '120', - '250', - '360', - ], - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'PostPaidAfterUsedUp', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PlainResult', - 'description' => 'PlainResult'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'b-0cc7rx533*****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The creation result.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '791CC0D3-1A38-573B-8F5F-********', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'NextToken' => ['description' => 'The returned value of `NextToken` is a pagination token, which can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****', 'title' => ''], + 'MaxResults' => ['description' => 'The number of entries to return on each page.'."\n" + ."\n" + .'Maximum value: 100.'."\n" + ."\n" + .'Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Files' => [ + 'description' => 'The files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the file.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The file ID.', 'type' => 'string', 'example' => 'trf-a213msf****', 'title' => ''], + 'Name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'Test file', 'title' => ''], + 'IconUrl' => ['description' => 'The URL of the file icon.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- For image file types (.png, .jpg, .jpeg, .gif, .webp, and .svg), the URL of the specific image is returned.'."\n" + ."\n" + .'- For other file types, the URL of the default image is returned.', 'type' => 'string', 'example' => 'https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****', 'title' => ''], + 'Type' => ['description' => 'The file type.', 'type' => 'string', 'example' => 'txt', 'title' => ''], + 'Size' => ['description' => 'The file size.', 'type' => 'string', 'example' => '10853079', 'title' => ''], + 'Status' => [ + 'description' => 'The file status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- DELETING'."\n" + ."\n" + .'- DELETED'."\n" + ."\n" + .'- UPLOADED', + 'enumValueTitles' => ['DELETING' => '', 'DELETED' => '', 'UPLOADED' => ''], + 'type' => 'string', + 'example' => 'DELETED', + 'title' => '', + ], + 'OssFilePath' => ['description' => 'The path of the object in the OSS bucket.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- A value is returned for this parameter only when the object is stored in a custom OSS bucket.', 'type' => 'string', 'example' => 'transfer/1244234/****', 'title' => ''], + 'OssFileName' => ['description' => 'The name of the object stored in OSS.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- A value is returned for this parameter only when the object is stored in a custom OSS bucket.', 'type' => 'string', 'example' => 'Test file_0982836423402342', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"b-0cc7rx533*****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"791CC0D3-1A38-573B-8F5F-********\\"\\n}","type":"json"}]', - 'title' => 'CreateTemplate', - 'description' => 'When you call this operation, take note of the following item:'."\n" - ."\n" - .'* Most parameters in templates are optional. When you create a template, Elastic Desktop Service (EDS) does not validate the existence or correctness of the parameter values you specify. The parameter values in the template are only verified when you use the template to create cloud computers.'."\n" - .'* For parameters that include the region attribute in the template, it\'s important to note that if the specified region doesn’t match the region where the template is used to create a cloud computer, those parameters will not take effect.'."\n", - ], - 'DescribeTemplates' => [ - 'summary' => 'Queries the details of cloud computer templates.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 20,\\n \\"Files\\": [\\n {\\n \\"Id\\": \\"trf-a213msf****\\",\\n \\"Name\\": \\"Test file\\",\\n \\"IconUrl\\": \\"https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****\\",\\n \\"Type\\": \\"txt\\",\\n \\"Size\\": \\"10853079\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"OssFilePath\\": \\"transfer/1244234/****\\",\\n \\"OssFileName\\": \\"Test file_0982836423402342\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListTransferFiles', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListTransferFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListUserAdOrganizationUnits' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TemplateIds', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the templates that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the template that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b-216bi6zpvsy****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TemplateName', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The name of the template. You can search for template by name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise AD office network ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-485361****', 'title' => ''], ], [ - 'name' => 'TemplateType', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板类型', - 'description' => 'The type of the template that you want to query. If you leave this parameter empty, all types of templates are queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* USER_TEMPLATE: custom templates.'."\n" - .'* SYSTEM_TEMPLATE: system templates provided by Alibaba Cloud.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'USER_TEMPLATE' => '', - 'SYSTEM_TEMPLATE' => '', - ], - 'example' => 'USER_TEMPLATE', - ], + 'name' => 'Filter', + 'in' => 'query', + 'schema' => ['description' => 'The string that you enter for fuzzy search.'."\n", 'type' => 'string', 'required' => false, 'example' => 'develop', 'title' => ''], ], [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-dnz9xjgbm8*****', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request or if no next request exists. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword that you can use to search for the template. It can be the template ID or the template name. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 500.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'example' => '100', 'title' => ''], ], - [ - 'name' => 'ProductType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '产品类型', - 'description' => 'The service type. Set the value to `CloudDesktop`.'."\n" - ."\n" - .'*'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '', - ], - 'example' => 'CloudDesktop', - ], - ], - [ - 'name' => 'BizRegionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '业务地域', - 'description' => 'The region that you can use to filter templates.'."\n" - ."\n" - .'> If you specify this parameter, only templates that are created in the specified region are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'OUNames' => [ + 'description' => 'The OUs of the AD domain.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the OU in the AD domain.'."\n", + 'type' => 'object', + 'properties' => [ + 'OfficeSiteId' => ['description' => 'The enterprise AD office network ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-485361****', 'title' => ''], + 'OUName' => ['description' => 'The canonical name (CNAME) of the OU in the AD domain controller.'."\n", 'type' => 'string', 'example' => 'example.com/wuying_computers', 'title' => ''], + 'DisplayOUName' => ['description' => 'The name of the OU.'."\n", 'type' => 'string', 'example' => 'wuying_computers', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['description' => 'A pagination token.'."\n", 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ListUserAdOrganizationUnits', + 'summary' => 'Obtains the organizational units (OUs) of an Active Directory (AD) domain that is connected to an enterprise AD office network (formerly workspace).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUserAdOrganizationUnits'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OUNames\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-485361****\\",\\n \\"OUName\\": \\"example.com/wuying_computers\\",\\n \\"DisplayOUName\\": \\"wuying_computers\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n example.com/Domain Controllers\\n cn-hangzhou+dir-485361****\\n \\n 28978806-3938-5774-B107-0DAEC97C5BD1\\n","errorExample":""}]', + ], + 'LockVirtualMFADevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BizType', - 'in' => 'formData', - 'schema' => [ - 'title' => '业务类型', - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'SerialNumber', + 'in' => 'query', + 'schema' => ['description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" + ."\n" + .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device bound to AD users.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'ListResult', - 'description' => 'ListResult'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The templates.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GmtCreate' => [ - 'description' => 'The time when the template was created. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).'."\n", - 'type' => 'string', - 'example' => '2025-04-25T05:18:46.000+00:00', - ], - 'GmtModified' => [ - 'description' => 'The time when the template was updated. The time follows the ISO 8601 standard in the yyyy-MM-ddThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2025-04-25T05:18:46.000+00:00', - ], - 'TemplateId' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'example' => 'b-0caoeogs88y*****', - ], - 'TemplateName' => [ - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The template description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'TemplateType' => [ - 'description' => 'The template type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* USER_TEMPLATE: custom templates.'."\n" - .'* SYSTEM_TEMPLATE: system templates.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'USER_TEMPLATE' => '', - 'SYSTEM_TEMPLATE' => '', - ], - 'example' => 'USER_TEMPLATE', - ], - 'ProductType' => [ - 'description' => 'The service type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CloudDesktop: cloud computers.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'SystemDiskSize' => [ - 'description' => 'The size of the system disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], - 'SystemDiskPerformanceLevel' => [ - 'description' => 'The performance level (PL) of the system disk.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* PL1: a PL1 Enterprise SSD (ESSD).'."\n" - .'* PL0: a PL0 ESSD.'."\n" - .'* AutoPL: an AutoPL SSD.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PL1' => '', - 'PL0' => '', - 'AutoPL' => '', - ], - 'example' => 'AutoPL', - ], - 'DataDiskList' => [ - 'description' => 'The sizes of the data disks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Size' => [ - 'description' => 'The size of the data disk. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'PerformanceLevel' => [ - 'description' => 'The PL of the data disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1: a PL1 ESSD.'."\n" - .'* PL0: a PL0 ESSD.'."\n" - .'* AutoPL: an AutoPL SSD.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PL1' => '', - 'PL0' => '', - 'AutoPL' => '', - ], - 'example' => 'AutoPL', - ], - ], - 'description' => '', - ], - ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'm-5q8ehbihx*****', - ], - 'ImageType' => [ - 'description' => 'The image type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* User: a custom image.'."\n" - .'* Shared: a shared image.'."\n" - .'* System: a system image.'."\n" - .'* Community: a community image.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'User' => '', - 'Shared' => '', - 'System' => '', - 'Community' => '', - ], - 'example' => 'User', - ], - 'DefaultLanguage' => [ - 'description' => 'The default language of the template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: English.'."\n" - .'* zh-HK: Chinese, Traditional (Hong Kong, China).'."\n" - .'* zh-CN: Simplified Chinese.'."\n" - .'* ja-JP: Japanese.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'zh-CN', - ], - 'PolicyGroupId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => 'pg-0caoeogkhz*****', - ], - 'TimerGroupId' => [ - 'description' => 'The ID of the scheduled task group.'."\n", - 'type' => 'string', - 'example' => 'bcc-dweha*****', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-a5fqjjqaejt***', - ], - 'ResourceTagList' => [ - 'description' => 'The tags added to cloud computers. A tag is a key-value pair.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The property value.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - 'description' => '', - ], - ], - 'RegionConfigList' => [ - 'description' => 'The region-related settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'SnapshotPolicyId' => [ - 'description' => 'The snapshot policy ID.'."\n", - 'type' => 'string', - 'example' => 'sp-b9fasjuu0*****', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing+dir-3040*****', - ], - 'SubnetId' => [ - 'description' => 'The subnet ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-dgea1*****', - ], - 'VolumeEncryptionEnable' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used to encrypt the disk.'."\n", - 'type' => 'string', - 'example' => '3bc77be0-cbce-4a29-b07b-13f16394****', - ], - 'ResourceInstanceType' => [ - 'description' => 'The ID of the cloud computer type.'."\n", - 'type' => 'string', - 'example' => 'eds.enterprise_office.4c8g', - ], - 'MemorySize' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8192', - ], - 'CpuCount' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'GpuSpec' => [ - 'description' => 'The GPU memory information. This parameter is supported only by Graphics cloud computer types.'."\n", - 'type' => 'string', - 'example' => '4GiB', - ], - ], - 'description' => '', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1871984F-51F6-5588-BAF6-******', - ], - 'SiteConfigList' => [ - 'description' => '区域配置管理', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SiteId' => [ - 'description' => '站点名称。', - 'type' => 'string', - 'enumValueTitles' => [ - 'outside_mainland' => '港澳台和海外', - 'mainland' => '中国内地（大陆）', - ], - 'example' => 'mainland', - ], - 'AppRuleId' => [ - 'description' => '应用管控策略ID', - 'type' => 'string', - 'example' => 'bwr-5a5371e0*******', - ], - ], - ], - ], - 'ChargeType' => [ - 'type' => 'string', - ], - 'Period' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PeriodUnit' => [ - 'type' => 'string', - ], - 'AutoPay' => [ - 'type' => 'boolean', - ], - 'AutoRenew' => [ - 'type' => 'boolean', - ], - 'UserDuration' => [ - 'type' => 'string', - ], - 'PostPaidAfterUsedUp' => [ - 'type' => 'boolean', - ], - ], - 'description' => '', - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of templates.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '94', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The modification result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1871984F-51F6-5588-BAF6-*******', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'title' => 'LockVirtualMFADevice', + 'summary' => 'Locks a multi-factor authentication (MFA) device that is in the NORMAL state.', + 'description' => 'After a virtual MFA device is locked, its status changes to LOCKED. The Active Directory (AD) user who uses the virtual MFA device is unable to pass MFA and is therefore unable to log on to the client. You can call the [UnlockVirtualMFADevice](~~206212~~) operation to unlock the device.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LockVirtualMFADevice'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"GmtModified\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"TemplateId\\": \\"b-0caoeogs88y*****\\",\\n \\"TemplateName\\": \\"我的模板001\\",\\n \\"Description\\": \\"我的模板\\",\\n \\"TemplateType\\": \\"USER_TEMPLATE\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"SystemDiskSize\\": 80,\\n \\"SystemDiskPerformanceLevel\\": \\"AutoPL\\",\\n \\"DataDiskList\\": [\\n {\\n \\"Size\\": \\"100\\",\\n \\"PerformanceLevel\\": \\"AutoPL\\"\\n }\\n ],\\n \\"ImageId\\": \\"m-5q8ehbihx*****\\",\\n \\"ImageType\\": \\"User\\",\\n \\"DefaultLanguage\\": \\"zh-CN\\",\\n \\"PolicyGroupId\\": \\"pg-0caoeogkhz*****\\",\\n \\"TimerGroupId\\": \\"bcc-dweha*****\\",\\n \\"ResourceGroupId\\": \\"rg-a5fqjjqaejt***\\",\\n \\"ResourceTagList\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"RegionConfigList\\": [\\n {\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"SnapshotPolicyId\\": \\"sp-b9fasjuu0*****\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-3040*****\\",\\n \\"SubnetId\\": \\"vsw-dgea1*****\\",\\n \\"VolumeEncryptionEnable\\": false,\\n \\"VolumeEncryptionKey\\": \\"3bc77be0-cbce-4a29-b07b-13f16394****\\",\\n \\"ResourceInstanceType\\": \\"eds.enterprise_office.4c8g\\",\\n \\"MemorySize\\": 8192,\\n \\"CpuCount\\": 4,\\n \\"GpuSpec\\": \\"4GiB\\"\\n }\\n ],\\n \\"RequestId\\": \\"1871984F-51F6-5588-BAF6-******\\",\\n \\"SiteConfigList\\": [\\n {\\n \\"SiteId\\": \\"mainland\\",\\n \\"AppRuleId\\": \\"bwr-5a5371e0*******\\"\\n }\\n ],\\n \\"ChargeType\\": \\"\\",\\n \\"Period\\": 0,\\n \\"PeriodUnit\\": \\"\\",\\n \\"AutoPay\\": true,\\n \\"AutoRenew\\": true,\\n \\"UserDuration\\": \\"\\",\\n \\"PostPaidAfterUsedUp\\": true\\n }\\n ],\\n \\"TotalCount\\": 94,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1871984F-51F6-5588-BAF6-*******\\"\\n}","type":"json"}]', - 'title' => 'DescribeTemplates', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', ], - 'ModifyTemplate' => [ - 'summary' => 'Modifies a custom cloud computer template.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'MigrateDesktops' => [ + 'summary' => 'Migrates one or more cloud computers to a new office network.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '128374', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. To get a list of supported regions, call the [DescribeRegions](~~196646~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'TargetOfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the target office network.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen+dir-388505****', 'title' => ''], + ], + [ + 'name' => 'TargetSubnetId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TargetMemberIp', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not publicly available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computers to migrate. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The cloud computer ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-39clsqyxr****', 'title' => ''], 'required' => true, - 'example' => 'b-0caoeogs88y*****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'TemplateName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name. It must meet the following criteria:'."\n" - ."\n" - .'* It can be 2 to 126 characters in length.'."\n" - .'* It must begin with a letter and cannot start with `http://` or `https://`.'."\n" - .'* It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). Note: Periods (.) are not supported in the name.'."\n", - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E46DECEC-AC72-570E-958B-B52A4B****', 'title' => ''], + ], + 'description' => 'The response parameters.', + 'title' => '', 'example' => '', - 'maxLength' => 126, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ChooseClusterError.ZoneId', 'errorMessage' => 'Cannot choose zone, please try other zone.', 'description' => 'The property of the resource zone does not match. Check whether the target office network supports the zone to which the resource belongs.'], + ], + ], + 'title' => 'MigrateDesktops', + 'changeSet' => [ + ['createdAt' => '2024-11-20T09:52:49.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-06-19T06:02:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-01T13:41:14.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateDesktops'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The template description. It must meet the following criteria:'."\n" - ."\n" - .'* It can be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n" - .'* It can contain letters, digits, and special characters, including spaces. Note: You can use carriage returns to break lines.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testDescription', - 'maxLength' => 256, - 'minLength' => 2, + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:MigrateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E46DECEC-AC72-570E-958B-B52A4B****\\"\\n}","type":"json"}]', + ], + 'MigrateImageProtocol' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SystemDiskSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '系统盘大小/GB', - 'description' => 'The size of the system disk. Unit: GiB. Valid values: 40 to 500. Increments: 10 GiB.'."\n" - ."\n" - .'> The system disk size must be at least as large as the configured image size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2040', - 'minimum' => '40', - 'example' => '80', - ], + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SystemDiskPerformanceLevel', - 'in' => 'formData', + 'name' => 'TargetProtocolType', + 'in' => 'query', 'schema' => [ - 'title' => '系统盘性能等级', - 'description' => 'The performance level (PL) of the system disk.'."\n" - ."\n" - .'> Only cloud computers of the Graphics or High Frequency type support Enterprise SSDs (ESSDs).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1: a PL1 ESSD.'."\n" - .'* PL0: a PL0 ESSD.'."\n" - .'* AutoPL: an AutoPL ESSD.'."\n", + 'description' => 'The protocol to which you want to update the image protocols. Set the value to ASP.', + 'enumValueTitles' => ['ASP' => 'Adaptive Streaming Protocol'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'PL1' => '', - 'PL0' => '', - 'AutoPL' => '', - ], - 'example' => 'AutoPL', + 'docRequired' => true, + 'example' => 'ASP', + 'title' => '', ], ], [ - 'name' => 'DataDiskList', - 'in' => 'formData', - 'style' => 'flat', + 'name' => 'ImageId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'description' => 'The image IDs.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Size' => [ - 'description' => 'The size of the data disk. Unit: GiB.Valid range: 40 to 2040 GiB with an increment of 10 GiB.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2040', - 'minimum' => '0', - 'example' => '40', - ], - 'PerformanceLevel' => [ - 'description' => 'The PL of the data disk. Default value: `AutoPL`.'."\n" - .'Valid values:'."\n" - .'* PL1: a PL1 ESSD'."\n" - .'* PL0: a PL0 ESSD'."\n" - .'* AutoPL: an AutoPL ESSD', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'AutoPL' => 'AutoPL', - ], - ], + 'items' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-gqudcafrqcex9****', 'title' => ''], + 'required' => true, + 'maxItems' => 500, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4D4E5AF5-DF28-5FE7-85C7-9F98315B****', 'title' => ''], + 'FailedIds' => [ + 'description' => 'The IDs of the images whose protocols failed to be updated.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the image whose protocol failed to be updated.', 'type' => 'string', 'example' => '[\'m-5rsjelm66bs3j****\']', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'MigrateImageProtocol', + 'summary' => 'Update the protocols of images to Adaptive Streaming Protocol (ASP).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateImageProtocol'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '镜像id', - 'description' => 'The ID of the cloud computer image. You can query image IDs on the Images page. System images and custom images are supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:MigrateImageProtocol', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D4E5AF5-DF28-5FE7-85C7-9F98315B****\\",\\n \\"FailedIds\\": [\\n \\"[\'m-5rsjelm66bs3j****\']\\"\\n ]\\n}","type":"json"}]', + ], + 'ModifyADConnectorDirectory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PolicyGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '策略ID', - 'description' => 'The ID of the policy group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DefaultLanguage', - 'in' => 'formData', + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the directory.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd**** ', 'title' => ''], + ], + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name. The name must be 2 to 255 characters in length and must be in the two-part domain name format, such as `example.com`. You can register each domain name only once.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], + ], + [ + 'name' => 'DomainUserName', + 'in' => 'query', + 'schema' => ['description' => 'The username of the domain administrator. The username can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'sAMAccountName', 'title' => ''], + ], + [ + 'name' => 'DomainPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the domain administrator. The username can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''], + ], + [ + 'name' => 'DirectoryName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the AD directory.', 'type' => 'string', 'required' => false, 'example' => 'testDirectoryName ', 'title' => ''], + ], + [ + 'name' => 'SubDomainName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name of the existing AD subdomain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'child.example.com ', 'title' => ''], + ], + [ + 'name' => 'MfaEnabled', + 'in' => 'query', 'schema' => [ - 'title' => '默认语言', - 'description' => 'The default language of the cloud computer during startup. This parameter takes effect only when the cloud computer is created from a system image.'."\n" + 'description' => 'Specifies whether to enable Multi-Factor Authentication (MFA). After you enable MFA, all AD users in the directory must enter a dynamic verification code generated by the virtual MFA device in addition to a correct password when they log on to a cloud computer.'."\n" + ."\n" + .'> When end users log on to a cloud computer for the first time, they must bind an MFA device.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* en-US: English.'."\n" - .'* zh-HK: Chinese, Traditional (Hong Kong, China).'."\n" - .'* zh-CN: Simplified Chinese.'."\n" - .'* ja-JP: Japanese.'."\n", - 'type' => 'string', + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' false (default)'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'zh-CN', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'TimerGroupId', - 'in' => 'formData', + 'name' => 'DnsAddress', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '中心定时任务组ID', - 'description' => 'The ID of the scheduled task group.'."\n", - 'type' => 'string', + 'description' => 'The IP address of the DNS server corresponding to the enterprise AD. You can specify only one IP address. Make sure that the specified IP address is accessible in the network of the selected vSwitch.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], 'required' => false, - 'example' => 'bcc-dweha*****', + 'example' => '127.0.**.** ', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', + 'name' => 'SubDomainDnsAddress', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', + 'description' => 'The DNS address of the existing AD subdomain.\\'."\n" + .'If you specify the `SubDomainName` parameter but you do not specify this parameter, the DNS address of the subdomain is the same as the DNS address of the parent domain.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The DNS address of the existing AD subdomain.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], 'required' => false, - 'example' => 'rg-a5fqjjqaejt***', + 'example' => '127.0.**.** ', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'ResourceTagList', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => 'The tags added to cloud computers. Specify tags in key-value pairs. You can specify up to 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'department', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'design', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 20, - ], + 'name' => 'AdHostname', + 'in' => 'query', + 'schema' => ['description' => 'The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.', 'type' => 'string', 'required' => false, 'example' => 'cnshsv21hmcdc01', 'title' => ''], ], [ - 'name' => 'RegionConfigList', - 'in' => 'formData', - 'style' => 'flat', + 'name' => 'OUName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the organizational unit (OU) in the AD domain. You can call the ListUserAdOrganizationUnits operation to obtain the name of the OU.', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The regions by which you can search for cloud computer templates. When this parameter takes effect, cloud computer templates are matched based on the specified regions.'."\n" - ."\n" - .'> You can specify up to 20 regions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], - 'SnapshotPolicyId' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-35fvn8m2*****', - ], - 'ResourceInstanceType' => [ - 'description' => 'The ID of the cloud computer type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eds.enterprise_office.8c16g', - ], - 'VolumeEncryptionEnable' => [ - 'description' => 'Specifies whether to enable disk encryption.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* false (default): disables disk encryption.'."\n" - .'* true: enables disk encryption.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', - ], - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that you want to use to encrypt disks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a7b3c0c8-b3a2-4876-b1cc-116dddc9****', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-709****', - ], - 'SubnetId' => [ - 'description' => 'The subnet ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-adjrehad1****', - ], - ], - 'required' => false, - 'description' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'required' => false, - 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyADConnectorDirectory', + 'summary' => 'Modifies an Active Directory (AD) directory.', + 'description' => 'You can modify the following domain name- and Domain Name System (DNS)-related parameters only for Active Directory (AD) directories that are in the ERROR or REGISTERING state: `DomainName`, `SubDomainName`, `DnsAddress.N`, and `SubDomainDnsAddress`.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorDirectory'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]', + ], + 'ModifyADConnectorOfficeSite' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SiteConfigList', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SiteId' => [ - 'type' => 'string', - 'required' => false, - ], - 'AppRuleId' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'ChargeType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'PostPaid', - 'PrePaid', - ], - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Period', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '6', - 'minimum' => '1', - ], + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'PeriodUnit', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'Month', - 'Year', - 'Week', - ], - ], + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => ['description' => 'The domain name of the enterprise AD system. You can register each domain name only once.', 'type' => 'string', 'required' => false, 'example' => 'example.com', 'title' => ''], ], [ - 'name' => 'AutoPay', - 'in' => 'formData', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'name' => 'DomainUserName', + 'in' => 'query', + 'schema' => ['description' => 'The username of the domain administrator. The username can be up to 64 characters in length.'."\n" + ."\n" + .'> Specify the value of the sAMAccountName parameter instead of the value of the userPrincipalName parameter as the username.', 'type' => 'string', 'required' => false, 'example' => 'Administrator', 'title' => ''], ], [ - 'name' => 'AutoRenew', - 'in' => 'formData', + 'name' => 'DomainPassword', + 'in' => 'query', + 'schema' => ['description' => 'The password of the domain administrator. The username can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'testPassword', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteName', + 'in' => 'query', + 'schema' => ['description' => 'The office network name. The name must be 2 to 255 characters in length. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'SubDomainName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the subdomain in the enterprise AD domain.'."\n", 'type' => 'string', 'required' => false, 'example' => 'child.example.com', 'title' => ''], + ], + [ + 'name' => 'MfaEnabled', + 'in' => 'query', 'schema' => [ + 'description' => 'Specifies whether to enable multi-factor authentication (MFA).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", 'type' => 'boolean', 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'UserDuration', - 'in' => 'formData', + 'name' => 'DnsAddress', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IP addresses of the DNS servers corresponding to the enterprise ADs. You can specify only one DNS IP address.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address of the DNS server corresponding to the enterprise AD.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], 'required' => false, - 'enum' => [ - '120', - '250', - '360', - ], + 'example' => '127.0.*.*', + 'maxItems' => 1, + 'title' => '', ], ], [ - 'name' => 'PostPaidAfterUsedUp', - 'in' => 'formData', + 'name' => 'SubDomainDnsAddress', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'boolean', + 'description' => 'The IP addresses of the DNS servers corresponding to the enterprise AD subdomains. You can specify only one DNS IP address. If you specify `SubDomainName` and leave this parameter empty, the value is the same as that of the enterprise AD domain.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address of the DNS server corresponding to the enterprise AD subdomain.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX', 'title' => ''], 'required' => false, + 'example' => '127.0.*.*', + 'maxItems' => 1, + 'title' => '', ], ], + [ + 'name' => 'AdHostname', + 'in' => 'query', + 'schema' => ['description' => 'The hostname of the domain controller. The hostname must comply with the naming conventions for hostnames in Windows.', 'type' => 'string', 'required' => false, 'example' => 'beijing-ad01', 'title' => ''], + ], + [ + 'name' => 'OUName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the organizational unit (OU) in the AD domain. You can call the [ListUserAdOrganizationUnits](~~311259~~) operation to obtain OUs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers', 'title' => ''], + ], + [ + 'name' => 'BackupDns', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the DNS server corresponding to the secondary domain controller.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.2.100', 'title' => ''], + ], + [ + 'name' => 'BackupDCHostname', + 'in' => 'query', + 'schema' => ['description' => 'The hostname of the secondary domain controller.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dc002', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult', + 'description' => '', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the operation is successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyTemplate', - 'description' => '**'."\n" - ."\n" - .'**Warning** This operation employs the full parameter update logic to maintain compatibility between the no-configuration logic and the default update logic. In other words, any unspecified parameters are treated as empty.'."\n", - ], - 'DeleteTemplates' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'title' => 'ModifyADConnectorOfficeSite', + 'summary' => 'Modifies the basic properties of an enterprise Active Directory (AD) office network, such as the office network name and domain names of the enterprise AD subdomains.', + 'description' => 'You can modify parameters of domain names and Domain Name System (DNS) for enterprise AD office networks that are in the `ERROR` or `REGISTERED` state. The parameters include `DomainName`, `SubDomainName`, `DnsAddress.N`, and `SubDomainDnsAddress.N`.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorOfficeSite'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]', + ], + 'ModifyAclEntries' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'TemplateIds', - 'in' => 'formData', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The granularity to which the Internet access control policy is applicable.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- desktop: cloud computer granularity.'."\n" + ."\n" + .'- vpc: office network granularity.', + 'enumValueTitles' => ['desktop' => '', 'vpc' => ''], + 'type' => 'string', + 'required' => true, + 'example' => 'desktop', + 'title' => '', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the templates that you want to delete.'."\n", + 'description' => 'The instance IDs (office network IDs or cloud computer IDs) to which the Internet access control policy is applicable.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the template that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b-7ywwjrr50t1a*****', - ], - 'required' => false, + 'items' => ['description' => 'The instance ID (office network ID or cloud computer ID) to which the Internet access control policy is applicable.', 'type' => 'string', 'required' => false, 'example' => 'ecd-afhjuiwhfia***', 'title' => ''], + 'required' => true, 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BizType', - 'in' => 'formData', + 'name' => 'Policy', + 'in' => 'query', 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", + 'description' => 'The Internet access control policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- allow: allows access to the Internet.'."\n" + ."\n" + .'- disable: forbids access to the Internet.', + 'enumValueTitles' => ['allow' => '', 'deny' => ''], 'type' => 'string', - 'required' => false, - 'example' => 'null', + 'required' => true, + 'docRequired' => true, + 'example' => 'allow', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of response.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The modification result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The description of the error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', - ], - 'AccessDeniedDetail' => [ - 'description' => 'The information about the request denial..'."\n", - 'type' => 'string', - 'example' => 'None', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A1560565', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', - 'title' => 'DeleteTemplates', - 'summary' => 'Deletes custom cloud computer templates.', - 'description' => 'Deleting a template does not affect cloud computers created from it or the associated resources.'."\n", - ], - 'ModifyTemplateBaseInfo' => [ - 'summary' => 'Modifies the basic information of a custom cloud computer template, including the template name and template description.', - 'methods' => [ - 'post', + 'title' => 'ModifyAclEntries', + 'summary' => 'Modify the Internet access control policy on the office network or cloud computer granularity.', + 'description' => 'You can set different Internet access control policies at different granularities to achieve the effect of composite policies. For example, you can disable the Internet access on the office network granularity and enable the Internet access on specific cloud computer granularity. The effect is that all cloud computers in the office network except the specified cloud computers are not allowed to access the Internet.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAclEntries'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyAclEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A1560565\\"\\n}","type":"json"}]', + ], + 'ModifyAutoSnapshotPolicy' => [ + 'summary' => 'Modifies the configuration items of an automatic snapshot policy, including the policy name and snapshot retention period.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板ID', - 'description' => 'The template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b-0caoeogs88y*****', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~196646~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TemplateName', - 'in' => 'formData', - 'schema' => [ - 'title' => '模板名称', - 'description' => 'The template name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - 'maxLength' => 126, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'name' => 'PolicyId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => true, 'example' => 'sp-itcmrhqt01tdo****', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', + 'name' => 'PolicyName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain digits, colons (:), underscores (\\_), or hyphens (-). Default value: empty.', 'type' => 'string', 'required' => false, 'maxLength' => 64, 'minLength' => 2, 'example' => '系统自动快照', 'title' => ''], + ], + [ + 'name' => 'RetentionDays', + 'in' => 'query', + 'schema' => ['description' => 'The retention period of automatic snapshots. Unit: days. Valid values: 1 to 180.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => ['description' => 'The cron expression.', 'type' => 'string', 'required' => false, 'example' => '0 20 16 ? * 1,2,3,4,5,6,7', 'title' => ''], + ], + [ + 'name' => 'DiskType', + 'in' => 'query', 'schema' => [ - 'title' => '模板描述', - 'description' => 'The template description.'."\n", + 'description' => 'The type of cloud disk for which the automatic snapshot policy creates snapshots.', + 'enumValueTitles' => ['SYSTEM' => 'system cloud disk.', 'ALL' => 'all cloud disks.', 'DATA' => 'data cloud disk.'], 'type' => 'string', 'required' => false, - 'example' => 'This is description.', - 'maxLength' => 256, - 'minLength' => 2, + 'example' => 'ALL', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'BaseResult', - 'description' => 'BaseResult'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3D99C38F-DE7D-5109-BC06-43EC5D*****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"3D99C38F-DE7D-5109-BC06-43EC5D*****\\"\\n}","type":"json"}]', - 'title' => 'ModifyTemplateBaseInfo', - 'description' => 'This operation allows you to modify only the name and description of a custom cloud computer template. To change other parameters of the template, call the [ModifyTemplate](~~2925841~~) operation.'."\n", - ], - 'CreateBundle' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', + 'title' => 'Modify an automatic snapshot policy', + 'changeSet' => [ + ['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-08T08:35:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-02T02:41:20.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'], + ], ], + 'ramActions' => [], + ], + 'ModifyBundle' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ImageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'm-4zfb6zj728hhr****', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopType', + 'name' => 'BundleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance type of the cloud computers. You can call the [DescribeBundles](~~436974~~) operation to query cloud computer templates and obtain the instance types supported by the cloud computers from the `DesktopType` response parameter.'."\n" - ."\n" - .'> If you want the template to use a non-GPU-accelerated image, you can only select a non-GPU-accelerated instance type. If you want the template to use a GPU-accelerated image, you can only select a GPU-accelerated instance type.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecd.basic.large', - ], + 'schema' => ['description' => 'The ID of the cloud computer template that you want to modify.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b-2g65ljy4291vl****', 'title' => ''], ], [ - 'name' => 'RootDiskSizeGib', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the system disk. Unit: GiB. The value of this parameter must be consistent with the system disk size supported by the cloud computer instance type. For more information, see [Overview](~~188609~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '80', - ], + 'schema' => ['description' => 'The new image ID. The new image must meet the following conditions:'."\n" + ."\n" + .'* The new image must be in the Available state.'."\n" + .'* The operating system of the new image must be the same as that of the original image.'."\n" + .'* The required disk size for the new image cannot be greater than that for the original image.'."\n" + .'* The GPU type of the new image must be the same as that of the original image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'm-aea3oaww001np****', 'title' => ''], ], [ 'name' => 'BundleName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testBundleName', - ], + 'schema' => ['description' => 'The name of the new cloud computer template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'newName', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The description of the new cloud computer template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'newDescription', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'description' => 'The OS language. This parameter is available only for system images. Valid values:'."\n" + 'description' => 'The OS language. This parameter is available only for system images.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* zh-CN: Simplified Chinese'."\n" - .'* zh-HK: Traditional Chinese (Hong Kong)'."\n" .'* en-US: American English'."\n" - .'* ja-JP: Japanese'."\n", + .'* zh-HK: Traditional Chinese (Hong Kong)'."\n" + .'* zh-CN: Simplified Chinese.'."\n" + ."\n" + .'* ja-JP: Japanese', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], + 'enumValueTitles' => ['en-US' => '', 'zh-HK' => '', 'zh-CN' => '', 'ja-JP' => ''], 'example' => 'zh-CN', + 'title' => '', ], ], - [ - 'name' => 'UserDiskSizeGib', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The data disk sizes. You can configure only one data disk.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data disk size. You can configure only one data disk. Unit: GiB. The value of this parameter must be consistent with the data disk size supported by the cloud computer instance type. For more information, see [Overview](~~188609~~).'."\n" - ."\n" - .'> The value of the UserDiskSizeGib parameter in the template must be greater than the value of the DataDiskSize parameter in the image.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'required' => true, - 'example' => '70', - 'maxItems' => 1, + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n4636DBE0-BBB4-4076-8B8E-94D21A9A****\\r\\n","errorExample":""}]', + 'title' => 'ModifyBundle', + 'summary' => 'Modifies a custom cloud computer template.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-23T10:38:59.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBundle'], + ], + ], + 'ramActions' => [], + 'description' => 'Only custom desktop templates can be modified.'."\n", + ], + 'ModifyCdsFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RootDiskPerformanceLevel', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The performance level (PL) of the system disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see [Enhanced SSDs](~~122389~~).'."\n" - ."\n" + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who uses the network disk.'."\n", 'type' => 'string', 'required' => false, 'example' => 'user01', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise drive ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-643267****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'NewFileName.txt'."\n", 'maxLength' => 1024, 'minLength' => 1, 'title' => ''], + ], + [ + 'name' => 'ConflictPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The processing policy when a file with the same name appears.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* refuse: If you want to create a file that uses the same name as an existing file in the cloud, the system denies your request and returns the details of the existing file.'."\n" + .'* auto_rename: automatically renames a file if the file has the same name as an existing file in the cloud. By default, the current point in time is appended to the end of the original file name. Example: xxx20240102\\_150405.'."\n" + .'* ignore: allows the file to be with the same name.'."\n" + .'* over_write: After you create a file that uses the same name as an existing file in the cloud, the new file overwrites the existing file.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['refuse' => '', 'auto_rename' => '', 'ignore' => '', 'over_write' => ''], + 'example' => 'ignore', + 'default' => 'refuse', + 'enum' => ['refuse', 'auto_rename', 'ignore'], + 'title' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the team space.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Code' => ['description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], + 'Data' => [ + 'description' => 'Specifies whether data is returned.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* false: Data fails to be returned.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' : Data is returned.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'enumValueTitles' => [' false' => '', 'true' => ''], + 'example' => 'true', + 'title' => '', + ], + 'Message' => ['description' => 'The returned error message. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'ModifyCdsFile', + 'summary' => 'Modifies the attributes of a disk file or folder, such as the file name.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFile'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ModifyCdsFileShareLink' => [ + 'summary' => 'Modifies the link for file sharing.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai+cds-135515****', 'title' => ''], + ], + [ + 'name' => 'ShareId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file sharing task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7JQX1Fs****', 'title' => ''], + ], + [ + 'name' => 'SharePwd', + 'in' => 'query', + 'schema' => ['description' => 'The length of the access code. Valid values: 6 to 8. Unit: bytes. If you leave this parameter empty or set it to null, no access code is required. If you use a token to share files, you do not need to configure this parameter. The access code can contain only visible ASCII characters.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12345678', 'maxLength' => 8, 'minLength' => 6, 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sharing status.'."\n" + ."\n" .'Valid values:'."\n" ."\n" - .'* PL1'."\n" + .'* disabled: The sharing task is canceled.'."\n" ."\n" .' '."\n" ."\n" @@ -31463,15 +29175,48 @@ ."\n" .' '."\n" ."\n" - .'* PL0'."\n" + .'* enabled: The sharing task is valid.'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' '."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['disabled' => '', 'enabled' => ''], + 'example' => 'enabled', + 'enum' => ['disabled', 'enabled'], + 'title' => '', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => ['description' => 'The time when the file sharing link expires. The value of this parameter follows the RFC 3339 standard. Example: "2020-06-28T11:33:00.000+08:00". If this parameter is set to "", the file sharing link never expires.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-07-20T06:30:22.365Z', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the file sharing task. The description must be 0 to 1,024 characters in length.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testDescription', 'maxLength' => 1024, 'minLength' => 0, 'title' => ''], + ], + [ + 'name' => 'ShareName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the file sharing task. If you do not configure this parameter, the sharing task name is the first ID that is returned in the file_id_list value.'."\n" + ."\n" + .'> The sharing task name must be 0 to 128 characters in length.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'File sharing', 'maxLength' => 128, 'minLength' => 0, 'title' => ''], + ], + [ + 'name' => 'DisablePreview', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to prohibit the preview of the files that are being shared.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* PL3'."\n" + .'* true'."\n" ."\n" .' '."\n" ."\n" @@ -31479,33 +29224,30 @@ ."\n" .' '."\n" ."\n" - .'* PL2'."\n" + .'* false'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n", - 'type' => 'string', + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL1', + 'docRequired' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'UserDiskPerformanceLevel', + 'name' => 'DisableSave', 'in' => 'query', 'schema' => [ - 'description' => 'The PL of the data disk. When the cloud computer instance type that is specified by the DesktopType parameter is set to a graphical instance type or instance type with a high clock speed, you can set the performance level of the disks. For more information about the differences among disks at different PLs, see [Enhanced SSDs](~~122389~~).'."\n" + 'description' => 'Specifies whether to prohibit the dump of the files that are being shared.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* PL1'."\n" + .'* false'."\n" ."\n" .' '."\n" ."\n" @@ -31513,15 +29255,30 @@ ."\n" .' '."\n" ."\n" - .'* PL0'."\n" + .'* true'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" - .' '."\n" + .' '."\n", + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [' false' => '', 'true' => ''], + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'DisableDownload', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to prohibit the download of the files that are being shared.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* PL3'."\n" + .'* false'."\n" ."\n" .' '."\n" ."\n" @@ -31529,2580 +29286,1795 @@ ."\n" .' '."\n" ."\n" - .'* PL2'."\n" + .'* true'."\n" ."\n" .' '."\n" ."\n" .' '."\n" ."\n" .' '."\n", - 'type' => 'string', + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL1', + 'docRequired' => false, + 'enumValueTitles' => [' false' => '', 'true' => ''], + 'example' => 'false', + 'title' => '', ], ], + [ + 'name' => 'PreviewLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be previewed. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'SaveLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be dumped. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'DownloadLimit', + 'in' => 'query', + 'schema' => ['description' => 'The limit on the number of times that the shared files can be downloaded. The value of this parameter must be equal to or greater than 0. The value 0 specifies that no limit is imposed on the number of times that the shared files can be downloaded.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PreviewCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of times that the shared files are previewed. The value of this parameter must be equal to or greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SaveCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of times that the shared files are dumped. The value of this parameter must be equal to or greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DownloadCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of times that the shared files are downloaded. The value of this parameter must be equal to or greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ReportCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of times that the shared files are reported. The value of this parameter must be equal to or greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'VideoPreviewCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of times that the videos are previewed in the shared files. The value of this parameter must be equal to or greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'BundleId' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'b-cezrnfgecbich****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'Code' => ['description' => 'The modification result. The value success indicates that the modification is successful. If the modification failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The data information.'."\n", '$ref' => '#/components/schemas/CdsFileShareLinkModel', 'title' => '', 'example' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', 'title' => ''], + 'Success' => [ + 'description' => 'The request status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false: The request fails.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"BundleId\\": \\"b-cezrnfgecbich****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nb-cezrnfgecbich****\\nA90B77D3-261E-4AB2-A860-2FA2098D****\\n","errorExample":""}]', - 'title' => 'CreateBundle', - 'summary' => 'Creates a custom cloud computer template.', - 'description' => 'Cloud computer templates include system templates and custom templates. A system template is the default template provided by Alibaba Cloud. You can call this operation to create a custom template.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeBundles' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Description\\": \\"文件分享链接。\\",\\n \\"SaveLimit\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n },\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifyCdsFileShareLink', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFileShareLink'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ModifyCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyCenterPolicy' => [ + 'summary' => 'Modifies a configuration that does not have a region-specific policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", + 'description' => 'The region ID. Set the value to `cn-shanghai`.', + 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai)'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'example' => 'cn-shanghai', + 'title' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud computer policy ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], + ], + [ + 'name' => 'BusinessType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", + 'description' => 'The business type.', + 'enumValueTitles' => [1 => 'Public cloud', 8 => 'Commercial edition'], 'type' => 'integer', 'format' => 'int32', - 'required' => false, + 'required' => true, 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The token that is used to start the next query.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['app' => 'Cloud applications', 'desktop' => 'Cloud computers'], 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'required' => true, + 'docRequired' => false, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'BundleType', + 'name' => 'Clipboard', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the cloud computer template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system template'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CUSTOM: custom template'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The clipboard permissions.', + 'enumValueTitles' => ['read' => 'One-way allowed. You can copy local content to the cloud computer, but not from the cloud computer to local.', 'readwrite' => 'Two-way allowed. You can copy content between local and the cloud computer.', 'write' => 'One-way allowed. You can copy content from the cloud computer to local, but not from local to the cloud computer.', 'off' => 'Two-way disabled. No copying is allowed between the cloud computer and local. \\[Default]'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'CUSTOM' => '', - ], - 'example' => 'SYSTEM', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DesktopTypeFamily', + 'name' => 'LocalDrive', 'in' => 'query', 'schema' => [ - 'description' => 'The instance family of the cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* eds.graphics: graphical instance families'."\n" - .'* eds.hf: instance families with high clock speeds'."\n" - .'* eds.general: general-purpose instance families', + 'description' => 'The local disk mapping permissions.', + 'enumValueTitles' => ['read' => 'Read-only. The cloud computer maps the local disk, but you can only read (copy) local files—not modify them.', 'readwrite' => 'Read and write. The cloud computer maps the local disk, and you can both read (copy) and modify local files.', 'off' => 'Disabled. The cloud computer does not map the local disk. \\[Default]'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'eds.graphics' => '', - 'eds.hf' => '', - 'eds.general' => '', - ], - 'example' => 'eds.general', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'CpuCount', + 'name' => 'UsbRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The number of vCPUs contained in the cloud computer instance type.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'USB redirection.', + 'enumValueTitles' => ['off' => 'Disabled \\[Default]', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'example' => '2', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'MemorySize', + 'name' => 'PrinterRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The memory size of the cloud computer instance type. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The printer redirection policy. This parameter takes effect only if DeviceRedirects does not include a printer redirection policy.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection \\[Default]', 'usbRedirect' => 'USB redirection', 'off' => 'Disabled'], + 'type' => 'string', 'required' => false, - 'example' => '4', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'GpuCount', + 'name' => 'VisualQuality', 'in' => 'query', 'schema' => [ - 'description' => 'The number of GPUs contained in the cloud computer instance type.'."\n", - 'type' => 'number', - 'format' => 'float', + 'description' => 'The image display quality policy.', + 'enumValueTitles' => ['high' => 'High definition', 'low' => 'Smooth', 'lossless' => 'Lossless', 'medium' => 'Automatic rotation \\[Default]'], + 'type' => 'string', 'required' => false, - 'example' => '1', + 'docRequired' => false, + 'example' => 'low', + 'title' => '', ], ], [ - 'name' => 'CheckStock', + 'name' => 'GpuAcceleration', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to query the inventory status of the cloud computer instance type.'."\n", - 'type' => 'boolean', + 'description' => 'Specifies whether to enable the image quality policy for graphics-intensive cloud computers. Enable this policy for scenarios such as professional design where high performance and user experience are required.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, 'docRequired' => false, - 'example' => 'true', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'FromDesktopGroup', + 'name' => 'Html5FileTransfer', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether the cloud computers in the template belong to a cloud computer pool.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', + 'description' => 'The file transfer policy for web clients.', + 'enumValueTitles' => ['all' => 'Allow upload and download', 'download' => 'Allow download', 'upload' => 'Allow upload', 'off' => 'Disabled \\[Default]'], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ProtocolType', + 'name' => 'Watermark', 'in' => 'query', 'schema' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP) (recommend)', + 'description' => 'Watermark.', + 'enumValueTitles' => ['blind' => 'Enable blind watermark', 'off' => 'Disable watermark \\[Default]', 'on' => 'Enable visible watermark'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'BundleId', + 'name' => 'Name', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer templates. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', - ], + 'description' => 'The policy name.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', - 'maxItems' => 100, + 'docRequired' => false, + 'example' => 'testPolicyGroupName', + 'title' => '', ], ], [ - 'name' => 'SupportMultiSession', + 'name' => 'WatermarkType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to return multi-session cloud computer templates. Default value: false.'."\n", - 'type' => 'boolean', + 'description' => 'The watermark type. You can select up to three types, separated by commas.'."\n" + ."\n" + .'> If you set this parameter to `custom`, you must also specify custom text using the `WatermarkCustomText` parameter.', + 'enumValueTitles' => ['EndUserId' => 'Username', 'Custom' => 'Custom text', 'DesktopIp' => 'Cloud computer IP address', 'ClientIp' => 'Client IP address', 'HostName' => 'Last 15 digits of the cloud computer ID', 'ClientTime' => 'Current time on the cloud computer'], + 'type' => 'string', 'required' => false, - 'example' => 'false', + 'example' => 'EndUserId', + 'title' => '', ], ], [ - 'name' => 'VolumeEncryptionEnabled', + 'name' => 'WatermarkCustomText', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable disk encryption.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'If you set `WatermarkType` to `custom`, you must also specify custom text using the `WatermarkCustomText` parameter.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'FotaChannel', + 'name' => 'WatermarkTransparencyValue', + 'in' => 'query', + 'schema' => ['description' => 'Watermark opacity. A higher value means lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkSecurity', 'in' => 'query', 'schema' => [ - 'description' => '> This parameter is not available for public use.'."\n", + 'description' => 'Blind watermark security priority rule.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'This parameter is now in invitational preview and unavailable.', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'SelectedBundle', + 'name' => 'CameraRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The desktop template that is selected based on specific criteria.', - 'type' => 'boolean', + 'description' => 'Local camera redirection. This parameter takes effect only if DeviceRedirects does not include a local camera redirection policy.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'off' => 'Disabled'], + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'SessionType', + 'name' => 'NetRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the session. Valide values:'."\n" + 'description' => 'Specifies whether to enable network redirection.'."\n" ."\n" - .'- SingleSession'."\n" - .'- MultipleSession', + .'> This feature is in invitational preview and not available to the public.', + 'enumValueTitles' => [' all' => 'Enables network redirection globally.', 'off' => 'Disabled \\[Default]', 'on' => 'Enable whitelist mode'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SingleSession' => '', - 'MultipleSession' => '', - ], - 'example' => 'SingleSession', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'AppContentProtection', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The image IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-7by8d2m4kiiczgd69', - ], + 'description' => 'Specifies whether to enable anti-screenshot protection.', + 'enumValueTitles' => ['off' => 'Disabled \\[Default]', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'OsType', + 'name' => 'RemoteCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'Keyboard and mouse control permissions for remote assistance.', + 'enumValueTitles' => ['optionalControl' => 'Disabled by default (can be enabled on request)', 'fullControl' => 'Full control', 'disableControl' => 'No control'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', + 'example' => 'fullControl', + 'title' => '', ], ], [ - 'name' => 'Scope', + 'name' => 'InternetCommunicationProtocol', 'in' => 'query', 'schema' => [ - 'description' => 'The scenario to use the image.', + 'description' => 'Network communication protocol.', + 'enumValueTitles' => ['tcp' => 'TCP mode applies when UDP/AST is restricted', 'rtc' => 'AST mode applies to high-frequency audio and video scenarios', 'auto' => 'UTO mode automatically switches between AST and UDP modes based on desktop content', 'both' => 'UDP mode applies to office and high-definition graphic design scenarios'], 'type' => 'string', 'required' => false, - 'example' => 'FastBuy', + 'example' => 'both', + 'title' => '', ], ], [ - 'name' => 'GpuDriverType', + 'name' => 'VideoRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'The GPU driver type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* T4'."\n" - .'* A10'."\n" - .'* G28'."\n" - .'* G39'."\n", + 'description' => 'Multimedia redirection.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'T4' => 'T4', - 'A10' => 'A10', - 'G28' => 'G28', - 'G39' => 'G39', - ], - 'example' => 'T4', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used for the next query. If this parameter is empty, all results have been returned.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BCC854D8-5D1E-46D3-96EF-797A5DD36789', - ], - 'Bundles' => [ - 'description' => 'The cloud computer templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'BundleType' => [ - 'description' => 'The type of the cloud computer template.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system template'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CUSTOM: custom template'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'CUSTOM' => '', - ], - 'example' => 'SYSTEM', - ], - 'OsType' => [ - 'description' => 'The type of the OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], - 'StockState' => [ - 'description' => 'The inventory status of the cloud computer instance type. This parameter is returned only if you set the `CheckStock` parameter to `true`.'."\n", - 'type' => 'string', - 'example' => 'Sufficient', - ], - 'DesktopType' => [ - 'description' => 'The instance type of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ecd.graphics.2xlarge', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: HDX protocol'."\n" - .'* ASP: in-house ASP', - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'BundleId' => [ - 'description' => 'The ID of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019', - ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'desktopimage-windows-server-2019-64-ch-vgpu', - ], - 'ImageName' => [ - 'description' => 'The image name.'."\n", - 'type' => 'string', - 'example' => 'Windows server 2019 Chinese', - ], - 'Language' => [ - 'description' => 'The OS language of the image.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: English'."\n" - .'* zh-HK: Chinese, Traditional (Hong Kong, China)'."\n" - .'* zh-CN: Simplified Chinese'."\n" - .'* ja-JP: Japanese'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'en-US', - ], - 'BundleName' => [ - 'description' => 'The name of the cloud computer template.'."\n", - 'type' => 'string', - 'example' => 'Advanced graphics with Windows 2019', - ], - 'Disks' => [ - 'description' => 'Details of the disks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DiskType' => [ - 'description' => 'The type of the disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DATA: data disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'DiskSize' => [ - 'description' => 'The size of the disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'DiskPerformanceLevel' => [ - 'description' => 'The PL of the disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PL1'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL0'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL3'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* PL2'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PL1' => 'PL1', - 'PL0' => 'PL0', - 'PL3' => 'PL3', - 'PL2' => 'PL2', - ], - 'example' => 'PL0', - ], - ], - ], - ], - 'DesktopTypeAttribute' => [ - 'description' => 'The details of the cloud computer instance type.'."\n", - 'type' => 'object', - 'properties' => [ - 'CpuCount' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'GpuCount' => [ - 'description' => 'The number of GPUs.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'GpuSpec' => [ - 'description' => 'The GPU type.'."\n", - 'type' => 'string', - 'example' => 'NVIDIA T4', - ], - 'MemorySize' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '47104', - ], - ], - ], - 'DesktopTypeFamily' => [ - 'description' => 'The instance family of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* eds.graphics: graphical instance family'."\n" - .'* eds.hf: instance family with a high clock speed'."\n" - .'* eds.general: general-purpose instance family', - 'type' => 'string', - 'enumValueTitles' => [ - 'eds.graphics' => '', - 'eds.hf' => '', - 'eds.general' => '', - ], - 'example' => 'eds.general', - ], - 'CreationTime' => [ - 'description' => 'The time when the cloud computer template was created.'."\n", - 'type' => 'string', - 'example' => '2021-09-30T06:09Z', - ], - 'SessionType' => [ - 'description' => 'The session type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: single-session'."\n" - .'* 1: multi-session', - 'type' => 'string', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled.'."\n", - 'type' => 'string', - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], - 'Platform' => [ - 'description' => 'The OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Ubuntu'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows Server 2022'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* UOS'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CentOS'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows Server 2019'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows Server 2016'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Ubuntu' => 'Ubuntu', - 'Windows Server 2022' => 'Windows Server 2022', - 'UOS' => 'UOS', - 'CentOS' => 'CentOS', - 'Windows Server 2019' => 'Windows Server 2019', - 'Windows Server 2016' => 'Windows Server 2016', - ], - 'example' => 'Windows Server 2019', - ], - 'ImageStatus' => [ - 'description' => 'The status of the image.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'SystemDiskCategory' => [ - 'description' => 'The category of the system disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: the ultra disk'."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the Enterprise SSD (ESSD). Take note that only specific cloud computer types support ESSDs.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_auto' => '', - 'cloud_essd' => '', - ], - 'example' => 'cloud_efficiency', - ], - 'DataDiskCategory' => [ - 'description' => 'The category of the data disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* cloud_efficiency: the ultra disk'."\n" - .'* cloud_auto: the standard SSD.'."\n" - .'* cloud_essd: the ESSD. Take note that only specific cloud computer types support ESSDs.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'cloud_efficiency' => '', - 'cloud_auto' => '', - 'cloud_essd' => '', - ], - 'example' => 'cloud_efficiency', - ], - ], - ], - ], - ], + 'example' => 'on', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8\\",\\n \\"RequestId\\": \\"BCC854D8-5D1E-46D3-96EF-797A5DD36789\\",\\n \\"Bundles\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"BundleType\\": \\"SYSTEM\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"StockState\\": \\"Sufficient\\",\\n \\"DesktopType\\": \\"ecd.graphics.2xlarge\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BundleId\\": \\"bundle_ecd_graphics.2xlarge_s15d15_win2019\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-vgpu\\",\\n \\"ImageName\\": \\"Windows server 2019 Chinese\\",\\n \\"Language\\": \\"en-US\\",\\n \\"BundleName\\": \\"Advanced graphics with Windows 2019\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 150,\\n \\"DiskPerformanceLevel\\": \\"PL0\\"\\n }\\n ],\\n \\"DesktopTypeAttribute\\": {\\n \\"CpuCount\\": 10,\\n \\"GpuCount\\": 0.5,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"MemorySize\\": 4096\\n },\\n \\"DesktopTypeFamily\\": \\"eds.general\\",\\n \\"CreationTime\\": \\"2021-09-30T06:09Z\\",\\n \\"SessionType\\": \\"0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"Platform\\": \\"Windows Server 2019\\",\\n \\"ImageStatus\\": \\"Available\\",\\n \\"SystemDiskCategory\\": \\"cloud_efficiency\\",\\n \\"DataDiskCategory\\": \\"cloud_efficiency\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8\\n BCC854D8-5D1E-46D3-96EF-797A5DD36789\\n \\n test\\n SYSTEM\\n Windows\\n Sufficient\\n ecd.graphics.2xlarge\\n HDX\\n bundle_ecd_graphics.2xlarge_s15d15_win2019\\n desktopimage-windows-server-2019-64-ch-vgpu\\n Windows server 2019 Chinese\\n en-US\\n Advanced graphics with Windows 2019\\n \\n SYSTEM\\n 150\\n PL0\\n \\n \\n 10\\n 0.5\\n NVIDIA T4\\n 47104\\n \\n eds.general\\n 2021-09-30T06:09Z\\n \\n","errorExample":""}]', - 'title' => 'DescribeBundles', - 'summary' => 'Queries the details of cloud computer templates.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyBundle' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'WatermarkColor', + 'in' => 'query', + 'schema' => ['description' => 'Watermark font color. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'WatermarkDegree', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Watermark tilt angle. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10', 'title' => ''], ], [ - 'name' => 'BundleId', + 'name' => 'WatermarkFontSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer template that you want to modify.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b-2g65ljy4291vl****', - ], + 'schema' => ['description' => 'Watermark font size. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ImageId', + 'name' => 'WatermarkFontStyle', 'in' => 'query', 'schema' => [ - 'description' => 'The new image ID. The new image must meet the following conditions:'."\n" - ."\n" - .'* The new image must be in the Available state.'."\n" - .'* The operating system of the new image must be the same as that of the original image.'."\n" - .'* The required disk size for the new image cannot be greater than that for the original image.'."\n" - .'* The GPU type of the new image must be the same as that of the original image.'."\n", + 'description' => 'Watermark font style.', + 'enumValueTitles' => ['plain' => 'Plain', 'bold' => 'Bold'], 'type' => 'string', 'required' => false, - 'example' => 'm-aea3oaww001np****', + 'example' => 'plain', + 'title' => '', ], ], [ - 'name' => 'BundleName', + 'name' => 'WatermarkRowAmount', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the new cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'newName', - ], + 'schema' => ['description' => 'Number of watermark rows. Valid values: 3 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'CpuProtectedMode', 'in' => 'query', 'schema' => [ - 'description' => 'The description of the new cloud computer template.'."\n", + 'description' => 'CPU protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'newDescription', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'Language', + 'name' => 'CpuRateLimit', 'in' => 'query', - 'schema' => [ - 'description' => 'The OS language. This parameter is available only for system images.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: American English'."\n" - .'* zh-HK: Traditional Chinese (Hong Kong)'."\n" - .'* zh-CN: Simplified Chinese.'."\n" - ."\n" - .'* ja-JP: Japanese', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'zh-CN', - ], + 'schema' => ['description' => 'Overall CPU usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], + [ + 'name' => 'CpuSampleDuration', + 'in' => 'query', + 'schema' => ['description' => 'Overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n4636DBE0-BBB4-4076-8B8E-94D21A9A****\\r\\n","errorExample":""}]', - 'title' => 'ModifyBundle', - 'summary' => 'Modifies a custom cloud computer template.', - 'description' => 'Only custom desktop templates can be modified.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteBundles' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CpuSingleRateLimit', + 'in' => 'query', + 'schema' => ['description' => 'Single-core CPU usage percentage. Valid values: 70 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'CpuDownGradeDuration', + 'in' => 'query', + 'schema' => ['description' => 'CPU downclocking duration. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + ], + [ + 'name' => 'MemoryProtectedMode', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Memory protection mode switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'BundleId', + 'name' => 'MemoryRateLimit', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer templates. You can specify 1 to 100 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b-cezrnfgecbich****', - ], - 'required' => true, - 'example' => 'b-cezrnfgecbich****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Overall memory usage percentage. Valid values: 70 to 90.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], + [ + 'name' => 'MemorySampleDuration', + 'in' => 'query', + 'schema' => ['description' => 'Overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A5CDCED9-54D4-457C-917D-3F2A783CDA1E\\r\\n","errorExample":""}]', - 'title' => 'DeleteBundles', - 'summary' => 'Deletes custom cloud computer templates.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateImage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'MemorySingleRateLimit', + 'in' => 'query', + 'schema' => ['description' => 'Memory usage per process percentage. Valid values: 30 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MemoryDownGradeDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Memory downclocking duration per process. Valid values: 30 to 120. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'EndUserApplyAdminCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", + 'description' => 'User requests administrator assistance.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'ecd-7w78ozhjcwa3u****', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageName', + 'name' => 'EndUserGroupCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", + 'description' => 'Users on the same office network share cloud computers.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'testImageName', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => 'The description of the custom image. The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.', + 'description' => 'The effective scope of the policy.', + 'enumValueTitles' => ['IP' => 'Applies to specific IP addresses', 'GLOBAL' => 'Applies globally'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'This is description.', + 'example' => 'GLOBAL', + 'title' => '', ], ], [ - 'name' => 'SnapshotId', + 'name' => 'Recording', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the snapshot.', + 'description' => 'Specifies whether to enable screen recording.', + 'enumValueTitles' => ['period' => 'Periodic screen recording', 'session' => 'Session-based screen recording', 'off' => 'Disabled', 'alltime' => 'Continuous screen recording'], 'type' => 'string', 'required' => false, - 'example' => 's-2zefuwk8l6ytcgd3bf4o', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageResourceType', + 'name' => 'RecordingAudio', 'in' => 'query', 'schema' => [ - 'description' => 'This parameter is not publicly available.'."\n", + 'description' => 'Cloud computer audio recording option.', + 'enumValueTitles' => ['off' => 'Record video only', 'on' => 'Record system and peripheral audio'], 'type' => 'string', 'required' => false, - 'example' => 'To be hidden.', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'SnapshotIds', + 'name' => 'RecordingStartTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the snapshots.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the snapshot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[\\"s-2ze2ai7op1duq4mnx5ha\\"]', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Screen recording start time in HH:MM:SS format. This parameter is meaningful only when `Recording` is set to `PERIOD`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], ], [ - 'name' => 'AutoCleanUserdata', + 'name' => 'RecordingEndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to clear private data of users. If you set AutoCleanUserdata to `true`, the custom image clears the data directories, excluding the `Administrator` and `Public` directories, in the `C:\\Users` directory.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'Screen recording end time in HH:MM:SS format. This parameter is meaningful only when `Recording` is set to `PERIOD`.', 'type' => 'string', 'required' => false, 'example' => '08:59:00', 'title' => ''], ], [ - 'name' => 'DiskType', + 'name' => 'RecordingFps', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording frame rate. Unit: FPS.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'RecordingDuration', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording file viewing duration in minutes. Recording files are automatically split based on the specified duration and uploaded to the storage bucket. When a file reaches 300 MB, it is prioritized for rolling updates. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'RecordingExpires', + 'in' => 'query', + 'schema' => ['description' => 'Retention period of screen recording files. Valid values: 1 to 180 days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'RecordingUserNotify', 'in' => 'query', 'schema' => [ - 'description' => 'The disk data that is contained in the custom image.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- SYSTEM: only contain data from system disks.'."\n" - .'- ALL: contain data from system disks and user disks. [default]', + 'description' => 'Notify end users when screen recording is enabled.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'ALL' => '', - ], - 'example' => 'ALL', + 'example' => 'off'."\n", + 'title' => '', ], ], [ - 'name' => 'DataSnapshotIds', + 'name' => 'RecordingUserNotifyMessage', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ImageId' => [ - 'description' => 'The ID of the image.', - 'type' => 'string', - 'example' => 'm-gx2x1dhsmusr2****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F5F82BA8-92FE-49E4-AEB9-9010CE7329F3\\n m-gx2x1dhsmusr2****\\n","errorExample":""}]', - 'title' => 'CreateImage', - 'summary' => 'Creates a custom image based on a deployed cloud computer. Then, you can use the custom image to create cloud computers that have the same configurations. This prevents the repeated settings when you create cloud computers.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CopyImage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => 'Message to notify end users when screen recording is enabled.', 'type' => 'string', 'example' => 'Screen recording is enabled.', 'required' => false, 'title' => ''], ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AdminAccess', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Specifies whether users have administrator permissions after logging on to cloud computers.'."\n" + ."\n" + .'> This feature is in invitational preview and not available to the public.', + 'enumValueTitles' => ['allow' => 'Force allow', 'deny' => 'Force deny', 'inherited' => 'Inherit administrator permission control from user dimension'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'deny', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'EnableSessionRateLimiting', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the image that is copied to the destination region.'."\n", + 'description' => 'Session bandwidth throttling.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'm-gx2x1dhsmusr2****', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DestinationImageName', + 'name' => 'SessionMaxRateKbps', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the new image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Office_Shanghai', - ], + 'schema' => ['description' => 'Maximum session bandwidth throttling value. Unit: Kbps. Valid values: 2000 to 100000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], [ - 'name' => 'DestinationDescription', + 'name' => 'DisplayMode', 'in' => 'query', 'schema' => [ - 'description' => 'The description of the new image in the destination region. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", + 'description' => 'Display mode.', + 'enumValueTitles' => ['clientCustom' => 'User self-configuration', 'adminOffice' => 'Daily office scenario', 'adminDesign' => 'Design and 3D applications', 'adminCustom' => 'Custom'], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'This is a test.', - ], - ], - [ - 'name' => 'DestinationRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the destination region. The ID must be different from the current region ID of the image. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ImageId' => [ - 'description' => 'The ID of the image that is being copied.'."\n", - 'type' => 'string', - 'example' => 'm-2g65ljy3ynrdq****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '28A40F12-F340-442B-A35F-46EF6A03****', - ], - ], + 'example' => 'clientCustom', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-2g65ljy3ynrdq****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03****\\"\\n}","type":"json"}]', - 'title' => 'CopyImage', - 'summary' => 'Copy an image to another region. If you want to share an image across regions, you can call this operation to copy the image to the destination region and then share the image.', - ], - 'UploadImage' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'create', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'StreamingMode', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Streaming mode adaptation scenario.', + 'enumValueTitles' => ['intelligent' => 'Intelligent mode', 'smooth' => 'Smoothness priority'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'smooth', + 'title' => '', ], ], [ - 'name' => 'OssObjectPath', + 'name' => 'ColorEnhancement', 'in' => 'query', 'schema' => [ - 'description' => 'The object path of the image file in Object Storage Service (OSS).'."\n", + 'description' => 'Specifies whether to enable color enhancement for design and 3D applications.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'https://ossbucket:endpoint/object', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageName', + 'name' => 'SmoothEnhancement', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", + 'description' => 'Specifies whether to enable smoothness enhancement for daily office scenarios.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Win10_Test', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'QualityEnhancement', 'in' => 'query', 'schema' => [ - 'description' => 'The description of the image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", + 'description' => 'Specifies whether to enable image quality enhancement for design and 3D applications.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'test description', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'OsType', + 'name' => 'VideoEncPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the operating system.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'Video encoding policy.', + 'enumValueTitles' => ['qualityFirst' => 'Quality priority', 'bandwidthFirst' => 'Bandwidth priority'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', + 'example' => 'qualityFirst', + 'title' => '', ], ], [ - 'name' => 'GpuCategory', + 'name' => 'TargetFps', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the image is a GPU-accelerated image.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'Target frame rate. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'ProtocolType', + 'name' => 'VideoEncMinQP', 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP)', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'ASP' => '', - ], - 'example' => 'ASP', - ], + 'schema' => ['description' => 'Minimum QP for video encoding, representing highest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'DataDiskSize', + 'name' => 'VideoEncMaxQP', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the data disk. Valid values: 80 to 500. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '5', - 'example' => '80', - ], + 'schema' => ['description' => 'Maximum QP for video encoding, representing lowest quality. Valid values: 0 to 51.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], [ - 'name' => 'GpuDriverType', + 'name' => 'VideoEncAvgKbps', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the pre-installed GPU driver.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* gpu_grid9: This GPU driver is used on cloud computers of the following two specifications: graphics – 4 vCPUs, 23 GiB memory, 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, 8 GiB GPU memory.'."\n" - .'* gpu_custom: You can install the driver later.'."\n" - .'* gpu_grid12: This GPU driver is used on graphical cloud computers of specifications other than the following two specifications: graphics – 4 vCPUs, 23 GiB memory, & 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, & 8 GiB GPU memory.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'gpu_grid9' => '', - 'gpu_custom' => '', - 'gpu_grid12' => '', - ], - 'example' => 'gpu_grid9', - ], + 'schema' => ['description' => 'Average bitrate for video encoding. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], [ - 'name' => 'LicenseType', + 'name' => 'VideoEncPeakKbps', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the license that is used to activate the operating system after the image is imported. Valid values:'."\n" - ."\n" - .'* Auto: Elastic Desktop Service detects the operating system of the image and allocates a license to the operating system. In this mode, the system first checks whether a license allocated by an official Alibaba Cloud channel is specified in the `Platform`. If a license allocated by an official Alibaba Cloud channel is specified, the system allocates the license to the imported image. If no such license is specified, the BYOL (Bring Your Own License) mode is used.'."\n" - .'* Aliyun: The license that is allocated by an official Alibaba Cloud channel and is specified by `Platform` is used for the operating system distribution.'."\n" - .'* BYOL: The license that comes with the source operating system is used. When you use the BYOL mode, make sure that your license key is supported by Alibaba Cloud.'."\n" - ."\n" - .'Default value: Auto.'."\n" - ."\n" - .'> Windows 10 cannot be activated by Alibaba Cloud. Set the `LicenseType` to BYOL for Windows 10.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Auto' => '', - 'Aliyun' => '', - 'BYOL' => '', - ], - 'example' => 'Auto', - ], + 'schema' => ['description' => 'Peak bitrate for video encoding. Unit: Kbps. Valid values: 1000 to 50000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000', 'title' => ''], ], [ - 'name' => 'EnableSecurityCheck', + 'name' => 'MaxReconnectTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable security check.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Maximum reconnection retry time after an unexpected disconnection. Valid values: 30 to 7200. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], ], [ - 'name' => 'SystemDiskSize', + 'name' => 'WyAssistant', 'in' => 'query', 'schema' => [ - 'description' => 'The size of the system disk. Unit: GiB.'."\n" + 'description' => 'Specifies whether to provide the Wuying AI Assistant entry in the cloud computer floating ball when connecting via desktop clients (including Windows and macOS clients).'."\n" ."\n" - .'> The system disk must be at least as large as the image.'."\n", + .'> This feature applies only to desktop clients of version 7.7 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => '80', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'ImageId' => [ - 'description' => 'The ID of the custom image.'."\n", - 'type' => 'string', - 'example' => 'm-d4dwr5tgrgvd****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****', - ], - ], + 'example' => 'on', + 'title' => '', ], ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-d4dwr5tgrgvd****\\",\\n \\"RequestId\\": \\"2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****\\"\\n}","type":"json"}]', - 'title' => 'UploadImage', - 'summary' => 'Uploads your custom Windows image.', - 'description' => '> You can upload only Windows images.'."\n", - ], - 'DescribeImages' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'WatermarkAntiCam', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Blind watermark anti-photo feature.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '10', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'WatermarkPower', 'in' => 'query', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If you do not specify this parameter, all results are returned.'."\n", + 'description' => 'Blind watermark enhancement feature.', + 'enumValueTitles' => ['high' => 'High', 'low' => 'Low', 'medium' => 'Medium'], 'type' => 'string', 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + 'example' => 'medium', + 'title' => '', ], ], [ - 'name' => 'ImageType', + 'name' => 'CpuProcessors', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the image.'."\n", - 'type' => 'string', + 'description' => 'The name of the process.', + 'type' => 'array', + 'items' => ['description' => 'Process name.', 'type' => 'string', 'required' => false, 'example' => 'chrome.exe', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'CUSTOM' => '', - ], - 'example' => 'SYSTEM', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageStatus', + 'name' => 'MemoryProcessors', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The state of the image.'."\n", - 'type' => 'string', + 'description' => 'The name of the process.', + 'type' => 'array', + 'items' => ['description' => 'Process name.', 'type' => 'string', 'required' => false, 'example' => 'notepad.exe', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'Creating' => '', - 'Available' => '', - 'CreateFailed' => '', - ], - 'example' => 'Available', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GpuCategory', + 'name' => 'DomainResolveRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether the images are GPU-accelerated images.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'description' => 'Domain name resolution policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'Domain name resolution policy.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'Domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com', 'title' => ''], + 'Policy' => [ + 'description' => 'Resolution policy.', + 'enumValueTitles' => ['allow' => 'Allow', 'block' => 'Deny'], + 'type' => 'string', + 'required' => false, + 'example' => 'allow', + 'title' => '', + ], + 'Description' => ['description' => 'Policy description.', 'type' => 'string', 'example' => 'Policy description.', 'required' => false, 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'false', + 'required' => false, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProtocolType', + 'name' => 'NetRedirectRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'Network redirection policy details.'."\n" ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', + .'> This feature is in invitational preview and not available to the public.', + 'type' => 'array', + 'items' => [ + 'description' => 'Network redirection policy details.'."\n" + ."\n" + .'> This feature is in invitational preview and not available to the public.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'Domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com'."\n", 'title' => ''], + 'RuleType' => [ + 'description' => 'Rule type.', + 'enumValueTitles' => ['prc' => 'Process', 'domain' => 'Domain name'], + 'type' => 'string', + 'required' => false, + 'example' => 'domain', + 'title' => '', + ], + 'Policy' => ['description' => 'Redirection policy.', 'type' => 'string', 'required' => false, 'example' => 'Allow', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'ASP', + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'LanguageType', + 'name' => 'ScopeValue', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The language of the OS.'."\n", - 'type' => 'string', + 'description' => 'Specify when `Scope` is set to `IP`. Takes effect only when `Scope` is `IP`.', + 'type' => 'array', + 'items' => ['description' => 'Effective CIDR block range.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'en-US', + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DesktopInstanceType', + 'name' => 'ClientType', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The instance type of the cloud computer. You can call the [DescribeDesktopTypes](~~436816~~) operation to obtain the parameter value.'."\n", - 'type' => 'string', + 'description' => 'List of client login control rules. Controls which clients can access cloud computers.', + 'type' => 'array', + 'items' => [ + 'description' => 'Client login control rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Client login control. Specifies whether to allow using a specific client type to log on to cloud computers.'."\n" + ."\n" + .'> If you don\'t configure `ClientType` parameters, all client types are allowed by default.', + 'enumValueTitles' => ['off' => 'Not allowed', 'on' => 'Allowed'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + 'ClientType' => [ + 'description' => 'Client login control. Specifies the client type.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'ios' => 'iOS client', 'windows' => 'Windows client', 'macos' => 'macOS client'], + 'type' => 'string', + 'required' => false, + 'example' => 'android', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'ecd.graphics.xlarge', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'UsbSupplyRedirectRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the images. You can specify one or more image IDs.'."\n", + 'description' => 'USB redirection rules.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', + 'description' => 'USB redirection rule.', + 'type' => 'object', + 'properties' => [ + 'VendorId' => ['description' => 'Vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '04**', 'title' => ''], + 'UsbRuleType' => [ + 'description' => 'USB redirection rule type.', + 'enumValueTitles' => [1 => 'Device vendor'], + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'Description' => ['description' => 'Rule description.', 'type' => 'string', 'example' => 'Test rule', 'required' => false, 'title' => ''], + 'UsbRedirectType' => [ + 'description' => 'USB redirection type.', + 'enumValueTitles' => [1 => 'Allow', 'Deny'], + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'ProductId' => ['description' => 'Product ID.', 'type' => 'string', 'required' => false, 'example' => '08**', 'title' => ''], + ], 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', + 'title' => '', + 'example' => '', ], 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OsType', + 'name' => 'AuthorizeSecurityPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The type of the operating system of the images. Default value: `null`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', + 'description' => 'List of new security group control rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'Security group control rule list.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Rule direction for the security group control rule.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], + 'type' => 'string', + 'required' => false, + 'example' => 'inflow', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'Authorization policy for the security group control rule.', + 'enumValueTitles' => ['drop' => 'Deny policy. Denies all access requests. No denial message is returned. Requests either time out or fail to establish a connection.', 'accept' => 'Allow policy. Accepts all access requests. \\[Default]'], + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + 'title' => '', + ], + 'PortRange' => ['description' => 'Port range for the security group control rule. The port range depends on the protocol (IpProtocol):'."\n" + ."\n" + .'- For TCP or UDP protocols: Port range is 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.'."\n" + ."\n" + .'- For ICMP protocol: Set to -1/-1.'."\n" + ."\n" + .'- For GRE protocol: Set to -1/-1.'."\n" + ."\n" + .'- When IpProtocol is set to all: Set to -1/-1.'."\n" + ."\n" + .'For more information about common ports for typical applications, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'Description of the security group control rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'Protocol type for the security group control rule.', + 'enumValueTitles' => ['TCP' => 'TCP protocol', 'UDP' => 'UDP protocol', 'ALL' => 'Supports all protocols', 'GRE' => 'GRE protocol', 'ICMP' => 'ICMP (IPv4) protocol'], + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + 'title' => '', + ], + 'Priority' => ['description' => 'Priority of the security group control rule. A smaller number indicates a higher priority. Valid values: 1 to 60. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'Target of the security group control rule. Specify an IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'Windows', + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'GpuDriverVersion', + 'name' => 'RevokeSecurityPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The version of the GPU driver.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '417.22', + 'description' => 'List of security group control rules to delete.', + 'type' => 'array', + 'items' => [ + 'description' => 'Security group control rule to delete.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Rule direction for the security group control rule to delete.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], + 'type' => 'string', + 'required' => false, + 'example' => 'outflow', + 'title' => '', + ], + 'Policy' => [ + 'description' => 'Authorization policy for the security group control rule to delete.', + 'enumValueTitles' => ['drop' => 'Deny policy. Denies all access requests. No denial message is returned. Requests either time out or fail to establish a connection.', 'accept' => 'Allow policy. Accepts all access requests. \\[Default]'], + 'type' => 'string', + 'required' => false, + 'example' => 'accept', + 'title' => '', + ], + 'PortRange' => ['description' => 'Port range for the security group control rule to delete. The port range depends on the protocol (IpProtocol):'."\n" + ."\n" + .'- For TCP or UDP protocols: Port range is 1 to 65535. Separate the start and end ports with a forward slash (/). Example: 1/200.'."\n" + ."\n" + .'- For ICMP protocol: Set to -1/-1.'."\n" + ."\n" + .'- For GRE protocol: Set to -1/-1.'."\n" + ."\n" + .'- When IpProtocol is set to all: Set to -1/-1.'."\n" + ."\n" + .'For more information about common ports for typical applications, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'Description of the security group control rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'Protocol type for the security group control rule to delete.', + 'enumValueTitles' => ['TCP' => 'TCP protocol', 'UDP' => 'UDP protocol', 'ALL' => 'Supports all protocols', 'GRE' => 'GRE protocol', 'ICMP' => 'ICMP (IPv4) protocol'], + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + 'title' => '', + ], + 'Priority' => ['description' => 'Priority of the security group control rule to delete. A smaller number indicates a higher priority. Valid values: 1 to 60. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'Target of the security group control rule to delete. Specify an IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SessionType', + 'name' => 'AuthorizeAccessPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The session type.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '', - 'MULTIPLE_SESSION' => '', + 'description' => 'List of new client IP address whitelists.', + 'type' => 'array', + 'items' => [ + 'description' => 'Client IP address whitelist.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Description of the client IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'Client access IP address range. Specify an IPv4 CIDr block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'SINGLE_SESSION', + 'required' => false, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FotaVersion', + 'name' => 'RevokeAccessPolicyRule', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The image version.'."\n", - 'type' => 'string', + 'description' => 'The list of client IP address whitelists to delete.', + 'type' => 'array', + 'items' => [ + 'description' => 'Client IP address whitelist to delete.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'Description of the client IP address whitelist to delete.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'Client access IP address range to delete. Specify an IPv4 CIDR block.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '0.0.3-R-20220616.133609', + 'maxItems' => 400, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageName', + 'name' => 'DeviceRedirects', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The image name.'."\n", - 'type' => 'string', + 'description' => 'Device redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of device redirect rules.', + 'type' => 'object', + 'properties' => [ + 'RedirectType' => [ + 'description' => 'Redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Disabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'deviceRedirect', + 'title' => '', + ], + 'DeviceType' => [ + 'description' => 'Peripheral type.', + 'enumValueTitles' => ['printer' => 'Printer', 'scanner' => 'Scanner', 'serialport' => 'Serial port device', 'camera' => 'Camera', 'adb' => 'ADB'], + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Win_01', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DeviceRules', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is empty, all results are returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB', - ], - 'Images' => [ - 'description' => 'The details of the images.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the image.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the image was created.'."\n", - 'type' => 'string', - 'example' => '2018-01-10T01:01:10Z', - ], - 'Status' => [ - 'description' => 'The status of the image.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Creating'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Available'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CreateFailed'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Creating' => '', - 'Available' => '', - 'CreateFailed' => '', - ], - 'example' => 'Available', - ], - 'Progress' => [ - 'description' => 'The creation progress of the image. Unit: %.'."\n", - 'type' => 'string', - 'example' => '100%', - ], - 'DataDiskSize' => [ - 'description' => 'The size of the data disk. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'ImageType' => [ - 'description' => 'The type of the image.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CUSTOM'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'CUSTOM' => '', - ], - 'example' => 'SYSTEM', - ], - 'Description' => [ - 'description' => 'The description of the image.'."\n", - 'type' => 'string', - 'example' => 'This is description.', - ], - 'Size' => [ - 'description' => 'The size of the image. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '40', - ], - 'OsType' => [ - 'description' => 'The type of the operating system.'."\n", - 'type' => 'string', - 'example' => 'WINDOWS', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP) (recommended)', - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'Name' => [ - 'description' => 'The name of the image.'."\n", - 'type' => 'string', - 'example' => 'testImageName', - ], - 'ImageId' => [ - 'description' => 'The ID of the image.'."\n", - 'type' => 'string', - 'example' => 'm-gx2x1dhsmusr2****', - ], - 'GpuCategory' => [ - 'description' => 'Indicates whether the image is a GPU-accelerated image.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'SupportedLanguages' => [ - 'description' => 'The languages of the operating system.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The languages of the operating system. One or more languages are supported.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en-US: American English.'."\n" - .'* zh-HK: traditional Chinese (Hong Kong, China)'."\n" - .'* zh-CN: simple Chinese'."\n" - .'* ja-JP: Japanese', - 'type' => 'string', - 'enumValueTitles' => [ - 'en-US' => '', - 'zh-HK' => '', - 'zh-CN' => '', - 'ja-JP' => '', - ], - 'example' => 'en-US', - ], - ], - 'GpuDriverVersion' => [ - 'description' => 'The version number of the GPU driver.'."\n", - 'type' => 'string', - 'example' => '417.22', - ], - 'AppVersion' => [ - 'description' => 'The version of the image.'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to query the list of KMS keys.'."\n", - 'type' => 'string', - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], - 'SharedCount' => [ - 'description' => 'The number of shared images.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SessionType' => [ - 'description' => 'The type of the image session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SINGLE_SESSION: single-session image.'."\n" - ."\n" - .'* MULTIPLE_SESSION: multi-session image.', - 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '', - 'MULTIPLE_SESSION' => '', - ], - 'example' => 'MULTIPLE_SESSION', - ], - 'UpdateTime' => [ - 'description' => 'The time when the image was last modified.'."\n", - 'type' => 'string', - 'example' => '2021-12-22T02:48:43Z', - ], - 'Platform' => [ - 'description' => 'The operating system type of the image.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Ubuntu'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows Server 2022'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* UOS'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CentOS'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows Server 2019'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* SQL Server 2016'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Windows 10'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Ubuntu' => 'Ubuntu', - 'Windows Server 2022' => 'Windows Server 2022', - 'UOS' => 'UOS', - 'CentOS' => 'CentOS', - 'Windows Server 2019' => 'Windows Server 2019', - 'Windows Server 2016' => 'Windows Server 2016', - 'Windows 10' => 'Windows 10', - ], - 'example' => 'Windows Server 2019', - ], - ], + 'description' => 'Custom peripheral rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of custom peripheral rules.', + 'type' => 'object', + 'properties' => [ + 'DeviceName' => ['description' => 'Device name.', 'type' => 'string', 'required' => false, 'example' => 'sandisk', 'title' => ''], + 'RedirectType' => [ + 'description' => 'Redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Prohibited'], + 'type' => 'string', + 'required' => false, + 'example' => 'usbRedirect', + 'title' => '', + ], + 'DeviceType' => [ + 'description' => 'Peripheral type.', + 'enumValueTitles' => ['usbKey' => 'UKey', 'other' => 'Other', 'graphicsTablet' => 'Graphics tablet', 'cardReader' => 'Card reader', 'printer' => 'Printer', 'scanner' => 'Scanner', 'storage' => 'Storage device', 'camera' => 'Camera', 'networkInterfaceCard' => 'NIC device'], + 'type' => 'string', + 'required' => false, + 'example' => 'storage', + 'title' => '', ], + 'OptCommand' => ['description' => 'Link optimization command.', 'type' => 'string', 'required' => false, 'example' => '2:0', 'title' => ''], + 'DevicePid' => ['description' => 'Product ID.', 'type' => 'string', 'required' => false, 'example' => '0x55b1', 'title' => ''], + 'DeviceVid' => ['description' => 'Vendor ID. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '0x0781', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\",\\n \\"Images\\": [\\n {\\n \\"CreationTime\\": \\"2018-01-10T01:01:10Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"Progress\\": \\"100%\\",\\n \\"DataDiskSize\\": 150,\\n \\"ImageType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"This is description.\\",\\n \\"Size\\": 40,\\n \\"OsType\\": \\"WINDOWS\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"Name\\": \\"testImageName\\",\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"GpuCategory\\": false,\\n \\"SupportedLanguages\\": [\\n \\"en-US\\"\\n ],\\n \\"GpuDriverVersion\\": \\"417.22\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"SharedCount\\": 1,\\n \\"SessionType\\": \\"MULTIPLE_SESSION\\",\\n \\"UpdateTime\\": \\"2021-12-22T02:48:43Z\\",\\n \\"Platform\\": \\"Windows Server 2019\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\n \\n 2018-01-10T01:01:10Z\\n Available\\n 100%\\n 150\\n SYSTEM\\n This is description.\\n 40\\n WINDOWS\\n HDX\\n testImageName\\n m-gx2x1dhsmusr2****\\n false\\n en-US\\n \\n","errorExample":""}]', - 'title' => 'DescribeImages', - 'summary' => 'Queries the information about images.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeImageModifiedRecords' => [ - 'summary' => 'Queries the image modification records of cloud computers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'WatermarkColumnAmount', + 'in' => 'query', + 'schema' => ['description' => 'Number of watermark columns. Valid values: 3 to 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DomainResolveRuleType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Domain name resolution policy type.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'ClipboardScope', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ecd-bd53sfmysz8ir****', + 'enum' => ['global', 'grained'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MaxResults', + 'name' => 'ClipboardGraineds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'maxItems' => 4, + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'GrainedType' => [ + 'type' => 'string', + 'enum' => ['text', 'richtext', 'file', 'picture'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClipboardType' => [ + 'type' => 'string', + 'enum' => ['read', 'write', 'off', 'readwrite'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'InClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'InClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'OutClipboardSizeUnit' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'StatusMonitor', 'in' => 'query', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.'."\n", + 'description' => 'Specifies whether to provide the status monitoring entry in the cloud computer floating ball.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l3d+SWeOobbIlDLjwhjkTk', + 'example' => 'off', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'MobileRestart', + 'in' => 'query', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'If the NextToken parameter is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'DC40EE61-7E83-59ED-AEA6-7EE9C437F352', - ], - 'TotalCount' => [ - 'description' => 'The total number of image modification records.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'ImageModifiedRecords' => [ - 'description' => 'The image change records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The image change record.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the image modification.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The image is being modified.'."\n" - ."\n" - .'* 1: The image is successfully modified.'."\n" - ."\n" - .'* 2: The image fails to be modified.', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - '', - ], - 'example' => '1', - ], - 'UpdateTime' => [ - 'description' => 'The time when the image was last modified.'."\n", - 'type' => 'string', - 'example' => '2022-03-03T02:43:44.851Z', - ], - 'NewImageName' => [ - 'description' => 'The name of the new image after the image was modified.'."\n", - 'type' => 'string', - 'example' => 'xxxxImageID', - ], - 'ImageName' => [ - 'description' => 'The name of the original image.'."\n", - 'type' => 'string', - 'example' => 'win10-0307', - ], - 'NewImageId' => [ - 'description' => 'The ID of the new image after the image was modified.'."\n", - 'type' => 'string', - 'example' => 'xxxNewImageID', - ], - 'ImageId' => [ - 'description' => 'The ID of the original image.'."\n", - 'type' => 'string', - 'example' => 'm-8rnz2imrpcfuh****', - ], - 'Reason' => [ - 'type' => 'string', - ], - ], - ], - ], - ], + 'description' => 'Specifies whether to provide the Restart button in the cloud computer floating ball when connecting via mobile clients (Android and iOS clients).'."\n" + ."\n" + .'> This feature applies only to mobile clients of version 7.4 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821\\",\\n \\"RequestId\\": \\"DC40EE61-7E83-59ED-AEA6-7EE9C437F352\\",\\n \\"TotalCount\\": 20,\\n \\"ImageModifiedRecords\\": [\\n {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2022-03-03T02:43:44.851Z\\",\\n \\"NewImageName\\": \\"Windows server 2022 Mainland asp\\",\\n \\"ImageName\\": \\"Windows server 2019 Mainland\\",\\n \\"NewImageId\\": \\"desktopimage-windows-server-2022-64-ch-asp\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-asp\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeImageModifiedRecords', - ], - 'DescribeImagePermission' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MobileShutdown', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Specifies whether to provide the Shutdown button in the cloud computer floating ball when connecting via mobile clients (Android and iOS clients).'."\n" + ."\n" + .'> This feature applies only to mobile clients of version 7.4 or later.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'ResolutionModel', 'in' => 'query', 'schema' => [ - 'description' => 'The image ID.'."\n", + 'description' => 'Resolution type.', + 'enumValueTitles' => ['adaptive' => 'Adaptive resolution', 'customer' => 'Fixed resolution'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'm-4zfb6zj728hhr****', + 'required' => false, + 'example' => 'adaptive', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'AliUids' => [ - 'description' => 'The IDs of the Alibaba Cloud accounts with which the image is shared.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the recipient Alibaba Cloud accounts.'."\n", - 'type' => 'string', - 'example' => '176102063125****', - ], - ], - ], - ], + [ + 'name' => 'ResolutionWidth', + 'in' => 'query', + 'schema' => ['description' => 'Resolution width. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"AliUids\\": [\\n \\"176102063125****\\"\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeImagePermission', - 'summary' => 'Queries the recipient Alibaba Cloud accounts with which an image is shared.', - 'description' => 'You can call the [ModifyImagePermission](~~436982~~) operation to share an image with another cloud computer user or unshare an image. You can call the DescribeImagePermission operation to obtain the Alibaba Cloud accounts with which the current image is shared.'."\n", - ], - 'ModifyImageAttribute' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ResolutionHeight', + 'in' => 'query', + 'schema' => ['description' => 'Resolution height. Unit: pixels. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Taskbar', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Application taskbar.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'NoOperationDisconnect', 'in' => 'query', 'schema' => [ - 'description' => 'The image ID.'."\n", + 'description' => 'Disconnect on inactivity.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'm-2g65ljy3ynrdq****', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'Name', + 'name' => 'NoOperationDisconnectTime', + 'in' => 'query', + 'schema' => ['description' => 'Inactivity disconnect duration. Valid values: 120 to 7200. Unit: seconds.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'DisconnectKeepSession', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", + 'description' => 'Session retention after disconnection.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', + 'enumValueTitles' => ['customTime' => 'Fixed time', 'persistent' => 'Persistent'], 'type' => 'string', 'required' => false, - 'example' => 'testName', + 'example' => 'customTime', + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'DisconnectKeepSessionTime', + 'in' => 'query', + 'schema' => ['description' => 'Session retention duration after disconnection. Valid values: 30 to 7200. Unit: seconds.'."\n" + ."\n" + .'> This parameter applies only to cloud application policies.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], + ], + [ + 'name' => 'RecordEvents', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The description of the image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", - 'type' => 'string', + 'description' => 'List of screen recording events.', + 'type' => 'array', + 'items' => [ + 'description' => 'Screen recording event.', + 'enumValueTitles' => ['transferWithLocal' => 'Clipboard and file transfer operations', 'userInput' => 'User input', 'usbRedirect' => 'USB peripheral plug and unplug'], + 'type' => 'string', + 'required' => false, + 'example' => 'transferWithLocal', + 'title' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => 'testDescription', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'RecordEventFilePaths', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + 'description' => 'Absolute paths for file monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'Absolute path for file monitoring in screen recording audit.', 'type' => 'string', 'required' => false, 'example' => 'C://test.txt', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\r\\n","errorExample":""}]', - 'title' => 'ModifyImageAttribute', - 'summary' => 'Modifies the attributes of an image, including the name and description of the image.', - 'description' => 'You can call this operation to modify the attributes of only custom images that are in the Available state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ModifyImagePermission' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'RecordEventRegisters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Absolute paths for registry monitoring in screen recording audit.', + 'type' => 'array', + 'items' => ['description' => 'Absolute path for registry monitoring in screen recording audit.', 'type' => 'string', 'required' => false, 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', + ], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RecordEventDuration', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording duration after an event is detected in audit. Unit: minutes. Valid values: 10 to 60.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ResetDesktop', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'Reset cloud computer.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'DeviceConnectHint', 'in' => 'query', 'schema' => [ - 'description' => 'The IDs of the images.'."\n", + 'description' => 'Peripheral connection prompt control.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'm-gx2x1dhsmusr2****', + 'required' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'AddAccount', + 'name' => 'FileMigrate', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template. You can specify up to 20 account IDs.'."\n", + 'description' => 'File migration.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + ], + [ + 'name' => 'WuyingKeeper', + 'in' => 'query', + 'schema' => [ + 'description' => 'Wuying Keeper switch.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'off', + 'title' => '', + ], + ], + [ + 'name' => 'InternetPrinter', + 'in' => 'query', + 'schema' => ['description' => 'Wuying Keeper toggle for mobile devices', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + ], + [ + 'name' => 'SafeMenu', + 'in' => 'query', + 'schema' => ['description' => 'Security button toggle for Windows systems on mobile devices', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + ], + [ + 'name' => 'ScreenDisplayMode', + 'in' => 'query', + 'schema' => ['description' => 'Xiao Ying toggle for mobile devices', 'type' => 'string', 'required' => false, 'example' => 'off', 'title' => ''], + ], + [ + 'name' => 'ClientControlMenu', + 'in' => 'query', + 'schema' => ['description' => 'Event level for screen recording', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FileTransferSpeedLocation', + 'in' => 'query', + 'schema' => ['description' => 'Screen recording event suffix', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FileTransferSpeed', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FileTransferAddress', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CpdDriveClipboard', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UseTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AutoReconnect', + 'in' => 'query', + 'schema' => ['title' => 'Automatically reconnect after disconnection', 'description' => 'Automatically reconnect after disconnection', 'type' => 'string', 'example' => 'off', 'required' => false], + ], + [ + 'name' => 'MobileWuyingKeeper', + 'in' => 'query', + 'schema' => ['title' => 'Toggle for Wuying Keeper on mobile devices', 'description' => 'Wuying Keeper toggle for mobile devices', 'type' => 'string', 'example' => 'off', 'required' => false], + ], + [ + 'name' => 'MobileSafeMenu', + 'in' => 'query', + 'schema' => ['title' => 'The security button toggle for Windows systems on mobile devices', 'description' => 'The security button toggle for Windows systems on mobile devices', 'type' => 'string', 'example' => 'off', 'required' => false], + ], + [ + 'name' => 'MobileWyAssistant', + 'in' => 'query', + 'schema' => ['title' => 'Mobile Wy Assistant Toggle', 'description' => 'Mobile Wy Assistant Toggle', 'type' => 'string', 'example' => 'off', 'required' => false], + ], + [ + 'name' => 'RecordEventLevels', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'maxItems' => 20, + 'description' => 'Levels of screen recording events', + 'title' => 'Levels of screen recording events ', 'type' => 'array', 'items' => [ - 'description' => 'The ID of Alibaba Cloud account N with which you want to share the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EventType' => ['title' => 'Management event type', 'description' => 'Event type', 'type' => 'string', 'example' => 'StartApplication', 'required' => false], + 'EventLevel' => ['title' => 'Event level', 'description' => 'Event level', 'type' => 'string', 'example' => 'HIGH', 'required' => false], + ], 'required' => false, - 'example' => '118272523431****', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 50, + 'example' => '', ], ], [ - 'name' => 'RemoveAccount', + 'name' => 'RecordEventFileExts', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'flat', 'schema' => [ - 'description' => 'The ID of Alibaba Cloud account N from which you want to unshare the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.'."\n", + 'maxItems' => 6, + 'description' => 'File extensions for screen recording events', + 'title' => 'File extensions for screen recording events ', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of Alibaba Cloud account N from which you want to unshare the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '114984212876****', - ], + 'items' => ['type' => 'string', 'example' => 'txt', 'description' => '', 'required' => false, 'title' => ''], 'required' => false, - 'maxItems' => 50, + 'example' => '', ], ], + [ + 'name' => 'ExternalDrive', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'WatermarkShadow', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ClientCreateSnapshot', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AcademicProxy', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ModelLibrary', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PortProxy', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'BusinessChannel', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MemoryOverload', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CpuOverload', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DiskOverload', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ResolutionDpi', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '400', 'minimum' => '25', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'HoverConfigMsg', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MultiScreen', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AdminKeyboardOnWindows', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AdminKeyboardOnFullScreen', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5CED7F18-43B1-5035-BBB6-2538B***', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyImagePermission', - 'summary' => 'Shares an image with other Alibaba Cloud accounts, or unshares an image from the recipient Alibaba Cloud accounts.', - 'description' => '### [](#)Security of shared images'."\n" - ."\n" - .'Elastic Desktop Service cannot guarantee the integrity and security of shared images. When you use a shared image, you must make sure that the image comes from a trusted sharer or account, and you are legally responsible for using the shared image.'."\n" - ."\n" - .'### [](#)Quota and billing'."\n" - ."\n" - .'* A shared image does not count against the image quotas of principals to which the image is shared.'."\n" - .'* After a principal uses a shared image to create a cloud computer, the sharer is not charged for the shared image.'."\n" - .'* You are not charged for shared images.'."\n" - ."\n" - .'### [](#)Supported sharing behaviors'."\n" - ."\n" - .'* You can share custom images with other Alibaba Cloud accounts.'."\n" - .'* You can share custom images between accounts in the China site (aliyun.com) and the international site (alibabacloud.com).'."\n" - ."\n" - .'### [](#)Unsupported sharing behaviors'."\n" - ."\n" - .'* You cannot share images that are shared by other Alibaba Cloud accounts.'."\n" - .'* You cannot share encrypted images.'."\n" - .'* You cannot share images across regions. If you want to share an image across regions, you must copy the image to the destination region and then share the image. For more information, see [CopyImage](~~436978~~).', - ], - 'MigrateImageProtocol' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CED7F18-43B1-5035-BBB6-2538B***\\"\\n}","type":"json"}]', + 'title' => 'Modify a policy without Region specification ', + 'changeSet' => [ + ['createdAt' => '2025-12-10T02:25:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-23T13:39:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ModifyCloudDriveGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TargetProtocolType', + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****', 'title' => ''], + ], + [ + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'The protocol to which you want to update the image protocols. Set the value to ASP.'."\n", + 'description' => 'The status of the team space. Valid values:'."\n" + ."\n" + .'* enabled'."\n" + .'* disabled'."\n" + ."\n" + .'Default value: enabled.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, - 'enumValueTitles' => [ - 'ASP' => 'Adaptive Streaming Protocol', - ], - 'example' => 'ASP', + 'example' => 'disabled', + 'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '启用 [默认值]'], + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'TotalSize', + 'in' => 'query', + 'schema' => ['description' => 'The total capacity of the team space.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1073741824', 'title' => ''], + ], + [ + 'name' => 'GroupId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The image IDs.'."\n", + 'description' => 'The IDs of the teams.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-gqudcafrqcex9****', - ], - 'required' => true, - 'maxItems' => 500, + 'items' => ['description' => 'The ID of the team.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], ], @@ -34111,248 +31083,343 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D4E5AF5-DF28-5FE7-85C7-9F98315B****', - ], - 'FailedIds' => [ - 'description' => 'The IDs of the images whose protocols failed to be updated.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the image whose protocol failed to be updated.'."\n", - 'type' => 'string', - 'example' => '[\'m-5rsjelm66bs3j****\']', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Code' => ['description' => 'The returned results. A value of success indicates that the operation is successful. If the operation failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'example' => 'true', + 'enumValueTitles' => ['true' => '成功', 'false' => '失败'], + 'title' => '', ], + 'Data' => ['description' => 'The data information.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D4E5AF5-DF28-5FE7-85C7-9F98315B****\\",\\n \\"FailedIds\\": [\\n \\"[\'m-5rsjelm66bs3j****\']\\"\\n ]\\n}","type":"json"}]', - 'title' => 'MigrateImageProtocol', - 'summary' => 'Update the protocols of images to Adaptive Streaming Protocol (ASP).', - ], - 'DeleteImages' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ModifyCloudDriveGroups', + 'summary' => 'Modifies team spaces.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveGroups'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[]\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ModifyCloudDrivePermission' => [ + 'summary' => 'The default policy for the enterprise file storage is that all users can upload files from on-premises devices to the enterprise file storage, but cannot download files from the enterprise file storage to on-premises devices. You can invoke this API to add users with exception permissions.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk in Cloud Drive Service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-60911*****', 'title' => ''], + ], + [ + 'name' => 'DownloadEndUserIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The IDs of the users who have the download permissions.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'DownloadUploadEndUserIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The image IDs. You can specify 1 to 100 image IDs.'."\n", + 'description' => 'The IDs of the users who have the upload and download permissions.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-gx2x1dhsmusr2****', - ], - 'required' => true, + 'items' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'tom', 'title' => ''], + 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeleteCascadedBundle', + 'name' => 'NoDownloadNoUploadEndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to delete the associated template.'."\n", - 'type' => 'boolean', + 'maxItems' => 100, + 'description' => 'List of end user IDs with neither upload nor download permissions. These users cannot download files from the enterprise file storage to on-premises devices or upload files from on-premises devices to the enterprise file storage.'."\n", + 'type' => 'array', + 'items' => ['description' => 'End user ID with neither upload nor download permissions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'leon', 'title' => ''], 'required' => false, - 'example' => 'true', - 'default' => 'false', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9197824D-AD4B-571F-94BB-C2E6D5855AB6', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteImages', - 'summary' => 'Deletes one or more custom images.', - 'description' => '* Images include system images and custom images. System images cannot be deleted.'."\n" - .'* If an image that you want to delete is referenced by a cloud computer template, call the [DeleteBundles](~~436972~~) operation to delete the cloud computer template before you delete the image.'."\n", - ], - 'CancelCopyImage' => [ - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9197824D-AD4B-571F-94BB-C2E6D5855AB6\\"\\n}","type":"json"}]', + 'title' => 'Modify user permissions for file transfer between enterprise file storage and on-premises devices'."\n", + 'description' => 'When accessing the file storage within WUYING Workspace, file uploads and downloads between them are always allowed because both reside in a secure environment. However, if the visibility of the file storage on WUYING Terminal has been enabled, end users can directly access the file storage through the WUYING Terminal interface.'."\n" + ."\n" + .'To prevent end users from transferring sensitive data from WUYING Workspace to on-premises devices via the file storage, the default policy allows users to upload files from on-premises devices to the enterprise file storage but prohibits downloading files from the enterprise file storage to on-premises devices. This default policy applies to all users of the file storage, and you do not need to configure its scope.'."\n" + ."\n" + .'If needed, you can invoke this API to control user permissions for file transfer between the enterprise file storage and on-premises devices. Users added here will be exempt from the default policy.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-11-04T09:17:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDrivePermission'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCloudDrivePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ModifyCloudDriveUsers' => [ + 'summary' => 'Modify basic properties of a user\'s personal disk, such as the status and storage capacity limit.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can invoke [DescribeRegions](~~196646~~) to obtain the list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The enterprise cloud disk ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-596198****', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region to which the image is copied.'."\n", + 'description' => 'The status of Cloud Drive Service users.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* disabled'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' unavailable'."\n" + ."\n" + .' '."\n" + ."\n" + .'* enabled'."\n" + ."\n" + .' '."\n" + ."\n" + .' :'."\n" + ."\n" + .' '."\n" + ."\n" + .' available'."\n" + ."\n" + .' '."\n", 'type' => 'string', - 'required' => true, + 'required' => false, 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enumValueTitles' => ['disabled' => '', 'enabled' => ''], + 'example' => 'enabled', + 'title' => '', ], ], [ - 'name' => 'ImageId', + 'name' => 'UserMaxSize', + 'in' => 'query', + 'schema' => ['description' => 'The maximum storage space of a user. Unit: bytes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1024', 'title' => ''], + ], + [ + 'name' => 'EndUserId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the new image in the destination region.'."\n", - 'type' => 'string', + 'description' => 'A list of end user IDs.', + 'type' => 'array', + 'items' => ['description' => 'The end user ID.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'required' => true, 'docRequired' => true, - 'example' => 'm-gx2x1dhsmusr2****', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information that is returned.'."\n", + 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D2E005C4-8CA3-5F1D-9917-E75BE3BF****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEFE642-A383-4A18-8939-FB7DE452****\\"\\n}","type":"json"}]', - 'title' => 'CancelCopyImage', - 'summary' => 'Cancels the operation of copying an image to another region.', - ], - 'CreateSnapshot' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2E005C4-8CA3-5F1D-9917-E75BE3BF****\\"\\n}","type":"json"}]', + 'title' => 'Modify user personal disk properties', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveUsers'], + ], ], + 'ramActions' => [], + ], + 'ModifyConfigGroup' => [ + 'summary' => 'Modifies the basic information of a configuration group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-gx2x1dhsmucyy****"', - ], + 'schema' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], ], [ - 'name' => 'SnapshotName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the snapshot. The name must be 2 to 127 characters in length. The name must start with a letter. The name can contain letters, digits, underscores (\\_), and hyphens (-). The name cannot start with `auto` because snapshots whose names start with auto are recognized as automatic snapshots.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testSnapshotName', - 'maxLength' => 128, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'schema' => ['description' => 'The name of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled task', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The description of the configuration group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Scheduled task', 'maxLength' => 500, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the snapshot. The description can be up to 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testDescription', - 'maxLength' => 128, + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'GroupId' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"GroupId\\": \\"cg-i1ruuudp92qpj****\\"\\n}","type":"json"}]', + 'title' => 'ModifyConfigGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SourceDiskType', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:ModifyConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyCustomizedListHeaders' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ListType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the disk for which you want to create a snapshot.'."\n" + 'description' => 'The type of the list.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* system: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* data: data disk'."\n" + .'* desktop: cloud computer'."\n" ."\n" .' '."\n" ."\n" @@ -34360,8665 +31427,7957 @@ ."\n" .' '."\n", 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'system' => '', - 'data' => '', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['desktop' => ''], + 'example' => 'desktop', + 'title' => '', + ], + ], + [ + 'name' => 'Headers', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The headers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The header.'."\n", + 'type' => 'object', + 'properties' => [ + 'HeaderKey' => [ + 'description' => 'The key of the header.'."\n" + ."\n" + .'> All header keys of the list must be specified.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* desktop_id_name: the IDs and names of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* system_data_disk: the system disks and data disks of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* office_site_type: the office network types of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* create_time: the time when the cloud computers are created.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* ip: the IP addresses of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* spec_system_protocol: the instance types, OSs, and protocol types of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* monitor: the monitoring information of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* assigned_users: the number of end users that are assigned to the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* encryption: indicates whether the cloud computers are encrypted.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* office_site_id_name: the IDs and names of the office networks.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* pay_type: the billing methods of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* tag: the tags that are attached to the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* hostname: the hostnames of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* status: the statuses of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* current_user: the current end users of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'desktop_id_name' => '', 'system_data_disk' => '', 'office_site_type' => '', 'create_time' => '', 'ip' => 'IP', 'spec_system_protocol' => '', 'monitor' => '', 'assigned_users' => '', 'encryption' => '', 'office_site_id_name' => '', + 'pay_type' => '', 'tag' => '', 'host_name' => '', 'status' => '', 'current_user' => '', + ], + 'example' => 'pay_type', + 'title' => '', + ], + 'DisplayType' => [ + 'description' => 'The display type of the header.'."\n" + ."\n" + .'> For the desktop_id_name and office_site_id_name head keys, set the value of this parameter to required. For other header keys, set the value of this parameter to display or hide based on your requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['hide' => '', 'display' => '', 'required' => ''], + 'example' => 'display', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'system', + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object returned.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'SnapshotId' => [ - 'description' => 'The ID of the snapshot.'."\n", - 'type' => 'string', - 'example' => 's-2ze81owrnv9pity4****', - ], - 'RequestId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-2ze81owrnv9pity4****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\"\\n}","errorExample":""},{"type":"xml","example":"\\n s-2ze81owrnv9pity4****\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n","errorExample":""}]', - 'title' => 'CreateSnapshot', - 'summary' => 'Create a snapshot for a disk of a cloud computer to back up or restore the data on the disk.', - 'description' => 'The cloud computer must be in the **Running** or **Stopped** state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResetSnapshot' => [ - 'summary' => 'Restores the data of a disk from a snapshot.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ModifyCustomizedListHeaders', + 'summary' => 'Modifies the layouts of cloud computer list headers, such as the required fields and the display and hide settings.', + 'changeSet' => [ + ['createdAt' => '2022-09-09T06:33:35.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCustomizedListHeaders'], + ], ], + 'ramActions' => [], + ], + 'ModifyDesktopChargeType' => [ + 'summary' => 'Changes the billing method of a cloud desktop to subscription or pay-as-you-go.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ChargeType', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the region.'."\n", + 'description' => 'The new billing method.', + 'enumValueTitles' => ['PostPaid' => 'Changes the billing method from subscription to pay-as-you-go.', 'PrePaid' => 'Changes the billing method from pay-as-you-go to subscription.'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hzngahou', - 'title' => '地域。', + 'required' => false, + 'example' => 'PrePaid', + 'title' => '', ], ], [ - 'name' => 'SnapshotId', + 'name' => 'Period', + 'in' => 'query', + 'schema' => ['description' => 'The subscription duration. This parameter is required only when you set the `ChargeType` parameter to `PrePaid`. The unit of the duration is specified by the `PeriodUnit` parameter.'."\n" + ."\n" + .'- If you set the `PeriodUnit` parameter to `Week`, you can set this parameter only to 1.'."\n" + ."\n" + .'- If you set the `PeriodUnit` parameter to `Month`, you can set this parameter to 1, 2, 3, or 6.'."\n" + ."\n" + .'- If you set the `PeriodUnit` parameter to `Year`, you can set this parameter to 1, 2, 3, 4, or 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the snapshot.'."\n", + 'description' => 'The unit of the subscription duration.', + 'enumValueTitles' => ['Month' => 'month. This is the default value.', 'Year' => 'year', 'Week' => 'week'], 'type' => 'string', - 'required' => true, - 'example' => 's-2zeipxmnhej803x7****', - 'title' => '快照ID。', + 'required' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'StopDesktop', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'title' => '是否关机并恢复快照。', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Enables automatic payment. Make sure that your account has a sufficient balance. Otherwise, an unpaid order is generated. This is the default value.', 'false' => 'Generates an order but does not complete the payment. You can log on to the console and complete the payment in the Orders section of the User Center. Use the order ID that is returned by this operation to complete the payment.'], 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the cloud desktops. You can specify 1 to 20 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => '["ecd-gx2x1dhsmucyy****"]', 'title' => ''], + 'required' => true, + 'example' => 'ecd-gx2x1dhsmucyy****', + 'maxItems' => 100, + 'title' => '', ], ], + [ + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '50003836003****', 'title' => ''], + ], + [ + 'name' => 'UseDuration', + 'in' => 'query', + 'schema' => ['description' => '> This parameter is in invitational preview and is not publicly available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'sample', 'title' => ''], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object that is returned.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - 'title' => '请求ID。', + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'DesktopId' => [ + 'description' => 'The IDs of the cloud desktops.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'example' => '["ecd-gx2x1dhsmucyy****"]', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ResetSnapshot', - 'description' => 'Before you call this operation, make sure that the following operations are performed:'."\n" + 'title' => 'ModifyDesktopChargeType', + 'description' => '- Before calling this operation, ensure you understand the billing methods for cloud desktops. For more information, see [billing overview](~~188395~~).'."\n" + ."\n" + .'- Ensure the cloud desktop is in the running or stopped state and has no overdue payments.'."\n" + ."\n" + .'- After you pay for the order, the system begins to convert the billing method. While the desktop is in the updating state, you cannot perform other operations, such as starting, stopping, or changing its configuration.'."\n" ."\n" - .'* The data that you want to retain is backed up.'."\n" + .''."\n" ."\n" - .' > The disk restoration operation is irreversible. After you call this operation, the disk is restored to the status at the point in time when the snapshot was created. Data that is generated between the snapshot creation time and the current time is lost. Before you restore the disk based on the snapshot, make sure that you back up data.'."\n" + .'When you convert from subscription to pay-as-you-go, refund limits apply. For more information, see [Convert Subscription to Pay-As-You-Go](~~439964~~).'."\n" ."\n" - .'* The cloud computer to which the disk belongs is stopped.', + .'', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeSnapshots' => [ - 'summary' => 'Queries the snapshots that are created based on a cloud computer and the details of the snapshots.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-07-22T12:10:24.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-19T09:17:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-09-27T02:07:11.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-09-27T02:07:11.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopChargeType'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ],\\n \\"TaskId\\": \\"\\"\\n}","type":"json"}]', + ], + 'ModifyDesktopGroup' => [ + 'summary' => 'Modifies a shared cloud computer group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to get a list of regions that WUYING Workspace supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => 'The ID of the shared cloud computer group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'DesktopName', + 'name' => 'OwnBundleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testName', - ], + 'schema' => ['description' => 'The cloud computer template ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'b-7t275tpgjueeu****', 'title' => ''], ], [ - 'name' => 'SnapshotId', + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The policy ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pg-53iyi2aar0nd6****', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupName', + 'in' => 'query', + 'schema' => ['description' => 'Shared cloud desktop name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'desktopGroupName1', 'title' => ''], + ], + [ + 'name' => 'ScaleStrategyId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the auto scaling policy group.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 's-kakowkdl****', 'title' => ''], + ], + [ + 'name' => 'KeepDuration', + 'in' => 'query', + 'schema' => ['description' => 'The duration to keep a session active after it disconnects. Unit: milliseconds. Valid values range from 180000 (3 minutes) to 345600000 (4 days). A value of 0 means the session is always kept active.'."\n" + ."\n" + .'When a session disconnects, either intentionally or unexpectedly, a timer begins. If the user fails to reconnect within this duration, the session is logged off, and any unsaved data is destroyed. If the user reconnects within this duration, they can resume the original session and access the data from before the disconnection.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '180000', 'title' => ''], + ], + [ + 'name' => 'Comments', + 'in' => 'query', + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'comment', 'title' => ''], + ], + [ + 'name' => 'MinDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of cloud computers that are automatically created in a subscription shared cloud computer group. This parameter is required and takes effect only when `ChargeType` is set to `PrePaid`. Default value: 1. Valid values: 0 to the value of `MaxDesktopsCount`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'MaxDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of cloud computers that a pay-as-you-go shared cloud computer group can contain. Valid values: 0 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'AllowAutoSetup', 'in' => 'query', 'schema' => [ - 'description' => 'The snapshot ID.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable automatic creation of cloud computers in a subscription shared cloud computer group. This parameter is required and takes effect only when `ChargeType` is set to `PrePaid`.', + 'enumValueTitles' => ['No', 'Yes'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'example' => 's-2ze81owrnv9pity4****', + 'docRequired' => false, + 'maximum' => '1', + 'minimum' => '0', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'SnapshotName', + 'name' => 'AllowBufferCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of cloud computers to reserve in a pay-as-you-go shared cloud computer group. This parameter is required and takes effect only when `ChargeType` is set to `PostPaid`. Valid values:'."\n" + ."\n" + .'- 0: No cloud computers are reserved.'."\n" + ."\n" + .'- N: N cloud computers are reserved (1 ≤ N ≤ 100).'."\n" + ."\n" + .'> If you do not reserve any cloud computers, the system must create and start one when an end user requests a connection. This process takes longer. Reserve a specific number of cloud computers to ensure a good user experience.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ResetType', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the snapshot. The name must be 2 to 127 characters in length. The name must start with a letter. The name can contain letters, digits, underscores (\\_), and hyphens (-). The name cannot start with `auto` because snapshots whose names start with auto are recognized as automatic snapshots.'."\n", - 'type' => 'string', + 'description' => 'The reset type for the cloud computers.', + 'enumValueTitles' => ['Do not reset.', 'Reset only the system disk.', 'Reset only the user disk.', 'Reset both the system disk and the user disk.'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'example' => 'test_data_disk'."\n", + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'SourceDiskType', + 'name' => 'LoadPolicy', 'in' => 'query', 'schema' => [ - 'description' => 'The disk for which you want to create a snapshot.'."\n" - ."\n" - .'> The value of this parameter is not case-sensitive.'."\n" + 'description' => 'The load balancing policy for a multi-session shared cloud computer group that contains multiple cloud computers.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" - .'* Data: the data disk.'."\n" - .'* System: the system disk.'."\n", - 'type' => 'string', + .'> This parameter is not yet available.', + 'enumValueTitles' => ['Depth-first', 'Breadth-first'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'enumValueTitles' => [ - 'Data' => '', - 'System' => '', - ], - 'example' => 'system', + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'SnapshotType', + 'name' => 'BindAmount', + 'in' => 'query', + 'schema' => ['description' => 'The number of concurrent sessions that each cloud computer in a multi-session shared cloud computer group can support.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'example' => 'desktopimage-windows-server-2016-64-ch', 'title' => ''], + ], + [ + 'name' => 'Classify', 'in' => 'query', 'schema' => [ - 'description' => 'The category of the snapshots.'."\n" - ."\n" - .'Default value: all. Valid values:'."\n" - ."\n" - .'* all: all snapshot categories'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" + 'description' => 'The type of the shared cloud computer group.'."\n" ."\n" - .'* auto: automatic snapshots'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* user: manual snapshots'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + .'> This parameter is not yet available.', + 'enumValueTitles' => ['teacher' => 'A shared cloud computer group for teachers', 'student' => 'A shared cloud computer group for students'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'all' => '', - 'auto' => '', - 'user' => '', - ], - 'example' => 'user', + 'example' => 'teacher', + 'title' => '', ], ], [ - 'name' => 'OsType', + 'name' => 'RatioThreshold', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Linux' => '', - 'Windows' => '', - ], - 'example' => 'Windows', - ], + 'schema' => ['description' => 'The session usage threshold. This threshold is a condition for triggering auto scaling in a multi-session shared cloud computer group. The session usage is calculated using the following formula:'."\n" + ."\n" + .'`Session usage = Number of active sessions / (Total number of cloud computers × Maximum number of sessions per cloud computer) × 100%`'."\n" + ."\n" + .'When the session usage reaches this threshold, new cloud computers are created. If the session usage is below this threshold, idle cloud computers are deleted.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.85', 'title' => ''], ], [ - 'name' => 'Creator', + 'name' => 'ConnectDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The user who creates the snapshot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Administrator', - ], + 'schema' => ['description' => 'The maximum duration of a session. When the session duration reaches this value, the session is automatically disconnected. Unit: milliseconds. Valid values: 900000 (15 minutes) to 345600000 (4 days).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900000', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'IdleDisconnectDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-11-30T06:32:31Z', - ], + 'schema' => ['description' => 'The maximum idle time for a session. If there is no keyboard or mouse input within this time, the session disconnects. Unit: milliseconds. Valid values: 360000 (6 minutes) to 3600000 (60 minutes).'."\n" + ."\n" + .'Thirty seconds before the session disconnects, the end user receives a message to save their data. The end user must save their data to prevent data loss.'."\n" + ."\n" + .'> This parameter is applicable only to cloud computers with an image version of 1.0.2 or later.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360000', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'DisableSessionConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-11-31T06:32:31Z', - ], + 'schema' => ['description' => 'Specifies whether to disable session management.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'StopDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****', - ], + 'schema' => ['description' => 'The idle shutdown time. The cloud computer automatically shuts down when it is idle for this amount of time. If a user connects to a shutdown cloud computer, it automatically starts. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300000', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'ProfileFollowSwitch', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable user data roaming.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'FileSystemId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the NAS file system used for user data roaming.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'string', 'required' => false, 'example' => '04f314****', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of policy group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The policy group ID.', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'default' => '100', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'BuyDesktopsCount', + 'in' => 'query', + 'schema' => ['description' => '- For a subscription shared cloud computer group: the number of cloud computers to purchase. Valid values: 0 to 200.'."\n" + ."\n" + .'- For a pay-as-you-go shared cloud computer group: the minimum number of cloud computers to create in the pool. Default value: 1. Valid values: 0 to the value of `MaxDesktopsCount`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'DeleteDuration', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'If the NextToken parameter is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'Snapshots' => [ - 'description' => 'The snapshots.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The snapshot.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The point in time at which the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T14:52:28Z', - ], - 'Status' => [ - 'description' => 'The status of the snapshot.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PROGRESSING: The snapshot is being created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* FAILED: The snapshot fails to be created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ACCOMPLISHED: The snapshot is created.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PROGRESSING' => '', - 'FAILED' => '', - 'ACCOMPLISHED' => '', - ], - 'example' => 'ACCOMPLISHED', - ], - 'SnapshotType' => [ - 'description' => 'The type of the snapshot.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AUTO: automatic snapshot'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* USER: manual snapshot'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AUTO' => '', - 'USER' => '', - ], - 'example' => 'USER', - ], - 'SnapshotName' => [ - 'description' => 'The name of the snapshot.'."\n", - 'type' => 'string', - 'example' => 'testSnapshotName', - ], - 'Progress' => [ - 'description' => 'The progress of creating the snapshot. Unit: %.'."\n", - 'type' => 'string', - 'example' => '100%', - ], - 'Description' => [ - 'description' => 'The description of the snapshot.'."\n", - 'type' => 'string', - 'example' => 'testDescription', - ], - 'SnapshotId' => [ - 'description' => 'The snapshot ID.'."\n", - 'type' => 'string', - 'example' => 's-2zeipxmnhej803x7****', - ], - 'RemainTime' => [ - 'description' => 'The remaining time that is required to complete the snapshot creation. Unit: seconds.'."\n" - ."\n" - .'> When the `Status` value is `PROGRESSING`, the `RemainTime` value is `-1`. A value of -1 indicates that the system is calculating the remaining time.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SourceDiskSize' => [ - 'description' => 'The capacity of the source disk. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '150', - ], - 'SourceDiskType' => [ - 'description' => 'The type of the source disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: system disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DATA: data disk'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer to which the snapshot belongs.'."\n", - 'type' => 'string', - 'example' => 'ecd-g03l3tlm8djoj****', - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DesktopStatus' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Stopped'."\n" - .'* Starting'."\n" - .'* Rebuilding'."\n" - .'* Running'."\n" - .'* Stopping'."\n" - .'* Expired'."\n" - .'* Deleted'."\n" - .'* Pending', - 'type' => 'string', - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], - 'example' => 'Running', - ], - 'DiskStatus' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'Available' => '', - 'Deleted' => '', - ], - 'example' => 'Available', - ], - 'Creator' => [ - 'description' => 'The user who creates the snapshot.'."\n", - 'type' => 'string', - 'example' => 'Administrator', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: High-definition Experience (HDX) protocol'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ASP: in-house Adaptive Streaming Protocol (ASP)'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'OsType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => '', - 'Windows' => '', - ], - 'example' => 'Windows', - ], - 'VolumeEncryptionEnabled' => [ - 'description' => 'Indicates whether disk encryption is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'VolumeEncryptionKey' => [ - 'description' => 'The ID of the Key Management Service (KMS) key that is used when disk encryption is enabled. You can call the [ListKeys](~~28951~~) operation to query the list of KMS keys.'."\n", - 'type' => 'string', - 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', - ], - 'DeletionTime' => [ - 'description' => 'The time when the snapshot was deleted. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T14:52:28Z'."\n", - ], - 'RestorePointId' => [ - 'description' => 'The ID of the restore point.'."\n", - 'type' => 'string', - 'example' => 'rp-btgmaa20wkcju****', - ], - 'RestorePointName' => [ - 'description' => 'The name of the restore point.'."\n", - 'type' => 'string', - 'example' => 'DataDiskBackup', - ], - 'EnvType' => [ - 'type' => 'string', - ], - 'EnvId' => [ - 'type' => 'string', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"DesktopName\\": \\"test\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DiskStatus\\": \\"Available\\",\\n \\"Creator\\": \\"Administrator\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"DeletionTime\\": \\"2020-12-20T14:52:28Z\\\\n\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\n \\n ACCOMPLISHED\\n 100%\\n testDescription\\n \\n testSnapshotName\\n s-2zeipxmnhej803x7****\\n 150\\n 2020-12-20T14:52:28Z\\n USER\\n 30\\n SYSTEM\\n \\n","errorExample":""}]', - 'title' => 'DescribeSnapshots', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'title' => 'ModifyDesktopGroup', + 'description' => 'After you create a shared cloud computer group, the system automatically provisions cloud computers in the group based on its auto scaling policy and end-user connections. All cloud computers in the group use the same cloud computer template and security policy. You can modify the group’s configuration as needed, such as the group name, cloud computer template, and associated policies.', + 'changeSet' => [ + ['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T12:56:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T07:29:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-12T07:02:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopGroup'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', ], - 'DeleteSnapshot' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ModifyDesktopHostName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the available regions for Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SnapshotId', + 'name' => 'NewHostName', + 'in' => 'query', + 'schema' => ['description' => 'The new hostname of the cloud desktop. The hostname must meet the following requirements:'."\n" + ."\n" + .'- The hostname must be 2 to 15 characters in length.'."\n" + ."\n" + .'- The hostname can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen, contain consecutive hyphens, or consist of only digits.', 'type' => 'string', 'required' => true, 'example' => 'NewName', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + ], + [ + 'name' => 'DesktopIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The snapshot IDs. You can specify 1 to 100 IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The snapshot ID. If the specified snapshot does not exist, the request is ignored.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's-2ze81owrnv9pity4****', - ], - 'required' => true, - 'example' => 's-2ze81owrnv9pity4****', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The object that is returned.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]', - 'title' => 'DeleteSnapshot', - 'summary' => 'Deletes one or more snapshots.', - 'description' => 'If the IDs of the snapshots that you specify do not exist, requests are ignored.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateAutoSnapshotPolicy' => [ - 'summary' => 'Creates an automatic snapshot policy. WUYING WorkSpace automatically creates snapshots based on the time specified by the cron expression in the automatic snapshot policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyDesktopHostName', + 'summary' => 'Modifies the hostname of a Windows cloud desktop in an AD workspace.', + 'description' => 'You can only modify the hostname of Windows cloud desktops in an AD workspace. Modifying the hostname rebuilds the cloud desktop.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopHostName'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopHostName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyDesktopName' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to obtain a list of regions that are supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyName', + 'name' => 'NewDesktopName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). This parameter is empty by default.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_auto_policy', - 'maxLength' => 64, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'schema' => ['description' => 'The new name of the cloud desktop. The name must meet the following requirements:'."\n" + ."\n" + .'- The name must be 1 to 64 characters in length.'."\n" + ."\n" + .'- The name must start with a letter or a Chinese character. It cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- The name can contain digits, letters, colons (:), underscores (\\_), periods (.), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01', 'title' => ''], ], [ - 'name' => 'RetentionDays', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the automatic snapshots. Unit: days. Valid values: 1 to 180.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '30', - ], + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy**** ', 'title' => ''], ], [ - 'name' => 'CronExpression', + 'name' => 'DesktopIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The CRON expression for periodic scheduling.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0 0 2 ? * 1-7', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 500, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DiskType', + 'name' => 'UserAssignMode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'PolicyId' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'example' => 'sp-3hpa78d0qyt99****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyId\\": \\"sp-3hpa78d0qyt99****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', - 'title' => 'CreateAutoSnapshotPolicy', - 'description' => 'You can call the operation to create an automatic snapshot policy based on a CRON expression. Then, the system automatically creates snapshots of a cloud desktop based on the policy.'."\n", - ], - 'DescribeAutoSnapshotPolicy' => [ - 'summary' => 'Queries the automatic snapshot policy.', - 'methods' => [ - 'post', - 'get', + 'title' => 'ModifyDesktopName', + 'summary' => 'Modifies the name of a specified cloud desktop.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopName'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyDesktopSpec' => [ + 'summary' => 'Modifies the desktop type and expands the disks of a cloud desktop.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '52878', + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to obtain a list of regions that Elastic Desktop Service supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyId', + 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-c5tv9d64ebjnj****', - ], + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-4543qyik164a4****', 'title' => ''], ], [ - 'name' => 'PolicyName', + 'name' => 'DesktopType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test 1201'."\n", - ], + 'schema' => ['description' => 'The new desktop type. You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) operation to query the supported desktop types.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'eds.general.2c4g', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'RootDiskSizeGib', + 'in' => 'query', + 'schema' => ['description' => 'The new size of the system disk, in GiB. The value must be a multiple of 10 in the range of 80 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'UserDiskSizeGib', + 'in' => 'query', + 'schema' => ['description' => 'The new size of the data disk, in GiB.'."\n" + ."\n" + .'- For non-graphics-accelerated desktop types, the value must be a multiple of 10 in the range of 20 to 1,020.'."\n" + ."\n" + .'- For graphics-accelerated desktop types, the value must be a multiple of 10 in the range of 40 to 1,020.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '65536', 'minimum' => '0', 'example' => '40', 'title' => ''], + ], + [ + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 50.'."\n" - .'* Default value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Enables automatic payment. Ensure your account has a sufficient balance; otherwise, an unpaid order is generated. This is the default value.', 'false' => 'Generates an order but does not complete the payment. You can then complete the payment on the My Orders page in the User Center by using the returned order ID.'], + 'type' => 'boolean', 'required' => false, - 'maximum' => '50', - 'example' => '10', + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'UserDiskPerformanceLevel', 'in' => 'query', 'schema' => [ - 'description' => 'The token that determines the start point of the next query. If this parameter is left empty, all results are returned.'."\n", + 'description' => 'The performance level of the data disk.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0. This is the default value.', 'PL3' => 'PL3', 'PL2' => 'PL2'], 'type' => 'string', 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mqIGdPhID94rjhZFGsvpJo', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The token that is used to start the next query. If this parameter is empty, all results haven been returned.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A7F6612E-59CC-59F9-9DD1-91867FCC****', - ], - 'AutoSnapshotPolicies' => [ - 'description' => 'The details of the queried automatic snapshot policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimePoints' => [ - 'description' => 'The points in time at which the auto snapshots were created.'."\n" - ."\n" - .'The parameter values are a JSON array. Example: `["0", "1", ... "23"]`. A maximum of 24 points in time are returned. The points in time are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '["17","18"]', - ], - 'CreationTime' => [ - 'description' => 'The time when the automatic snapshot policy was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-mm-ddthh:mm:ssz` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2023-01-11T09:14:00Z', - ], - 'Status' => [ - 'description' => 'The status of the automatic snapshot policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Expire: The automatic snapshot policy cannot be used because you have overdue payments in your account.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Normal: The automatic snapshot policy is normal.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Expire' => '', - 'Normal' => '', - ], - 'example' => 'Normal', - ], - 'DesktopNum' => [ - 'description' => 'The number of cloud computers to which the automatic snapshot policy is applied.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CronExpression' => [ - 'description' => 'The cron expression that specifies when Elastic Desktop Service creates snapshots on the cloud computers.', - 'type' => 'string', - 'example' => '0 0 5,7 ? * 2/2', - ], - 'RetentionDays' => [ - 'description' => 'The retention period of the automatic snapshots. Unit: days. Valid values: 1 to 180.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'PolicyName' => [ - 'description' => 'The name of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'example' => 'snapshot01', - ], - 'PolicyId' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', - 'example' => 'sp-3e3bmfcdkjfl1****', - ], - 'RegionId' => [ - 'description' => 'The ID of the region to which the automatic snapshot policy belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DiskType' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'description' => '', + 'example' => 'PL0', + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"A7F6612E-59CC-59F9-9DD1-91867FCC****\\",\\n \\"AutoSnapshotPolicies\\": [\\n {\\n \\"TimePoints\\": \\"[\\\\\\"17\\\\\\",\\\\\\"18\\\\\\"]\\",\\n \\"CreationTime\\": \\"2023-01-11T09:14:00Z\\",\\n \\"Status\\": \\"Normal\\",\\n \\"DesktopNum\\": 1,\\n \\"CronExpression\\": \\"0 0 5,7 ? * 2/2\\",\\n \\"RetentionDays\\": \\"2\\",\\n \\"PolicyName\\": \\"snapshot01\\",\\n \\"PolicyId\\": \\"sp-3e3bmfcdkjfl1****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DiskType\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeAutoSnapshotPolicy', - 'description' => 'You can view an automatic snapshot policy that is associated with a cloud desktop in the Elastic Desktop Service (EDS) console. To view the automatic snapshot policy, you can go to the EDS console, choose Deployment > Snapshots in the left-side navigation pane, and then view an automatic snapshot policy on the Snapshots page.'."\n", - ], - 'ApplyAutoSnapshotPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '50003308011****', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceSpecs', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'A list of resource specification templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'A resource specification template.', + 'type' => 'object', + 'properties' => [ + 'DesktopId' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-4543qyik164a4****', 'title' => ''], + 'RootDiskSizeGib' => ['description' => 'The new size of the system disk, in GiB. The value must be a multiple of 10 in the range of 80 to 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80', 'title' => ''], + 'UserDiskSizeGib' => ['description' => 'The new size of the data disk, in GiB. The value must be a multiple of 10 in the range of 20 to 2,040.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PolicyId', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", + 'description' => 'The resource type.'."\n" + ."\n" + .'> This parameter is required only for cloud desktops that use the subscription billing method.', + 'enumValueTitles' => ['DesktopMonthPackage' => 'A cloud desktop that uses the subscription billing method.'], 'type' => 'string', - 'required' => true, - 'example' => 'sp-ejtum8j5tfcw7****', + 'required' => false, + 'example' => 'DesktopMonthPackage', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'ResellerOwnerUid', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 20 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-2h7u3ymhm33qy****', - ], - 'required' => true, - 'maxItems' => 500, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****', + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'OrderIds' => [ + 'description' => 'A list of order IDs.', + 'type' => 'array', + 'items' => ['description' => 'An order ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\"\\n}","type":"json"}]', - 'title' => 'ApplyAutoSnapshotPolicy', - 'summary' => 'Apply an automatic snapshot policy to cloud computers. After the automatic snapshot policy is applied to the cloud computers, Elastic Desktop Service automatically creates snapshots for the cloud computers based on the time specified in the automatic snapshot policy.', - 'description' => 'You can also associate an automatic snapshot policy with a cloud desktop in the Elastic Desktop Service (EDS) console. To do so, perform the following steps: 1. Log on to the EDS console. 2. Choose Desktops and Groups > Desktops in the left-side navigation pane. 3. Find the cloud desktop that you want to manage on the Cloud Desktops page and choose More > Change Automatic Snapshot Policy in the Actions column. 4. Configure a policy for the cloud desktop as prompted in the Change Automatic Snapshot Policy panel.'."\n" + 'title' => 'ModifyDesktopSpec', + 'description' => 'This operation modifies the configuration of a cloud desktop, including its desktop type and disk sizes.'."\n" ."\n" - .'After you associate an automatic snapshot policy with the cloud desktop, the system creates snapshots for the cloud desktop based on the policy.'."\n", - ], - 'ModifyAutoSnapshotPolicy' => [ - 'summary' => 'Modifies the parameters of an automatic snapshot policy, such as the policy name and snapshot retention period.', - 'methods' => [ - 'post', - 'get', + .'- Before you modify the configuration, ensure you understand the supported desktop types and disk sizes. For more information, see [Cloud desktop specifications](~~188609~~). You can call the [DescribeDesktopTypes](~~DescribeDesktopTypes~~) operation to query the supported desktop types.'."\n" + ."\n" + .'- When you call this operation, you must modify the desktop type, the system disk size, or the data disk size. This requires specifying at least one of the corresponding parameters: `DesktopType`, `RootDiskSizeGib`, or `UserDiskSizeGib`. Note the following:'."\n" + ."\n" + .' - A desktop type includes vCPU, memory, and GPU configurations. You can change the desktop type but cannot modify these resources individually.'."\n" + ."\n" + .' - You cannot change a desktop type between general-purpose and non-general-purpose, or between graphics-accelerated and non-graphics-accelerated.'."\n" + ."\n" + .' - Both the system disk and the data disk support expansion, but not shrinking.'."\n" + ."\n" + .' - If the cloud desktop uses the subscription billing method, the system calculates the price difference based on the configuration change. You must pay the price difference, or you will receive a refund.'."\n" + ."\n" + .' - For the same cloud desktop, wait at least five minutes between configuration change operations.'."\n" + ."\n" + .' - The cloud desktop must be in the Stopped state.'."\n" + ."\n" + .'- This operation does not affect the personal data stored on the cloud desktop.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-02T07:40:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-17T13:19:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-12-12T02:43:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopSpec'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderIds\\": [\\n 123456789\\n ]\\n}","type":"json"}]', + ], + 'ModifyDesktopTimer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyId', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computers.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-asuk39x45qnjp****', 'title' => ''], 'required' => true, - 'example' => 'sp-itcmrhqt01tdo****', + 'maxItems' => 101, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PolicyName', + 'name' => 'DesktopTimers', 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the automatic snapshot policy. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). This parameter is empty by default.'."\n", - 'type' => 'string', + 'description' => 'The details of the scheduled task on cloud computers.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TimerType' => [ + 'description' => 'The type of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- NoOperationDisconnect: Disconnects the cloud computers without performing operations on the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- LogoutShutdown: Stops the cloud computers when end users log out Alibaba Cloud Workspace clients.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- NoConnect: Disconnects the cloud computers when end users perform one of the actions that is specified by the OperationType parameter.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- TimerBoot: Starts the cloud computers on schedule.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- TimerReset: Resets the cloud computers on schedule.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- LoginAutoConnect: automatically connects to the cloud computers when end users log on to Alibaba Cloud Workspace clients.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- NoOperationShutdown: Stops the cloud computers without performing operations on the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- TimerShutdown: Stops the cloud computers on schedule.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- NoOperationReboot: Restarts the cloud computers without performing operations on the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- TimerReboot: Restarts the cloud computers on schedule.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['NoOperationDisconnect' => '', 'LogoutShutdown' => '', 'NoConnect' => '', 'TimerBoot' => '', 'TimerReset' => '', 'LoginAutoConnect' => '', 'NoOperationShutdown' => '', 'TimerShutdown' => '', 'NoOperationReboot' => '', 'TimerReboot' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'TimerBoot', + 'title' => '', + ], + 'CronExpression' => ['description' => 'The cron expression of the schedule.'."\n" + ."\n" + .'> The time must be in UTC. For example, for 24:00 (UTC+8), you must set the value to 0 0 16 ? \\* 1,2,3,4,5,6,7', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7', 'title' => ''], + 'Interval' => ['description' => 'The interval at which the scheduled task is executed. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Enforce' => [ + 'description' => 'Specifies whether to forcibly execute the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- true: forcibly executes the scheduled task regardless of the status and connection of the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false: does not forcibly execute the scheduled task.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'title' => '', + ], + 'ResetType' => [ + 'description' => 'The reset type of the cloud computers.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- RESET\\_TYPE\\_SYSTE: resets the system disk.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- RESET\\_TYPE\\_BOTH: resets data and user disks.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '', 'RESET_TYPE_BOTH' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'RESET_TYPE_SYSTEM', + 'title' => '', + ], + 'AllowClientSetting' => ['description' => 'Specifies whether to allow end users to configure the scheduled task.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'true', 'title' => ''], + 'OperationType' => [ + 'description' => 'The operations that scheduled tasks support. This parameter is valid only when TimerType is set to NoConnect.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Hibernate: hibernates the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- Shutdown: stops the cloud computers.'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['Hibernate' => '', 'Shutdown' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'Shutdown', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Automatic system snapshot'."\n", - 'maxLength' => 128, - 'minLength' => 2, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RetentionDays', + 'name' => 'UseDesktopTimers', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to use the `DesktopTimers`\\*\\* parameter. Set the value to `true`\\*\\*.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The retention period of the automatic snapshots. Unit: days. Valid values: 1 to 180.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', + 'type' => 'object', + 'properties' => [ + 'DesktopIds' => [ + 'description' => 'The IDs of the cloud computers for which you successfully configure the scheduled task.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer for which you successfully configure the scheduled task.', 'type' => 'string', 'example' => '[\'ecd-c6u0eis7rnqfw****\']', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4638719F-3CAB-5704-BD54-55617BFF****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyDesktopTimer', + 'summary' => 'Creates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopTimer'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CronExpression', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopTimer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopIds\\": [\\n \\"[\'ecd-c6u0eis7rnqfw****\']\\"\\n ],\\n \\"RequestId\\": \\"4638719F-3CAB-5704-BD54-55617BFF****\\"\\n}","type":"json"}]', + ], + 'ModifyDesktopsPolicyGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'PolicyGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.'."\n" + ."\n" + .'> If the `PolicyGroupIds` parameter is used, ignore the current parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The CRON expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 20 16 ? * 1,2,3,4,5,6,7', + 'description' => 'The cloud computer IDs. You can specify one or more cloud computers IDs. The value is a JSON array.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-ia2zw38bi6cm7****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'DiskType', + 'name' => 'PolicyGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The IDs of the cloud computer policies that you want to associate with cloud computers.'."\n" + ."\n" + .'> You can specify up to one cloud computer policy that takes effect globally, and up to four cloud computer policies that apply to specific IP addresses. If you specify more than one cloud computer policy that takes effect globally, only the policy first associate with the cloud computer can take effect.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'required' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'ModifyResults' => [ + 'description' => 'The request results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The request result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The returned message. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed. This parameter is not returned if the value of Code is success.``'."\n", 'type' => 'string', 'example' => 'The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.', 'title' => ''], + 'DesktopId' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', - 'title' => 'ModifyAutoSnapshotPolicy', - ], - 'CancelAutoSnapshotPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.\\",\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D3A17B8E-066B-421F-87DC-0B6451D89751\\n \\n ecd-7w78ozhjcwa3u****\\n success\\n \\n","errorExample":""}]', + 'title' => 'ModifyDesktopsPolicyGroup', + 'summary' => 'Changes an existing cloud computer policy for cloud computers.', + 'description' => 'The cloud computers for which you want to change their policies must be in the Running state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-24T08:39:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopsPolicyGroup'], + ], ], + 'ramActions' => [], + ], + 'ModifyDiskSpec' => [ + 'summary' => 'Modify the performance level of a cloud desktop\'s system disk or data disk.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~DescribeRegions~~) to get a list of supported regions for WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-2yjhqxo1monbf****', 'title' => ''], + ], + [ + 'name' => 'RootDiskPerformanceLevel', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", + 'description' => 'The performance level of the system disk. You can set the performance level for Graphics or High-frequency workspaces.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'docRequired' => false, + 'example' => 'PL1', + 'title' => '', ], ], [ - 'name' => 'PolicyId', + 'name' => 'UserDiskPerformanceLevel', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the automatic snapshot policy.'."\n", + 'description' => 'The performance level of the data disk. You can set the performance level for Graphics or High-frequency workspaces.', + 'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'], 'type' => 'string', 'required' => false, - 'example' => 'sp-78lhzpe7kjfnd****', + 'docRequired' => false, + 'example' => 'PL1', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID. Call a pricing inquiry API to get a list of applicable promotion IDs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank', 'title' => ''], + ], + [ + 'name' => 'AutoPay', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify 1 to 50 IDs. The IDs cannot be an empty string. The IDs can be up to 64 characters in length and cannot contain `http://` or `https://`. The IDs cannot start with `acs:` or `aliyun`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of a cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-itcmrhqt01tdl****', - ], - 'required' => true, - 'maxItems' => 100, + 'description' => 'Specifies whether to enable automatic payment.'."\n" + ."\n" + .'- If set to `true`, ensure your account has a sufficient balance. Otherwise, an abnormal order is generated.'."\n" + ."\n" + .'- If set to `false`, log on to the console. Then, go to the **Expenses and Costs** page to pay for the order using the returned order ID.', + 'enumValueTitles' => ['true' => 'Enables automatic payment. \\[Default]', 'false' => 'Generates an order but does not complete the payment.'], + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'title' => '', ], ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], + 'OrderId' => ['description' => 'The order ID. You can find the order ID in [Expenses and Costs > My Orders](https://billing-cost.console.aliyun.com/order/list). [Expenses and Costs > Order Management](https://usercenter2-intl.aliyun.com/order/list).', 'type' => 'string', 'example' => '219861020660568', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F89BBB13-8B3B-5C8A-A700-EEFDC17B8227', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', - 'title' => 'CancelAutoSnapshotPolicy', - 'summary' => 'Cancels an automatic snapshot policy for cloud computers.', - ], - 'DeleteAutoSnapshotPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"219861020660568\\",\\n \\"RequestId\\": \\"F89BBB13-8B3B-5C8A-A700-EEFDC17B8227\\"\\n}","type":"json"}]', + 'title' => 'ModifyDiskSpec', + 'description' => 'When you create a WUYING Workspace, you can define its specifications using a custom template. Graphics and High-frequency workspaces use Enhanced SSDs (ESSDs) by default, which lets you set the disk capacity and performance level. You can modify the performance level of the system disk or data disk as needed.'."\n" + ."\n" + .'> Only Graphics and High-frequency WUYING Workspaces support modifying the disk performance level.', + 'changeSet' => [ + ['createdAt' => '2025-03-03T16:09:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-24T02:26:50.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDiskSpec'], + ], ], + 'ramActions' => [], + ], + 'ModifyEntitlement' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyId', + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the automatic snapshot policies that you want to delete.'."\n", + 'description' => 'The username IDs. End users specified by this parameter become the end users of the cloud computer, and the original end users of the cloud computer are removed. You can specify 1 to 100 IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the automatic snapshot policies that you want to delete. You can specify 1 to 100 IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sp-424g04y887d9e****', - ], - 'required' => true, + 'items' => ['description' => 'The username ID of an end user.'."\n" + ."\n" + .'* For a convenience user, set the value to the username of the convenience user.'."\n" + .'* For an Active Directory (AD) user, set the value to the sAMAccountName value of the AD user.'."\n" + ."\n" + .'> If you do not specify this parameter, all original end users of the cloud computer are removed and the cloud computer is not assigned to end users.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ModifyEntitlement', 'title' => ''], + 'required' => false, + 'example' => 'alice', 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]', - 'title' => 'DeleteAutoSnapshotPolicy', - 'summary' => 'Deletes an automatic snapshot policy.', - ], - 'DeleteCenterPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8F851208-C0EA-4CDD-9074-DBE70CB430DA\\n","errorExample":""}]', + 'title' => 'ModifyEntitlement', + 'summary' => 'Assigns a cloud computer to end users and removes all original end users of the cloud computer.', + 'description' => '* The cloud computer must be in the Running state.'."\n" + .'* After you call this operation, the assignment result is immediately returned. You can call the [DescribeDesktops](~~436815~~) operation to query the assignment of the cloud computer. The value of the `ManagementFlags` response parameter indicates the assignment of the cloud computer. A value of `ASSIGNING` indicates that the cloud computer is being assigned, and other values indicate that the cloud computer is assigned.'."\n" + .'* We recommend that you check the assignment every 2 to 5 seconds and perform the checks within 50 seconds. Typically, 1 to 5 seconds are required to complete the assignment.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyEntitlement'], + ], ], + 'ramActions' => [], + 'extraInfo' => ' ', + ], + 'ModifyImageAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', - ], - 'example' => 'desktop'."\n", - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The business type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: public cloud.'."\n" - .'* 8: commercial edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 1 => '', - 8 => '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-2g65ljy3ynrdq****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => false, 'example' => 'testName', 'title' => ''], ], [ - 'name' => 'PolicyGroupIds', + 'name' => 'Description', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The policy IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'required' => true, - 'docRequired' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The description of the image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\"\\n}","type":"json"}]', - 'title' => 'DeleteCenterPolicy', - 'summary' => 'Deletes a global policy.', - ], - 'ModifyResourceCenterPolicy' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'ModifyImageAttribute', + 'summary' => 'Modifies the attributes of an image, including the name and description of the image.', + 'description' => 'You can call this operation to modify the attributes of only custom images that are in the Available state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => 'Error codes changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageAttribute'], ], ], - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyImageAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'desktop', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyImagePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs. You can specify up to 100 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-00001', - ], - 'required' => true, - 'docRequired' => false, - 'maxItems' => 100, - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'ResourceRegionId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the resource.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ProductType', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The service type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* resourceGroup: resource groups.'."\n" - .'* desktop: cloud computers.'."\n" - .'* desktopGroup: cloud computer shares.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'resourceGroup' => '', - 'desktop' => '', - 'desktopGroup' => '', - ], - 'example' => 'desktop', - ], + 'schema' => ['description' => 'The IDs of the images.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****', 'title' => ''], ], [ - 'name' => 'PolicyGroupType', + 'name' => 'AddAccount', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The policy type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* general: a general policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'general' => '', - ], - 'example' => 'general', + 'description' => 'The IDs of Alibaba Cloud accounts to which to share the image that will be created based on the image template. You can specify up to 20 account IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of Alibaba Cloud account N with which you want to share the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '118272523431****', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PolicyGroupIds', + 'name' => 'RemoveAccount', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer policies that you want to associate with cloud computers.'."\n" - ."\n" - .'> You can specify up to one cloud computer policy that takes effect globally, and up to four cloud computer policies that apply to specific IP addresses. If multiple cloud computer policies are configured for global enforcement, only the earliest-associated policy will take effect'."\n", + 'description' => 'The ID of Alibaba Cloud account N from which you want to unshare the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'required' => true, - 'docRequired' => false, - 'maxItems' => 5, + 'items' => ['description' => 'The ID of Alibaba Cloud account N from which you want to unshare the custom image. Valid values of N: 1 to 10. If the value of N is greater than 10, this parameter is ignored.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '114984212876****', 'title' => ''], + 'required' => false, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'ModifyResults' => [ - 'description' => 'The modification results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The modification result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-e254cpyt9bb*****', - ], - 'CheckResult' => [ - 'description' => 'The verification result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"ResourceId\\": \\"ecd-e254cpyt9bb*****\\",\\n \\"CheckResult\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ModifyResourceCenterPolicy', - 'summary' => 'Modifies a global policy that is associated with a cloud resource.', - ], - 'ModifyCenterPolicy' => [ - 'summary' => 'Modifies a center policy.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ModifyImagePermission', + 'summary' => 'Shares an image with other Alibaba Cloud accounts, or unshares an image from the recipient Alibaba Cloud accounts.', + 'description' => '### [](#)Security of shared images'."\n" + ."\n" + .'Elastic Desktop Service cannot guarantee the integrity and security of shared images. When you use a shared image, you must make sure that the image comes from a trusted sharer or account, and you are legally responsible for using the shared image.'."\n" + ."\n" + .'### [](#)Quota and billing'."\n" + ."\n" + .'* A shared image does not count against the image quotas of principals to which the image is shared.'."\n" + .'* After a principal uses a shared image to create a cloud computer, the sharer is not charged for the shared image.'."\n" + .'* You are not charged for shared images.'."\n" + ."\n" + .'### [](#)Supported sharing behaviors'."\n" + ."\n" + .'* You can share custom images with other Alibaba Cloud accounts.'."\n" + .'* You can share custom images between accounts in the China site (aliyun.com) and the international site (alibabacloud.com).'."\n" + ."\n" + .'### [](#)Unsupported sharing behaviors'."\n" + ."\n" + .'* You cannot share images that are shared by other Alibaba Cloud accounts.'."\n" + .'* You cannot share encrypted images.'."\n" + .'* You cannot share images across regions. If you want to share an image across regions, you must copy the image to the destination region and then share the image. For more information, see [CopyImage](~~436978~~).', + 'changeSet' => [ + ['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImagePermission'], + ], ], + 'ramActions' => [], + ], + 'ModifyNASDefaultMountTarget' => [ + 'summary' => 'Modifies the mount target of a File Storage NAS (NAS) file system.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Set the value to `cn-shanghai`.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'cn-shanghai' => '', - ], - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'FileSystemId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer policy ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pg-53iyi2aar0nd6****', - ], + 'schema' => ['description' => 'The ID of the NAS file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '04f314****', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'MountTargetDomain', 'in' => 'query', + 'schema' => ['description' => 'The domain name of the mount target.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0bf744****-xo***.cn-hangzhou.nas.aliyuncs.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The business type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: public cloud'."\n" - .'* 8: commercial edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 1 => '', - 8 => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyNASDefaultMountTarget', + 'description' => 'When you create a NAS file system, a mount target is automatically generated. By default, the mount target does not need to be changed. If the mount target is deleted by misoperation, you must specify a new mount target for the NAS file system in the workspace. You can call the [CreateMountTarget](~~62621~~) operation to create a mount target.', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNASDefaultMountTarget'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyNASDefaultMountTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'desktop', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyNetworkPackageBandwidth' => [ + 'summary' => 'Modifies the bandwidth of a premium bandwidth plan.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Clipboard', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The read/write permissions on the clipboard.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: specifies one-way transfer. You can copy files only from on-premises devices to cloud computers.'."\n" - .'* readwrite: specifies two-way transfer. You can copy files between on-premises devices and cloud computers.'."\n" - .'* write: specifies one-way transfer. You can only copy files from cloud computers to on-premises devices.'."\n" - .'* off (default): disables all transfers, both one-way and two-way. Files cannot be copied directly between on-premises devices and cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'write' => '', - 'off' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the list of regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'LocalDrive', + 'name' => 'NetworkPackageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The read/write permissions on the on-premises drive.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: read-only. Cloud computers support on-premises disk mapping, but only for reading (copying) files—not modifying them.'."\n" - .'* readwrite: read and write. Cloud computers support on-premises disk mapping, allowing you to read (copy) and write (modify) on-premises files.'."\n" - .'* off (default): none. Cloud computers don\'t support on-premises disk mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'off' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The ID of the premium bandwidth plan.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'np-cxj99qb8d34vo****', 'title' => ''], ], [ - 'name' => 'UsbRedirect', + 'name' => 'Bandwidth', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the USB redirection feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The maximum bandwidth of the premium bandwidth plan, in Mbit/s.'."\n" + ."\n" + .'- For subscription premium bandwidth, the valid range is 2 to 1000.'."\n" + ."\n" + .'- For pay-as-you-go premium bandwidth with pay-by-traffic billing, the valid range is 2 to 200.'."\n" + ."\n" + .'- For pay-as-you-go premium bandwidth with pay-by-bandwidth billing, the valid range is 2 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20000', 'minimum' => '2', 'example' => '10', 'title' => ''], ], [ - 'name' => 'PrinterRedirect', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The printer redirection policy. This parameter only applies if DeviceRedirects does not include a printer redirection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect (default):enables device redirection.'."\n" - .'* usbRedirect: enables USB redirection.'."\n" - .'* off: disables any type of redirection.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable the automatic payment feature.', + 'enumValueTitles' => ['true' => 'Enables auto-payment. Make sure your account has sufficient balance. Otherwise, an abnormal order is generated. \\[Default]', 'false' => 'Generates an order but does not process payment. To pay, log on to the console and go to User Center > Orders. Then find the order by its order ID.'], + 'type' => 'boolean', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'off', + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'VisualQuality', + 'name' => 'PromotionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The image display quality.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high: high-definition (HD).'."\n" - .'* low: smoothness.'."\n" - .'* lossless: no quality loss.'."\n" - .'* medium (default): scenario-specific adaptation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'lossless' => '', - 'medium' => '', - ], - 'example' => 'low', - ], + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '500033080110596', 'title' => ''], ], [ - 'name' => 'GpuAcceleration', + 'name' => 'ResellerOwnerUid', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable Image Quality Control. This feature is highly recommended for professional design scenarios where performance and user experience are critical.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '214552063030752', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyNetworkPackageBandwidth', + 'changeSet' => [ + ['createdAt' => '2025-09-16T10:00:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-14T07:58:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-17T08:28:37.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-11-17T08:28:37.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageBandwidth'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyNetworkPackageEnabled' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Html5FileTransfer', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file transfer policy on the web client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: File upload and download are supported.'."\n" - .'* download: Only file download is supported.'."\n" - .'* upload: Only file upload is supported.'."\n" - .'* off (default): File upload and download are not supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'all' => '', - 'download' => '', - 'upload' => '', - 'off' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID. You can call the [](t2167755.xdita#)operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Watermark', + 'name' => 'NetworkPackageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* blind: displays invisible watermarks.'."\n" - .'* off (default): displays no watermark.'."\n" - .'* on: displays visible watermarks.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'blind' => '', - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The ID of the premium bandwidth plan.', 'type' => 'string', 'required' => true, 'example' => 'np-cfedn7r2pe48g****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Enabled', 'in' => 'query', 'schema' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to restore the premium bandwidth plan of the cloud computer.', + 'enumValueTitles' => ['true' => 'Restore', 'false' => 'Disable'], + 'type' => 'boolean', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'testPolicyGroupName', + 'docRequired' => true, + 'default' => 'true', + 'example' => 'true', + 'title' => '', ], ], - [ - 'name' => 'WatermarkType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The watermark type. You can specify up to three types. Separate multiple values with commas (,).'."\n" - ."\n" - .'> If you provide `custom` as the value for this parameter, you must configure `WatermarkCustomText` to specify custom text.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username.'."\n" - .'* Custom: the custom text.'."\n" - .'* DesktopIp: the IP address of the cloud computer.'."\n" - .'* ClientIp: the IP address of the client.'."\n" - .'* HostName: the rightmost 15 digits of the cloud computer ID.'."\n" - .'* ClientTime: the current time displayed on the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EndUserId' => '', - 'Custom' => '', - 'DesktopIp' => '', - 'ClientIp' => '', - 'HostName' => '', - 'ClientTime' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'EndUserId', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyNetworkPackageEnabled', + 'summary' => 'Restores or disables a premium bandwidth plan.', + 'description' => 'If you want to temporarily disable the Internet access of your cloud computer after the Internet access is enabled for your cloud computer, you can disable the premium bandwidth plan and restore it as needed.', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageEnabled'], + ], + ], + 'ramActions' => [ [ - 'name' => 'WatermarkCustomText', - 'in' => 'query', - 'schema' => [ - 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyNetworkPackageEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyOfficeSiteAccelerator' => [ + 'summary' => 'Modifies the Global Accelerator (GA) configuration.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'WatermarkTransparencyValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark opacity. A higher value makes the watermark more opaque. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'], + 'parameters' => [ [ - 'name' => 'WatermarkSecurity', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable security priority for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CameraRedirect', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The on-premises camera redirection policy. This parameter only applies if DeviceRedirects does not include an on-premises camera redirection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: enables device redirection.'."\n" - .'* off: disables device redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'off' => '', - ], - 'example' => 'on', - ], + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'NetRedirect', + 'name' => 'AccelerateRegion', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: enables network redirection globally.'."\n" - .'* off (default): disables network redirection.'."\n" - .'* on: enables the whitelist mode.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - ' all' => '', - 'off' => '', - 'on' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccelerateRegionId' => ['description' => 'The ID of the region to accelerate.'."\n" + ."\n" + .'The number of regions that you can add is limited by the total bandwidth and the instance type of the GA instance. For more information about the number of access regions supported by each instance type, see [Overview of GA instances](t1855472.xdita#).', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''], + 'IpVersion' => ['description' => 'The IP protocol version used to access GA instances. Valid values:'."\n" + ."\n" + .'- **IPv4** (default)'."\n" + ."\n" + .'- **IPv6**'."\n" + ."\n" + .'- **DUAL\\_STACK**: IPv4 and IPv6'."\n" + ."\n" + .'> * Only standard pay-as-you-go GA instances support the DUAL\\_STACK option.', 'type' => 'string', 'required' => false, 'example' => 'IPv4', 'title' => ''], + 'Bandwidth' => ['description' => 'The peak public bandwidth. Unit: Mbps.'."\n" + ."\n" + .'> For the pay-by-bandwidth metering method, the value ranges from 10 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '2', 'example' => '50', 'title' => ''], + 'IspType' => ['description' => 'The Internet line type in the acceleration region. Valid values:'."\n" + ."\n" + .'- **BGP**: BGP (Multi-ISP) lines.'."\n" + ."\n" + .'- **BGP\\_PRO**: BGP (Multi-ISP) Pro lines.'."\n" + ."\n" + .'> * This parameter is required for GA instances that use the pay-by-data-transfer metering method.'."\n" + .'>'."\n" + .'> * The supported line types vary based on the acceleration region.', 'type' => 'string', 'required' => true, 'example' => 'BGP', 'title' => ''], + ], + 'description' => 'The information about the regions to accelerate.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'on', + 'required' => false, + 'docRequired' => true, + 'maxItems' => 100, + 'description' => 'The information about the regions to accelerate.', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AppContentProtection', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The anti-screenshot policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default): disables anti-screenshot.'."\n" - .'* on: enables anti-screenshot.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], - 'example' => 'on', + 'title' => '', + 'description' => 'The response elements.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ModifyOfficeSiteAccelerator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyOfficeSiteAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RemoteCoordinate', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyboard and mouse control permissions during remote assistance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* optionalControl: By default, keyboard and mouse control is disabled during remote assistance. You can request permissions as needed.'."\n" - .'* fullControl: Keyboard and mouse control is enabled during remote assistance.'."\n" - .'* disableControl: Keyboard and mouse control is disabled during remote assistance.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'optionalControl' => '', - 'fullControl' => '', - 'disableControl' => '', - ], - 'example' => 'fullControl', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions where Elastic Desktop Service is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InternetCommunicationProtocol', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The network communication protocol.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* tcp: TCP is used when UDP/AST is restricted.'."\n" - .'* rtc: AST is used for high-frequency audio and video streaming.'."\n" - .'* auto: UTO enables automatic switch between AST and UDP modes based on desktop content.'."\n" - .'* both: UDP is ideal for office and HD graphic design use.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'tcp' => '', - 'rtc' => '', - 'auto' => '', - 'both' => '', - ], - 'example' => 'both', - ], + 'schema' => ['description' => 'The ID of the office site.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-882398****', 'title' => ''], ], [ - 'name' => 'VideoRedirect', + 'name' => 'DesktopAccessType', 'in' => 'query', 'schema' => [ - 'description' => 'The multimedia redirection policy.'."\n" + 'description' => 'The method for connecting to cloud computers.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables multimedia redirection.'."\n" - .'* on: enables multimedia redirection.'."\n", + .'> VPC connections use Alibaba Cloud PrivateLink, a free service. If you set this parameter to VPC or Any, PrivateLink is automatically activated.', + 'enumValueTitles' => ['INTERNET' => 'Allows you to connect to cloud computers over the Internet. This is the default value.', 'VPC' => 'Allows you to connect to cloud computers from a client within the VPC.', 'Any' => 'Allows you to connect over the Internet or from within a VPC. You can select the connection method on the client.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', + 'docRequired' => false, + 'example' => 'INTERNET', + 'title' => '', ], ], [ - 'name' => 'WatermarkColor', + 'name' => 'OfficeSiteName', 'in' => 'query', - 'schema' => [ - 'description' => 'The font color of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The name of the office site. The name must be 2 to 255 characters long. The name must start with a letter or a Chinese character, and cannot start with http\\:// or https\\://. It can contain digits, colons (:), underscores (\\_), and hyphens (-).
'."\n" + .'This parameter is optional.
', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'WatermarkDegree', + 'name' => 'NeedVerifyLoginRisk', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark rotation. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '-10', - ], + 'schema' => ['description' => 'Specifies whether to enable two-factor authentication. This parameter is applicable to only office sites that use convenience accounts. If enabled, the system performs a security check during logon. If the system detects a risk, it sends a verification code to the email address that is associated with the account. The user must enter the correct verification code to log on.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'WatermarkFontSize', + 'name' => 'NeedVerifyZeroDevice', 'in' => 'query', - 'schema' => [ - 'description' => 'The font size of the watermark. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Specifies whether to enable device verification. This feature is available only for office sites that use convenience accounts.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'WatermarkFontStyle', + 'name' => 'EnableAdminAccess', 'in' => 'query', 'schema' => [ - 'description' => 'The font style of the watermark.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* plain'."\n" - .'* bold'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to grant cloud computer users local administrative permissions.', + 'enumValueTitles' => ['true' => 'Grants the permissions. This is the default value.', 'false' => 'Does not grant the permissions.'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'plain' => '', - 'bold' => '', - ], - 'example' => 'plain', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'WatermarkRowAmount', + 'name' => 'AuthorityHost', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of watermark rows. Valid values: 3 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuProtectedMode', + 'name' => 'TenantId', 'in' => 'query', - 'schema' => [ - 'description' => 'The CPU spike protection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables CPU spike protection.'."\n" - .'* on: enables CPU spike protection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuRateLimit', + 'name' => 'DomainName', 'in' => 'query', - 'schema' => [ - 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuSampleDuration', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuSingleRateLimit', + 'name' => 'ClientSecret', 'in' => 'query', - 'schema' => [ - 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '80', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuDownGradeDuration', + 'name' => 'VSwitchId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 10, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MemoryProtectedMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The memory spike protection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables memory spike protection.'."\n" - .'* on: enables memory spike protection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MemoryRateLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The overall memory usage. Valid values: 70 to 90. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', - ], + ], + 'title' => 'ModifyOfficeSiteAttribute', + 'summary' => 'Modifies basic attributes of an office site (formerly a workspace), such as its name and whether to grant users local administrative permissions on their cloud computers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-15T09:35:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-07T08:13:52.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-28T11:55:04.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-10-28T11:55:04.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteAttribute'], ], + ], + 'ramActions' => [ [ - 'name' => 'MemorySampleDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyOfficeSiteCrossDesktopAccess' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MemorySingleRateLimit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The memory usage per process. Valid values: 30 to 60. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'MemoryDownGradeDuration', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The memory underclocking duration per process. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndUserApplyAdminCoordinate', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable end users to request administrator help.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables end users to request administrator help.'."\n" - .'* on: enables end users to request administrator help.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-068266****', 'title' => ''], ], [ - 'name' => 'EndUserGroupCoordinate', + 'name' => 'EnableCrossDesktopAccess', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the communication between cloud computers in an office network. If you enable the communication between cloud computers in an office network, the cloud computers can access each other.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to allow end users from the same office network to share cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t allow end users from the same office network to share cloud computers.'."\n" - .'* on: allows end users from the same office network to share cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ModifyOfficeSiteCrossDesktopAccess', + 'summary' => 'Enables or disables the communication between cloud computers in an office network (formerly workspace). If you enable the communication between cloud computers in an office network, the cloud computers can access each other.', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteCrossDesktopAccess'], + ], + ], + 'ramActions' => [], + ], + 'ModifyOfficeSiteDnsInfo' => [ + 'summary' => 'Modifies the DNS information of an office network.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy applies to specific IP addresses.'."\n" - .'* GLOBAL: The policy applies globally.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'GLOBAL', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'Recording', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The screen recording policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* period: Screen recording occurs at set intervals.'."\n" - .'* session: Screen recording is limited to sessions only.'."\n" - .'* off: Screen recording is disabled.'."\n" - .'* alltime: Screen recording is always enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'period' => '', - 'session' => '', - 'off' => '', - 'alltime' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RecordingAudio', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record audio files generated by cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t record audio files generated by cloud computers.'."\n" - .'* on: records audio files generated by cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-778418****', 'title' => ''], ], [ - 'name' => 'RecordingStartTime', + 'name' => 'DnsAddress', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The screen recording\'s start time in HH:MM:SS format. The value is meaningful only if `Recording` is set to `PERIOD`.'."\n", - 'type' => 'string', + 'description' => 'The IP addresses of the custom DNS servers. Up to 2 IP addresses can be specified.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address of the custom DNS server.'."\n", 'type' => 'string', 'required' => false, 'example' => '10.0.0.47', 'title' => ''], 'required' => false, - 'example' => '08:00:00', + 'docRequired' => false, + 'maxItems' => 2, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecordingEndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The screen recording\'s end time in HH:MM:SS format. The value is meaningful only if `Recording` is set to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:59:00', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', + 'title' => 'ModifyOfficeSiteDnsInfo', + 'changeSet' => [ + ['createdAt' => '2025-02-18T08:37:26.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteDnsInfo'], + ], + ], + 'ramActions' => [], + ], + 'ModifyOfficeSiteMfaEnabled' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordingFps', - 'in' => 'query', - 'schema' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'RecordingDuration', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The length of the screen recording file (in minutes). Screen recordings are split based on the specified duration and uploaded to Object Storage Service (OSS) buckets. If a file reaches 300 MB, the system prioritizes rolling updates for that file. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RecordingExpires', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'RecordingUserNotify', + 'name' => 'MfaEnabled', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to notify end users when screen recording is enabled.'."\n" + 'description' => 'Specifies whether to enable MFA.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* off: doesn\'t notify end users when screen recording is enabled.'."\n" - .'* on: notifies end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off'."\n", + .'- true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + 'title' => '', ], ], - [ - 'name' => 'RecordingUserNotifyMessage', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The notification sent to end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'required' => false, + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', 'example' => '', ], ], + ], + 'title' => 'ModifyOfficeSiteMfaEnabled', + 'summary' => 'Enables or disables multi-factor authentication (MFA) for an enterprise Active Directory (AD) office network (formerly workspace).', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteMfaEnabled'], + ], + ], + 'ramActions' => [ [ - 'name' => 'AdminAccess', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to grant the admin permissions to end users.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow: forcibly grants admin permissions.'."\n" - .'* deny: forcibly rejects granting admin permissions.'."\n" - .'* inherited: inherits the admin permissions from the user dimension.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'deny' => '', - 'inherited' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteMfaEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'deny', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyPolicyGroup' => [ + 'summary' => 'Modifies cloud computer policies.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableSessionRateLimiting', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enforce a bandwidth limit for sessions.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enforce a bandwidth limit for sessions.'."\n" - .'* on: enforces a bandwidth limit for sessions.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'SessionMaxRateKbps', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The bandwidth peak allowed for sessions. Unit: Kbit/s. Valid values: 2000 to 100000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000', - ], + 'schema' => ['description' => 'The ID of the region. Call [DescribeRegions](~~DescribeRegions~~) to query the regions that WUYING Workspace supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DisplayMode', + 'name' => 'PolicyGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The display mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* clientCustom: suitable for user-defined scenarios.'."\n" - .'* adminOffice: suitable for daily office scenarios.'."\n" - .'* adminDesign: suitable for design and 3D application scenarios.'."\n" - .'* adminCustom: suitable for admin-customized scenarios.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'clientCustom' => '', - 'adminOffice' => '', - 'adminDesign' => '', - 'adminCustom' => '', - ], - 'example' => 'clientCustom', - ], + 'schema' => ['description' => 'The ID of the cloud computer policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], ], [ - 'name' => 'StreamingMode', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The streaming mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* intelligent'."\n" - .'* smooth'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'intelligent' => '', - 'smooth' => '', - ], - 'example' => 'smooth', - ], + 'schema' => ['description' => 'The name of the cloud computer policy.', 'type' => 'string', 'required' => false, 'example' => 'testPolicyGroupName', 'title' => ''], ], [ - 'name' => 'ColorEnhancement', + 'name' => 'Clipboard', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable color enhancement for design and 3D applications.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable color enhancement for design and 3D applications.'."\n" - .'* on: enables color enhancement for design and 3D applications.'."\n", + 'description' => 'The clipboard redirection policy.', + 'enumValueTitles' => ['read' => 'One-way transfer. Copy content from your local computer to the cloud computer. You cannot copy content from the cloud computer to your local computer.', 'readwrite' => 'Two-way transfer. Copy content between your local computer and the cloud computer.', 'write' => 'One-way transfer. Copy content from the cloud computer to your local computer. You cannot copy content from your local computer to the cloud computer.', 'off' => 'Disabled. Prevents copying content between the cloud computer and your local computer. This is the default value.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'SmoothEnhancement', + 'name' => 'LocalDrive', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable smoothness enhancement for daily office use.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable smoothness enhancement for daily office use.'."\n" - .'* on: enables smoothness enhancement for daily office use.'."\n", + 'description' => 'The local disk mapping policy.', + 'enumValueTitles' => ['read' => 'Read-only. Maps local disks to the cloud computer. You can read (copy) local files but cannot modify them.', 'readwrite' => 'Read and write. Maps local disks to the cloud computer. You can read (copy) and modify local files.', 'off' => 'Disabled. Does not map local disks to the cloud computer. This is the default value.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'QualityEnhancement', + 'name' => 'UsbRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable image quality enhancement for design and 3D applications.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable image quality enhancement for design and 3D applications.'."\n" - .'* on: enables image quality enhancement for design and 3D applications.'."\n", + 'description' => 'The USB redirection policy.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], + 'docRequired' => false, 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'VideoEncPolicy', + 'name' => 'VisualQuality', 'in' => 'query', 'schema' => [ - 'description' => 'The video encoding policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* qualityFirst: prioritizes image quality.'."\n" - .'* bandwidthFirst: prioritizes bandwidth.'."\n", + 'description' => 'The image display quality.', + 'enumValueTitles' => ['high' => 'High', 'low' => 'Low', 'lossless' => 'Lossless', 'medium' => 'Medium. This is the default value.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'qualityFirst' => '', - 'bandwidthFirst' => '', - ], - 'example' => 'qualityFirst', - ], - ], - [ - 'name' => 'TargetFps', - 'in' => 'query', - 'schema' => [ - 'description' => 'The target frame rate. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'VideoEncMinQP', - 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum quantizer parameter (QP) for video files. A lower QP means better video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'docRequired' => false, + 'example' => 'low', + 'title' => '', ], ], [ - 'name' => 'VideoEncMaxQP', + 'name' => 'Html5Access', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum QP for video files. Higher QP values result in lower video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The policy for access from web clients.'."\n" + ."\n" + .'> Use the `ClientType` parameter to manage logon methods.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'example' => '30', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'VideoEncAvgKbps', + 'name' => 'Html5FileTransfer', 'in' => 'query', 'schema' => [ - 'description' => 'The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The policy for file transfers from web clients.', + 'enumValueTitles' => ['all' => 'Allows file uploads and downloads', 'download' => 'Allows file downloads', 'upload' => 'Allows file uploads', 'off' => 'Disabled. This is the default value.'], + 'type' => 'string', 'required' => false, - 'example' => '2000', + 'docRequired' => false, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'VideoEncPeakKbps', + 'name' => 'Watermark', 'in' => 'query', 'schema' => [ - 'description' => 'The peak bitrate allowed for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The watermark policy.', + 'enumValueTitles' => ['blind' => 'Enables blind watermarks', 'off' => 'Disables watermarks', 'on' => 'Enables visible watermarks'], + 'type' => 'string', 'required' => false, - 'example' => '2000', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'MaxReconnectTime', + 'name' => 'WatermarkType', 'in' => 'query', 'schema' => [ - 'description' => 'The maximum duration to retry reconnecting to cloud computers after an unexpected disconnection (non-human causes). Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The type of watermark. You can specify up to three types. Separate them with commas.'."\n" + ."\n" + .'> If you set this parameter to `Custom`, you must also specify the custom text in the `WatermarkCustomText` parameter.', + 'enumValueTitles' => ['EndUserId' => 'Username', 'Custom' => 'Custom text', 'DesktopIp' => 'IP address of the cloud computer', 'ClientIp' => 'IP address of the client', 'HostName' => 'The last 15 characters of the cloud computer ID', 'ClientTime' => 'Current time on the cloud computer'], + 'type' => 'string', 'required' => false, - 'example' => '120', + 'example' => 'EndUserId', + 'title' => '', ], ], [ - 'name' => 'WyAssistant', + 'name' => 'WatermarkTransparency', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the Xiaoying AI Assistant option in the DesktopAssistant menu when end users connect to cloud computers via desktop clients (Windows and macOS).'."\n" - ."\n" - .'> This feature applies to only desktop clients of version 7.7.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Xiaoying AI Assistant option in the DesktopAssistant menu.'."\n" - .'* on: displays the Xiaoying AI Assistant option in the DesktopAssistant menu.'."\n", + 'description' => 'The transparency of the watermark.', + 'enumValueTitles' => ['LIGHT' => 'Light. This is the default value.', 'DARK' => 'Dark', 'MIDDLE' => 'Medium'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', + 'example' => 'LIGHT', + 'title' => '', ], ], [ - 'name' => 'WatermarkAntiCam', + 'name' => 'PreemptLogin', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable anti-screen capture for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The policy for preemptible logon.'."\n" ."\n" - .'* off: doesn\'t enable anti-screen capture for invisible watermarks.'."\n" - .'* on: enables anti-screen capture for invisible watermarks.'."\n", + .'> To ensure the user experience and data security of the current user, other users cannot preempt the cloud computer. This parameter is set to `off` by default and cannot be changed.', + 'enumValueTitles' => ['off' => 'Multiple users cannot preempt each other. This is the default value.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'WatermarkPower', + 'name' => 'DomainList', 'in' => 'query', 'schema' => [ - 'description' => 'The enhancement level for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - .'* low'."\n" - .'* medium'."\n", + 'description' => 'The domain names that can be accessed. Wildcard characters (\\*) are supported. Separate multiple domain names with commas.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - ], - 'example' => 'medium', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'CpuProcessors', + 'name' => 'PrinterRedirection', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The CPU processors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The CPU processor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'chrome.exe', - ], + 'description' => 'The printer redirection policy.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'maxItems' => 5, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'MemoryProcessors', + 'name' => 'PreemptLoginUser', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The memory processors.'."\n", + 'description' => 'The usernames of users who can preempt the logon of a cloud computer. You can specify up to five usernames.'."\n" + ."\n" + .'> To ensure the user experience and data security of the current user, other users cannot preempt the cloud computer.', 'type' => 'array', - 'items' => [ - 'description' => 'The memory processor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'notepad.exe', - ], + 'items' => ['description' => 'The username of the user who can preempt the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], 'required' => false, 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DomainResolveRule', + 'name' => 'AuthorizeSecurityPolicyRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The domain resolution policies.'."\n", + 'description' => 'A list of security group rules.', 'type' => 'array', 'items' => [ - 'description' => 'The domain resolution policy.'."\n", + 'description' => 'The security group rule.', 'type' => 'object', 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", + 'Type' => [ + 'description' => 'The direction of the security group rule.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], 'type' => 'string', 'required' => false, - 'example' => '*.example.com', + 'example' => 'inflow', + 'title' => '', ], 'Policy' => [ - 'description' => 'Specifies whether to allow the domain name resolution rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow'."\n" - .'* block'."\n", + 'description' => 'The policy of the security group rule.', + 'enumValueTitles' => ['drop' => 'Deny. Denies all access requests. The system does not return a rejection message. The request times out or fails to connect.', 'accept' => 'Allow. Allows all access requests.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'allow', + 'example' => 'accept', + 'title' => '', ], - 'Description' => [ - 'description' => 'The policy description.'."\n", + 'PortRange' => ['description' => 'The port range of the security group rule. The value of this parameter depends on the \\`IpProtocol\\` parameter:'."\n" + ."\n" + .'- If the protocol is TCP or UDP, the port range is 1 to 65535. Use a forward slash (/) to separate the start and end port numbers. For example: 1/200.'."\n" + ."\n" + .'- If the protocol is ICMP, the port range is -1/-1.'."\n" + ."\n" + .'- If the protocol is GRE, the port range is -1/-1.'."\n" + ."\n" + .'- If IpProtocol is set to all, the port range is -1/-1.'."\n" + ."\n" + .'For more information about common ports, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'The description of the security group rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'The protocol type of the security group rule.', + 'enumValueTitles' => ['UDP' => 'UDP', 'TCP' => 'TCP', 'ALL' => 'All protocols', 'GRE' => 'GRE', 'ICMP' => 'ICMP (IPv4)'], 'type' => 'string', 'required' => false, - 'example' => '', + 'example' => 'TCP', + 'title' => '', ], + 'Priority' => ['description' => 'The priority of the security group rule. A smaller value indicates a higher priority. Valid values: 1 to 60. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'The destination IPv4 address range. Specify the value in CIDR notation.', 'type' => 'string', 'required' => false, 'example' => '10.0.XX.XX/8', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 500, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NetRedirectRule', + 'name' => 'RevokeSecurityPolicyRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The network redirection rules.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", + 'description' => 'The security group rules to delete.', 'type' => 'array', 'items' => [ - 'description' => 'The network redirection rule.'."\n" - ."\n" - .'> This parameter is in invitational preview and not available to the public.'."\n", + 'description' => 'The security group rule to delete.', 'type' => 'object', 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", + 'Type' => [ + 'description' => 'The direction of the security group rule to delete.', + 'enumValueTitles' => ['outflow' => 'Outbound', 'inflow' => 'Inbound'], 'type' => 'string', 'required' => false, - 'example' => '*.taobao.com'."\n", + 'example' => 'outflow', + 'title' => '', ], - 'RuleType' => [ - 'description' => 'The rule type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* prc: process.'."\n" - .'* domain: domain name.'."\n", + 'Policy' => [ + 'description' => 'The policy of the security group rule to delete.', + 'enumValueTitles' => ['drop' => 'Deny. Denies all access requests. The system does not return a rejection message. The request times out or fails to connect.', 'accept' => 'Allow. Allows all access requests. This is the default value.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'prc' => '', - 'domain' => '', - ], - 'example' => 'domain', + 'example' => 'accept', + 'title' => '', ], - 'Policy' => [ - 'description' => 'The redirection policy.'."\n", + 'PortRange' => ['description' => 'The port range of the security group rule to delete. The value of this parameter depends on the \\`IpProtocol\\` parameter:'."\n" + ."\n" + .'- If the protocol is TCP or UDP, the port range is 1 to 65535. Use a forward slash (/) to separate the start and end port numbers. For example: 1/200.'."\n" + ."\n" + .'- If the protocol is ICMP, the port range is -1/-1.'."\n" + ."\n" + .'- If the protocol is GRE, the port range is -1/-1.'."\n" + ."\n" + .'- If IpProtocol is set to all, the port range is -1/-1.'."\n" + ."\n" + .'For more information about common ports, see [Common ports](~~40724~~).', 'type' => 'string', 'required' => false, 'example' => '22/22', 'title' => ''], + 'Description' => ['description' => 'The description of the security group rule to delete.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'IpProtocol' => [ + 'description' => 'The protocol type of the security group rule to delete.', + 'enumValueTitles' => ['TCP' => 'TCP', 'UDP' => 'UDP', 'ALL' => 'All protocols', 'GRE' => 'GRE', 'ICMP' => 'ICMP (IPv4)'], 'type' => 'string', 'required' => false, - 'example' => 'Allow', + 'example' => 'tcp', + 'title' => '', ], + 'Priority' => ['description' => 'The priority of the security group rule to delete. A smaller value indicates a higher priority. Valid values: 1 to 60. Default value: 1.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'CidrIp' => ['description' => 'The destination IPv4 address range to delete. Specify the value in CIDR notation.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ScopeValue', + 'name' => 'AuthorizeAccessPolicyRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The effective scopes. This parameter is required when `Scope` is set to `IP`. If `Scope` is set to `IP`, this parameter doesn\'t take effect.'."\n", + 'description' => 'The client IP address whitelist.', 'type' => 'array', 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', + 'description' => 'The client IP address whitelist object.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the client IP address whitelist.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'The client IP address range. Specify the value in CIDR notation.', 'type' => 'string', 'required' => true, 'example' => '47.100.XX.XX/16', 'title' => ''], + ], 'required' => false, - 'example' => '47.100.XX.XX/24', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 50, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ClientType', + 'name' => 'RevokeAccessPolicyRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The types of Alibaba Cloud Workspace clients that end users can use to connect to cloud computers.'."\n", + 'description' => 'The client IP address whitelist to delete.', 'type' => 'array', 'items' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client that end users can use to connect to cloud computers.'."\n", + 'description' => 'The client IP address whitelist to delete.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Specifies whether end users can use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n" - ."\n" - .'> If you don\'t specify `ClientType`, any client can be used to connect to cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: End users cannot use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n" - .'* on: End users can use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'ClientType' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client that end users can use to connect to cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: the web client.'."\n" - .'* android: the Android client.'."\n" - .'* ios: the iOS client.'."\n" - .'* windows: the Windows client.'."\n" - .'* macos: the macOS client.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'ios' => '', - 'windows' => '', - 'macos' => '', - ], - 'example' => 'android', - ], + 'Description' => ['description' => 'The description of the client IP address whitelist to delete.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'CidrIp' => ['description' => 'The client IP address range to delete. Specify the value in CIDR notation.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 20, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UsbSupplyRedirectRule', + 'name' => 'ClientType', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The USB redirection rules.'."\n", + 'description' => 'A list of logon method control rules.', 'type' => 'array', 'items' => [ - 'description' => 'The USB redirection rule.'."\n", + 'description' => 'The logon method control rule.', 'type' => 'object', 'properties' => [ - 'VendorId' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04**', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n" - ."\n" - .'Valid values:'."\n" + 'ClientType' => [ + 'description' => 'The type of client.'."\n" ."\n" - .'* 1: enables USB redirection based on device manufacturers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - ], - 'example' => '1', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", + .'> If you do not specify this parameter, logons from all client types are allowed by default.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'windows' => 'Windows client', 'ios' => 'iOS client', 'macos' => 'macOS client'], 'type' => 'string', 'required' => false, - 'example' => '', + 'example' => 'windows', + 'title' => '', ], - 'UsbRedirectType' => [ - 'description' => 'Specifies whether to allow USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" + 'Status' => [ + 'description' => 'Specifies whether to allow logons from this client type.'."\n" ."\n" - .'* 1: allows USB redirection.'."\n" - .'* 2: forbids USB redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'ProductId' => [ - 'description' => 'The product ID (PID).'."\n", + .'> If you do not specify this parameter, logons from all client types are allowed by default.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'example' => '08**', + 'example' => 'ON', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AuthorizeSecurityPolicyRule', + 'name' => 'GpuAcceleration', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound.'."\n" - .'* inflow: inbound.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization policy of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests. If no \'\'access denied\'\' messages are returned, the requests either timed out or failed.'."\n" - .'* accept (default): accepts all requests.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule. The value range of this parameter varies based on the value of IpProtocol.'."\n" - ."\n" - .'* If IpProtocol is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If IpProtocol is set to ICMP, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to GRE, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to ALL, set the value to -1/-1.'."\n" - ."\n" - .'For more information about the common ports, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP: the Transmission Control Protocol (TCP) protocol.'."\n" - .'* UDP: the User Datagram Protocol (UDP) protocol.'."\n" - .'* ALL: any type of protocol.'."\n" - .'* GRE: the Generic Routing Encapsulation (GRE) protocol.'."\n" - .'* ICMP: the Internet Control Message Protocol (ICMP) for (IPv4).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'UDP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'TCP', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value specifies a higher priority. Valid values: 1 to 60. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object of the security group rule. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], + 'description' => 'Specifies whether to enable the image quality policy for graphics cloud desktops. Enabling this policy improves performance and user experience in professional design scenarios.', + 'enumValueTitles' => ['off' => 'Disable', 'on' => 'Enable'], + 'type' => 'string', 'required' => false, - 'maxItems' => 200, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'RevokeSecurityPolicyRule', + 'name' => 'UsbSupplyRedirectRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The security group rules that you want to delete.'."\n", + 'description' => 'The USB redirection rules.', 'type' => 'array', 'items' => [ - 'description' => 'The security group rule that you want to delete.'."\n", + 'description' => 'The USB redirection rule.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound.'."\n" - .'* inflow: inbound.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'outflow', - ], - 'Policy' => [ - 'description' => 'The authorization of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests. If no \'\'access denied\'\' messages are returned, the requests either timed out or failed.'."\n" - .'* accept (default): accepts all requests.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule that you want to delete. The value range of this parameter varies based on the value of IpProtocol.'."\n" - ."\n" - .'* If IpProtocol is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If IpProtocol is set to ICMP, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to GRE, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to ALL, set the value to -1/-1.'."\n" - ."\n" - .'For more information about the common ports, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP: the TCP protocol.'."\n" - .'* UDP: the UDP protocol.'."\n" - .'* ALL: any type of protocol.'."\n" - .'* GRE: the GRE protocol.'."\n" - .'* ICMP: the ICMP for IPv4.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'UDP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'TCP', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule that you want to delete. A smaller value specifies a higher priority. Valid values: 1 to 60. Default value: 1.'."\n", - 'type' => 'string', + 'VendorId' => ['description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '04**', 'title' => ''], + 'ProductId' => ['description' => 'The product ID (PID).', 'type' => 'string', 'required' => false, 'example' => '08**', 'title' => ''], + 'Description' => ['description' => 'The description of the rule.', 'type' => 'string', 'example' => 'Test rule', 'required' => false, 'title' => ''], + 'UsbRedirectType' => [ + 'description' => 'The USB redirection type.', + 'enumValueTitles' => [1 => 'Allow', 'Deny'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, 'example' => '1', + 'title' => '', ], - 'CidrIp' => [ - 'description' => 'The object of the security group rule that you want to delete. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', + 'DeviceClass' => ['description' => 'The device class. This parameter is required when \\`UsbRuleType\\` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'required' => false, 'example' => '0Eh', 'title' => ''], + 'DeviceSubclass' => ['description' => 'The device subclass. This parameter is required when \\`UsbRuleType\\` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).', 'type' => 'string', 'required' => false, 'example' => 'xxh', 'title' => ''], + 'UsbRuleType' => [ + 'description' => 'The type of USB redirection rule.', + 'enumValueTitles' => [1 => 'Device class', 'Device vendor'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'example' => '47.100.XX.XX/16', + 'example' => '1', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 200, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AuthorizeAccessPolicyRule', + 'name' => 'DomainResolveRuleType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The client IP address whitelists that you want to add.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address whitelist that you want to add.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block from which end users can connect to cloud computers. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], + 'description' => 'The type of domain name resolution policy.', + 'enumValueTitles' => ['OFF' => 'Disabled', 'ON' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'RevokeAccessPolicyRule', + 'name' => 'DomainResolveRule', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The client IP address whitelists that you want to delete.'."\n", + 'description' => 'The details of the domain name resolution policy.', 'type' => 'array', 'items' => [ - 'description' => 'The client IP address whitelist that you want to delete.'."\n", + 'description' => 'The details of the domain name resolution policy.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block that you want to delete. Specify an IPv4 CIDR block.'."\n", + 'Domain' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => '*.example.com', 'title' => ''], + 'Policy' => [ + 'description' => 'The resolution policy.', + 'enumValueTitles' => ['allow' => 'Allow', 'block' => 'Block'], 'type' => 'string', 'required' => false, - 'example' => '47.100.XX.XX/16', + 'example' => 'allow', + 'title' => '', ], + 'Description' => ['description' => 'The description of the policy.', 'type' => 'string', 'example' => 'Policy description.', 'required' => false, 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 100, + 'maxItems' => 500, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeviceRedirects', + 'name' => 'Recording', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection'."\n" - .'* usbRedirect: USB redirection.'."\n" - .'* off: any type of redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'deviceRedirect', - ], - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* printer'."\n" - .'* scanner'."\n" - .'* serialport'."\n" - .'* camera'."\n" - .'* adb'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'printer' => '', - 'scanner' => '', - 'serialport' => '', - 'camera' => '', - 'adb' => 'adb', - ], - 'example' => 'camera', - ], - ], - 'required' => false, - ], + 'description' => 'Specifies whether to enable screen recording.', + 'enumValueTitles' => ['byaction_cmd_ft' => 'Records user actions. Recording is triggered by both command execution and file transfers.', 'ALLTIME' => 'Records the entire session, from when a user connects to the cloud computer to when the user disconnects.', 'session' => 'Records the session lifecycle.', 'PERIOD' => 'Records during a specified time period. You must set the start and end times for the recording.', 'byaction_commands' => 'Records user actions. Recording is triggered only by command execution.', 'OFF' => 'Disables screen recording.', 'byaction_file_transfer' => 'Records user actions. Recording is triggered only by file transfers.'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'DeviceRules', + 'name' => 'RecordingStartTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sandisk', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection.'."\n" - .'* usbRedirect: USB redirection.'."\n" - .'* off: redirection disabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* usbKey: UKeys.'."\n" - .'* other: other peripheral devices.'."\n" - .'* graphicsTablet: graphics tablets.'."\n" - .'* cardReader: card readers.'."\n" - .'* printer: printers.'."\n" - .'* scanner: scanners.'."\n" - .'* storage: storage devices.'."\n" - .'* camera: web cameras.'."\n" - .'* networkInterfaceCard: NIC devices.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'usbKey' => 'U key', - 'other' => '', - 'graphicsTablet' => '', - 'cardReader' => '', - 'printer' => '', - 'scanner' => '', - 'storage' => '', - 'camera' => '', - 'networkInterfaceCard' => '', - ], - 'example' => 'storage', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2:0', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x55b1', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x0781', - ], - 'Platforms' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The start time of the screen recording. The time is in the HH:MM:SS format. This parameter is valid only when \\`Recording\\` is set to \\`PERIOD\\`.', 'type' => 'string', 'required' => false, 'example' => '08:00:00', 'title' => ''], ], [ - 'name' => 'WatermarkColumnAmount', + 'name' => 'RecordingEndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time of the screen recording. The time is in the HH:MM:SS format. This parameter is valid only when \\`Recording\\` is set to \\`PERIOD\\`.', 'type' => 'string', 'required' => false, 'example' => '08:59:00', 'title' => ''], + ], + [ + 'name' => 'RecordingFps', 'in' => 'query', 'schema' => [ - 'description' => 'The number of watermark columns. Valid values: 3 to 10.'."\n", + 'description' => 'The frame rate for screen recording. Unit: frames per second (fps).', + 'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'], 'type' => 'integer', - 'format' => 'int32', + 'format' => 'int64', 'required' => false, - 'example' => '3', + 'example' => '5', + 'title' => '', ], ], [ - 'name' => 'DomainResolveRuleType', + 'name' => 'RecordingExpires', + 'in' => 'query', + 'schema' => ['description' => 'The retention period of screen recording files. Valid values: 1 to 180. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + ], + [ + 'name' => 'NetRedirect', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enforce the domain resolution policy.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'Specifies whether to enable network redirection.'."\n" ."\n" - .'* off: disables the domain resolution policy.'."\n" - .'* on: enables the domain resolution policy.'."\n", + .'> This feature is available only for invitational preview. It is not publicly available.', + 'enumValueTitles' => ['off' => 'Disabled. This is the default value.', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'ClipboardScope', + 'name' => 'CameraRedirect', 'in' => 'query', 'schema' => [ + 'description' => 'Specifies whether to enable local camera redirection.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled. This is the default value.'], 'type' => 'string', - 'enum' => [ - 'global', - 'grained', - ], + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'ClipboardGraineds', + 'name' => 'AppContentProtection', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GrainedType' => [ - 'type' => 'string', - 'enum' => [ - 'text', - 'richtext', - 'file', - 'picture', - ], - ], - 'ClipboardType' => [ - 'type' => 'string', - 'enum' => [ - 'read', - 'write', - 'off', - 'readwrite', - ], - ], - 'ClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ClipboardSizeUnit' => [ - 'type' => 'string', - ], - 'InClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'InClipboardSizeUnit' => [ - 'type' => 'string', - ], - 'OutClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'OutClipboardSizeUnit' => [ - 'type' => 'string', - ], - ], - ], - 'maxItems' => 4, + 'description' => 'Specifies whether to enable screen capture prevention.', + 'enumValueTitles' => ['off' => 'Disabled. This is the default value.', 'on' => 'Enabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'StatusMonitor', + 'name' => 'RecordContent', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the metric status entry in the DesktopAssistant menu.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the metric status entry in the DesktopAssistant menu.'."\n" - .'* on: displays the metric status entry in the DesktopAssistant menu.'."\n", + 'description' => 'Specifies whether to enable custom screen recording.', + 'enumValueTitles' => ['off' => 'Disabled. This is the default value.', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'OFF', + 'title' => '', ], ], [ - 'name' => 'MobileRestart', + 'name' => 'RecordContentExpires', + 'in' => 'query', + 'schema' => ['description' => 'The expiration time of custom screen recording files. The default value is 30. Unit: days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + ], + [ + 'name' => 'RemoteCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the Restart button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Restart button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - .'* on: displays the Restart button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n", + 'description' => 'The remote assistance policy for keyboard and mouse control.', + 'enumValueTitles' => ['optionalControl' => 'Disabled by default. Users can request to enable it.', 'fullControl' => 'Full control', 'disableControl' => 'No control'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'fullControl', + 'title' => '', ], ], [ - 'name' => 'MobileShutdown', + 'name' => 'RecordingDuration', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the Stop button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Stop button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - .'* on: displays the Stop button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n", - 'type' => 'string', + 'description' => 'The duration for viewing a screen recording file. Unit: minutes. The recorded files are automatically split into chunks and uploaded to a bucket based on the specified duration. When a file reaches 300 MB, it is overwritten on a rolling basis.', + 'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'], + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => '10', + 'title' => '', ], ], [ - 'name' => 'ResolutionModel', + 'name' => 'Scope', 'in' => 'query', 'schema' => [ - 'description' => 'The resolution type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* adaptive: adaptive resolution.'."\n" - .'* customer: fixed resolution.'."\n", + 'description' => 'The scope of the policy.', + 'enumValueTitles' => ['IP' => 'The policy takes effect based on the IP address.', 'GLOBAL' => 'The policy takes effect globally.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'adaptive' => '', - 'customer' => '', - ], - 'example' => 'adaptive', + 'example' => 'GLOBAL', + 'title' => '', ], ], [ - 'name' => 'ResolutionWidth', + 'name' => 'ScopeValue', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The width of the resolution. Unit: pixel. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The value of the scope. This parameter is valid only when \\`Scope\\` is set to \\`IP\\`.', + 'type' => 'array', + 'items' => ['description' => 'The CIDR block to which the policy applies.', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24', 'title' => ''], 'required' => false, - 'example' => '720', + 'maxItems' => 3, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResolutionHeight', + 'name' => 'RecordingAudio', 'in' => 'query', 'schema' => [ - 'description' => 'The height of the resolution. Unit: pixel. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to record audio from the cloud computer.', + 'enumValueTitles' => ['off' => 'Records only video without audio.', 'on' => 'Records both video and audio.'], + 'type' => 'string', 'required' => false, - 'example' => '1280', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'Taskbar', + 'name' => 'InternetCommunicationProtocol', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the application taskbar.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the application taskbar.'."\n" - .'* on: displays the application taskbar.'."\n", + 'description' => 'The network communication protocol.', + 'enumValueTitles' => ['TCP' => 'Allows only TCP. This is the default value.', 'BOTH' => 'Allows automatic switching between TCP and UDP.'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'BOTH', + 'title' => '', ], ], [ - 'name' => 'NoOperationDisconnect', + 'name' => 'VideoRedirect', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable multimedia redirection.', 'type' => 'string', 'required' => false, 'example' => 'on', 'title' => ''], + ], + [ + 'name' => 'WatermarkTransparencyValue', + 'in' => 'query', + 'schema' => ['description' => 'The transparency of the watermark. A larger value indicates lower transparency. Valid values: 10 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkColor', + 'in' => 'query', + 'schema' => ['description' => 'The font color of the watermark. Valid values: 0 to 16777215.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WatermarkDegree', + 'in' => 'query', + 'schema' => ['description' => 'The angle of the watermark. Valid values: -10 to -30.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontSize', + 'in' => 'query', + 'schema' => ['description' => 'The font size of the watermark. Valid values: 10 to 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WatermarkFontStyle', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enforce a disconnection upon inactivity.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enforce a disconnection upon inactivity.'."\n" - .'* on: enforces a disconnection upon inactivity.'."\n", + 'description' => 'The font style of the watermark.', + 'enumValueTitles' => ['plain' => 'Plain', 'bold' => 'Bold'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'plain', + 'title' => '', ], ], [ - 'name' => 'NoOperationDisconnectTime', + 'name' => 'WatermarkRowAmount', + 'in' => 'query', + 'schema' => ['description' => 'The number of watermark rows.'."\n" + ."\n" + .'> This parameter is not yet available.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'EndUserApplyAdminCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'The duration of disconnection after inactivity. Valid values: 120 to 7200. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Specifies whether to allow users to request assistance from the administrator.', + 'enumValueTitles' => ['off' => 'Off', 'on' => 'On'], + 'type' => 'string', 'required' => false, - 'example' => '120', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'DisconnectKeepSession', + 'name' => 'EndUserGroupCoordinate', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to retain the session upon disconnection.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* customTime: retains the session for a specified time period.'."\n" - .'* persistent: retains the session permanently.'."\n", + 'description' => 'Specifies whether to enable stream collaboration between users.', + 'enumValueTitles' => ['off' => 'Off', 'on' => 'On'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'customTime' => '', - 'persistent' => '', - ], - 'example' => 'customTime', + 'example' => 'on', + 'title' => '', ], ], [ - 'name' => 'DisconnectKeepSessionTime', + 'name' => 'WatermarkSecurity', 'in' => 'query', 'schema' => [ - 'description' => 'The retention period of the session after disconnection. Valid values: 30 to 7200. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The security priority rule for watermarks.', + 'enumValueTitles' => ['off' => 'Disables the rule.', 'on' => 'Enables the rule.'], + 'type' => 'string', 'required' => false, - 'example' => '120', + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'RecordEvents', + 'name' => 'AdminAccess', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether a user has administrative permissions after logging on to the cloud computer.'."\n" + ."\n" + .'> This feature is available only for invitational preview. It is not publicly available.', 'type' => 'string', 'required' => false, 'example' => 'deny', 'title' => ''], + ], + [ + 'name' => 'WatermarkAntiCam', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The events that trigger screen recording.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The event that triggers screen recording.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* transferWithLocal: clipboard and file transfer events.'."\n" - .'* userInput: user input events.'."\n" - .'* usbRedirect: USB connection and disconnection events.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'transferWithLocal' => '', - 'userInput' => '', - 'usbRedirect' => '', - ], - 'example' => 'transferWithLocal', - ], + 'description' => 'Specifies whether to enable the screen capture prevention watermark feature.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], + 'type' => 'string', 'required' => false, - 'maxItems' => 100, + 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'RecordEventFilePaths', + 'name' => 'WatermarkPower', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The absolute paths to screen recording files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'C://test.txt', - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'RecordEventRegisters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The absolute paths to screen recording registries.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording registry.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - [ - 'name' => 'RecordEventDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of screen recording after the specified event is detected. Unit: minutes. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'ResetDesktop', - 'in' => 'query', - 'schema' => [ - 'description' => 'The computer reset setting.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables the reset setting.'."\n" - .'* on: enables the reset setting.'."\n", + 'description' => 'The strength of the blind watermark.', + 'enumValueTitles' => ['high' => 'High', 'low' => 'Low', 'medium' => 'Medium'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'medium', + 'title' => '', ], ], [ - 'name' => 'DeviceConnectHint', + 'name' => 'RecordingUserNotify', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the peripheral connection prompt.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the peripheral connection prompt.'."\n" - .'* on: displays the peripheral connection prompt.'."\n", + 'description' => 'Specifies whether to send a notification to the client when a screen recording starts.', + 'enumValueTitles' => ['off' => 'Disabled', 'on' => 'Enabled'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], 'example' => 'off', + 'title' => '', ], ], [ - 'name' => 'FileMigrate', + 'name' => 'RecordingUserNotifyMessage', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable file transfer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: enables file transfer.'."\n" - .'* on: disables file transfer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The content of the screen recording notification. This parameter is optional.', 'type' => 'string', 'example' => 'Your cloud desktop is being recorded.', 'required' => false, 'title' => ''], ], [ - 'name' => 'WuyingKeeper', + 'name' => 'MaxReconnectTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Cloud Computer Manager.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables Cloud Computer Manager.'."\n" - .'* on: enables Cloud Computer Manager.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The maximum amount of time that the client can attempt to reconnect to the cloud computer after an unexpected disconnection. Valid values: 30 to 7200. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], ], [ - 'name' => 'InternetPrinter', + 'name' => 'DeviceRedirects', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The device redirection rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The device redirection rule.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => [ + 'description' => 'The type of peripheral device.', + 'enumValueTitles' => ['printer' => 'Printer', 'scanner' => 'Scanner', 'camera' => 'Camera', 'adb' => 'Android device'], + 'type' => 'string', + 'required' => false, + 'example' => 'camera', + 'title' => '', + ], + 'RedirectType' => [ + 'description' => 'The redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Disable redirection'], + 'type' => 'string', + 'required' => false, + 'example' => 'usbRedirect', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SafeMenu', + 'name' => 'DeviceRules', 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The custom peripheral device rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The custom peripheral device rule.', + 'type' => 'object', + 'properties' => [ + 'DeviceType' => [ + 'description' => 'The type of peripheral device.', + 'enumValueTitles' => ['usbKey' => 'UKey', 'other' => 'Other', 'graphicsTablet' => 'Graphics tablet', 'printer' => 'Printer', 'cardReader' => 'Card reader', 'scanner' => 'Scanner', 'storage' => 'Storage device', 'camera' => 'Camera', 'adb' => 'Android device', 'networkInterfaceCard' => 'Network interface controller (NIC)'], + 'type' => 'string', + 'required' => false, + 'example' => 'storage', + 'title' => '', + ], + 'DeviceName' => ['description' => 'The name of the device.', 'type' => 'string', 'required' => false, 'example' => 'sandisk', 'title' => ''], + 'DevicePid' => ['description' => 'The product ID (PID).', 'type' => 'string', 'required' => false, 'example' => '0x0781', 'title' => ''], + 'DeviceVid' => ['description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf).', 'type' => 'string', 'required' => false, 'example' => '0x55b1', 'title' => ''], + 'RedirectType' => [ + 'description' => 'The redirection type.', + 'enumValueTitles' => ['deviceRedirect' => 'Device redirection', 'usbRedirect' => 'USB redirection', 'off' => 'Disabled'], + 'type' => 'string', + 'required' => false, + 'example' => 'usbRedirect', + 'title' => '', + ], + 'OptCommand' => ['description' => 'The link optimization command.', 'type' => 'string', 'required' => false, 'example' => '2:0', 'title' => ''], + 'Platforms' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ScreenDisplayMode', + 'name' => 'WyAssistant', 'in' => 'query', 'schema' => [ + 'description' => 'Specifies whether to display the entry for Alibaba Cloud AI Assistant in the floating bar of the cloud computer.', + 'enumValueTitles' => ['off' => 'Hides the entry for Alibaba Cloud AI Assistant.', 'on' => 'Displays the entry for Alibaba Cloud AI Assistant.'], 'type' => 'string', + 'required' => false, + 'example' => 'on', + 'title' => '', ], ], - [ - 'name' => 'ClientControlMenu', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'FileTransferSpeedLocation', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ModifyPolicyGroup', + 'changeSet' => [ + ['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-14T04:04:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T02:54:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-31T09:50:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-22T01:55:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-07T06:02:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPolicyGroup'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyPolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'machine', + ], + 'ModifyQosEntries' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileTransferSpeed', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'FileTransferAddress', + 'name' => 'QosRuleId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the QoS rule.', 'type' => 'string', 'required' => true, 'example' => 'qos-5605u0gelk200****', 'title' => ''], ], [ - 'name' => 'CpdDriveClipboard', + 'name' => 'AuthDesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud desktops to bind to the QoS rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'UseTime', + 'name' => 'RevokeDesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud desktops to unbind from the QoS rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AutoReconnect', + 'name' => 'AuthAndroidId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '断连后自动重连', - 'type' => 'string', - 'example' => 'off', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud phone.', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud phones to bind to the QoS rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MobileWuyingKeeper', + 'name' => 'RevokeAndroidId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '移动端无影管家开关', - 'type' => 'string', - 'example' => 'off', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud phone.', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The IDs of the cloud phones to unbind from the QoS rule.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MobileSafeMenu', + 'name' => 'AuthDesktopGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '移动端Windows系统的安全按钮开关', - 'type' => 'string', - 'example' => 'off', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MobileWyAssistant', + 'name' => 'RevokeDesktopGroupId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '移动端小颖开关', - 'type' => 'string', - 'example' => 'off', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecordEventLevels', - 'in' => 'query', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '录屏事件的等级', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'title' => '事件类型', - 'type' => 'string', - 'example' => 'StartApplication', - ], - 'EventLevel' => [ - 'title' => '事件等级', - 'type' => 'string', - 'example' => 'HIGH', - ], - ], + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'maxItems' => 20, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyQosEntries', + 'summary' => 'Modifies the resource bindings of a QoS rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RecordEventFileExts', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '录屏事件后缀', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'txt', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyQosEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'maxItems' => 6, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyQosRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExternalDrive', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'WatermarkShadow', + 'name' => 'QosRuleId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the QoS rule.', 'type' => 'string', 'required' => true, 'example' => 'qos-5605u0gelk200****', 'title' => ''], ], [ - 'name' => 'ClientCreateSnapshot', + 'name' => 'QosRuleName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the QoS rule.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'AcademicProxy', + 'name' => 'Upload', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The maximum upstream bandwidth. The unit is Mbps.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ModelLibrary', + 'name' => 'Download', 'in' => 'query', + 'schema' => ['description' => 'The maximum downstream bandwidth. The unit is Mbps.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyQosRule', + 'summary' => 'You can modify a rate limiting rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PortProxy', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyQosRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyResourceCenterPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'MemoryOverload', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- app: cloud applications.'."\n" + ."\n" + .'- desktop: cloud computers.', + 'enumValueTitles' => ['app' => '', 'desktop' => ''], 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'CpuOverload', + 'name' => 'ResourceIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The resource IDs. You can specify up to 100 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-00001', 'title' => ''], + 'required' => true, + 'docRequired' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DiskOverload', + 'name' => 'ResourceRegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResolutionDpi', + 'name' => 'ProductType', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '400', - 'minimum' => '25', + 'description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- app: cloud applications.'."\n" + ."\n" + .'- resourceGroup: resource groups.'."\n" + ."\n" + .'- desktop: cloud computers.'."\n" + ."\n" + .'- desktopGroup: cloud computer shares.', + 'enumValueTitles' => ['app' => '', 'resourceGroup' => '', 'desktop' => '', 'desktopGroup' => ''], + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'desktop', + 'title' => '', ], ], [ - 'name' => 'HoverConfigMsg', + 'name' => 'PolicyGroupType', 'in' => 'query', 'schema' => [ + 'description' => 'The policy type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- general: a general policy.', + 'enumValueTitles' => ['general' => ''], 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'general', + 'title' => '', ], ], [ - 'name' => 'MultiScreen', + 'name' => 'PolicyGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The IDs of the cloud computer policies that you want to associate with cloud computers.'."\n" + ."\n" + .'> You can specify up to one cloud computer policy that takes effect globally, and up to four cloud computer policies that apply to specific IP addresses. If multiple cloud computer policies are configured for global enforcement, only the earliest-associated policy will take effect', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****', 'title' => ''], + 'required' => true, + 'docRequired' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '5CED7F18-43B1-5035-BBB6-2538B***', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'ModifyResults' => [ + 'description' => 'The modification results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The modification result.', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'ecd-e254cpyt9bb*****', 'title' => ''], + 'CheckResult' => ['description' => 'The verification result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CED7F18-43B1-5035-BBB6-2538B***\\"\\n}","type":"json"}]', - 'title' => 'ModifyCenterPolicy', - ], - 'DescribeResourceByCenterPolicyId' => [ - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'ModifyResourceCenterPolicy', + 'summary' => 'Modifies a global policy that is associated with a cloud resource.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ModifyResourceCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"ResourceId\\": \\"ecd-e254cpyt9bb*****\\",\\n \\"CheckResult\\": true\\n }\\n ]\\n}","type":"json"}]', + ], + 'ModifyTemplate' => [ + 'summary' => 'Modifies all parameters of a custom WUYING Workspace template.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'pg-53iyi2aar0nd6****', - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b-0caoeogs88y*****'], ], [ - 'name' => 'ProductType', - 'in' => 'query', + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the template. The name must meet the following requirements:'."\n" + ."\n" + .'- It must be 2 to 126 characters in length.'."\n" + ."\n" + .'- It must start with a letter or a Chinese character. It cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- It can contain letters, digits, Chinese characters, colons (:), underscores (\\_), and hyphens (-). It cannot contain periods (.).', 'type' => 'string', 'example' => 'My cloud desktop template 001', 'required' => false, 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the template. The description must meet the following requirements:'."\n" + ."\n" + .'- It must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.'."\n" + ."\n" + .'- It can contain Chinese characters, letters, digits, spaces, and special characters. Use line breaks to start a new line.', 'type' => 'string', 'maxLength' => 256, 'minLength' => 2, 'required' => false, 'example' => 'testDescription', 'title' => ''], + ], + [ + 'name' => 'SystemDiskSize', + 'in' => 'formData', + 'schema' => ['description' => 'The size of the system disk. Unit: GiB. The value must be between 40 and 500, inclusive. The step size is 10 GiB.'."\n" + ."\n" + .'> The system disk size cannot be smaller than the size of the image.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2040', 'minimum' => '40', 'title' => '', 'example' => '80'], + ], + [ + 'name' => 'SystemDiskPerformanceLevel', + 'in' => 'formData', 'schema' => [ - 'description' => 'The service type.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The type of the system disk.'."\n" ."\n" - .'* app: cloud applications.'."\n" - .'* resourceGroup: resource groups.'."\n" - .'* desktop: cloud computers.'."\n" - .'* desktopGroup: cloud computer shares.'."\n", + .'> Enhanced SSD (ESSD) disks are supported only by cloud computers with high clock speeds and powerful graphics capabilities.', + 'enumValueTitles' => ['PL1' => 'An ESSD cloud disk at performance level 1.', 'PL0' => 'An ESSD cloud disk at performance level 0.', 'AutoPL' => 'An ESSD cloud disk that automatically adjusts its performance level.'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'app' => '', - 'resourceGroup' => '', - 'desktop' => '', - 'desktopGroup' => '', - ], - 'example' => 'desktop', + 'example' => 'AutoPL', ], ], [ - 'name' => 'MaxResults', - 'in' => 'query', + 'name' => 'DataDiskList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 100.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => ['description' => 'The size of the data disk. Unit: GiB. The value must be between 40 and 2040, inclusive. The step size is 10 GiB.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2040', 'minimum' => '0', 'required' => false, 'example' => '40', 'title' => ''], + 'PerformanceLevel' => [ + 'description' => 'The performance level of the data disk. The default value is `AutoPL`.', + 'enumValueTitles' => ['PL1' => 'ESSD PL1', 'PL0' => 'ESSD PL0', 'AutoPL' => 'ESSD AutoPL'], + 'type' => 'string', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10', + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l69tQX7yFxx6/4dbooBAOc', - ], + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the WUYING Workspace image. You can find the ID on the Image Management page. OS images and custom images are supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'm-gx2x1dhsmusr2****'], ], [ - 'name' => 'ResourceId', - 'in' => 'query', + 'name' => 'PolicyGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the global policy.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'], + ], + [ + 'name' => 'DefaultLanguage', + 'in' => 'formData', 'schema' => [ - 'description' => 'The resource ID.'."\n", + 'description' => 'The default language to set when the WUYING Workspace starts. This parameter is valid only when you create a WUYING Workspace from an OS image.', + 'enumValueTitles' => ['en-US' => 'English', 'zh-HK' => 'Traditional Chinese (Hong Kong)', 'zh-CN' => 'Simplified Chinese', 'ja-JP' => 'Japanese'], 'type' => 'string', + 'title' => '', 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', + 'example' => 'zh-CN', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****', + [ + 'name' => 'TimerGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the configuration group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'bcc-dweha*****'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-a5fqjjqaejt***', 'title' => ''], + ], + [ + 'name' => 'ResourceTagList', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'Tags for the cloud computer, in key-value format. You can specify up to 20 tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'design', 'title' => ''], ], - 'ResourceModelList' => [ - 'description' => 'The resources.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The resource status.'."\n", - 'type' => 'string', - 'example' => 'Stopped', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'ResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'desktop', - ], - 'ProductType' => [ - 'description' => 'The service type.'."\n", - 'type' => 'string', - 'example' => 'desktop', - ], - 'OsType' => [ - 'description' => 'The OS type.'."\n", - 'type' => 'string', - 'example' => 'Linux', - ], - 'GpuCount' => [ - 'description' => 'The number of GPUs.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '0.125', - ], - 'Memory' => [ - 'description' => 'The memory size. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10240', - ], - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-7o96aa08fr****', - ], - 'ResourceName' => [ - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n", - 'type' => 'string', - 'example' => 'ASP', - ], - 'DesktopType' => [ - 'description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of the cloud computer types supported by Alibaba Cloud Workspace.'."\n", - 'type' => 'string', - 'example' => 'eds.enterprise_office.8c32g', - ], - 'PayType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'postPaid', - ], - 'GpuSpec' => [ - 'description' => 'The GPU type.'."\n", - 'type' => 'string', - 'example' => '2GiB', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-d7pasxsd3b9nhq**', - ], - 'ResourceGroupName' => [ - 'description' => 'The resource group name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ResourceGroupRelCount' => [ - 'description' => 'The number of associated resource groups'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'AppModelList' => [ - 'description' => 'The cloud applications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppId' => [ - 'description' => 'The application ID. This parameter is only applicable to cloud applications.'."\n", - 'type' => 'string', - 'example' => '18', - ], - 'AppName' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'alipic-powergem', - ], - ], - 'description' => '', - ], - ], - 'ResourceRegionId' => [ - 'description' => 'The region ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - ], - 'description' => '', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'RegionConfigList', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The region-specific template configurations. You can specify configurations for multiple regions. The system matches the configuration based on the specific region.'."\n" + ."\n" + .'> You can specify configurations for up to 20 regions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID. You can call [DescribeRegions](~~DescribeRegions~~) to obtain a list of regions that WUYING Workspace supports.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + 'SnapshotPolicyId' => ['description' => 'The ID of the automatic snapshot policy.', 'type' => 'string', 'required' => false, 'example' => 'sp-35fvn8m2*****', 'title' => ''], + 'ResourceInstanceType' => ['description' => 'The ID of the cloud desktop instance type.', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g', 'title' => ''], + 'VolumeEncryptionEnable' => [ + 'description' => 'Specifies whether to enable disk encryption.', + 'enumValueTitles' => ['false' => 'Disables disk encryption. \\[Default]', 'true' => 'Enables disk encryption.'], + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'title' => '', ], + 'VolumeEncryptionKey' => ['description' => 'The ID of the KMS key to use when disk encryption is enabled.', 'type' => 'string', 'required' => false, 'example' => 'a7b3c0c8-b3a2-4876-b1cc-116dddc9****', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-709****', 'title' => ''], + 'SubnetId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'vsw-adjrehad1****', 'title' => ''], ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Count' => [ - 'description' => 'The total number of resources.'."\n", - 'type' => 'string', - 'example' => '2', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SiteConfigList', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SiteId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'AppRuleId' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ChargeType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'enum' => ['PostPaid', 'PrePaid'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'maximum' => '6', 'minimum' => '1', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PeriodUnit', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'enum' => ['Month', 'Year', 'Week'], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AutoPay', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserDuration', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['120', '250', '360'], 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PostPaidAfterUsedUp', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48174475-5EB2-5F99-A9E9-6F892D645****\\",\\n \\"ResourceModelList\\": [\\n {\\n \\"Status\\": \\"Stopped\\",\\n \\"Cpu\\": 64,\\n \\"ResourceType\\": \\"desktop\\",\\n \\"ProductType\\": \\"desktop\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"GpuCount\\": 0.125,\\n \\"Memory\\": 10240,\\n \\"ResourceId\\": \\"ecd-7o96aa08fr****\\",\\n \\"ResourceName\\": \\"运维\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.8c32g\\",\\n \\"PayType\\": \\"postPaid\\",\\n \\"GpuSpec\\": \\"2GiB\\",\\n \\"ResourceGroupId\\": \\"rg-d7pasxsd3b9nhq**\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"ResourceGroupRelCount\\": 10,\\n \\"AppModelList\\": [\\n {\\n \\"AppId\\": \\"18\\",\\n \\"AppName\\": \\"alipic-powergem\\"\\n }\\n ],\\n \\"ResourceRegionId\\": \\"cn-shenzhen\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": \\"2\\"\\n}","type":"json"}]', - 'title' => 'DescribeResourceByCenterPolicyId', - 'summary' => 'Queries cloud resources that are associated with a global policy.', - ], - 'DescribeCenterPolicyList' => [ - 'summary' => 'Queries center policies.', - 'methods' => [ - 'post', - 'get', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The result of the operation. A value of `success` indicates that the operation was successful. Otherwise, an error message is returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is not returned if the value of Code is `success`.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ModifyTemplate', + 'description' => '>'."\n" + ."\n" + .'This operation updates all parameters. To ensure compatibility with the default upgrade logic, any parameter that you do not specify is set to empty.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-12-25T06:33:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-05T10:16:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ModifyTemplateBaseInfo' => [ + 'summary' => 'Modifies the basic information of a custom cloud computer template, including the template name and template description.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '259955', - 'abilityTreeNodes' => [ - 'FEATUREgwsN6S2WW', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'b-0caoeogs88y*****'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The template name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Shanghai template1', 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The template description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is description.', 'maxLength' => 256, 'minLength' => 2], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['description' => 'The execution result of the operation. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is not returned if the value of Code is `success`.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '3D99C38F-DE7D-5109-BC06-43EC5D*****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"3D99C38F-DE7D-5109-BC06-43EC5D*****\\"\\n}","type":"json"}]', + 'title' => 'ModifyTemplateBaseInfo', + 'description' => 'This operation allows you to modify only the name and description of a custom cloud computer template. To change other parameters of the template, call the [ModifyTemplate](~~2925841~~) operation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyTemplateBaseInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ModifyTimerGroup' => [ + 'summary' => 'Modify configuration group settings, such as those for scheduled tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. This feature is not tied to a specific region, but you must set this parameter to `cn-shanghai`.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], + [ + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The configuration group ID.', 'type' => 'string', 'required' => true, 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + [ + 'name' => 'ConfigTimers', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The page number.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The scheduled task configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'A scheduled task configuration.', + 'type' => 'object', + 'properties' => [ + 'TimerType' => [ + 'description' => 'The type of the scheduled task.', + 'enumValueTitles' => ['NoOperationDisconnect' => 'Disconnects the session due to inactivity.', 'NoConnect' => 'A task that is triggered when a desktop remains disconnected. You must also specify the `OperationType` parameter.', 'TimerBoot' => 'Starts the desktop on a schedule.', 'TimerReset' => 'Resets the desktop on a schedule.', 'NoOperationShutdown' => 'Shuts down the desktop due to inactivity.', 'NoOperationHibernate' => 'Hibernates the desktop due to inactivity.', 'TimerShutdown' => 'Shuts down the desktop on a schedule.', 'NoOperationReboot' => 'Reboots the desktop due to inactivity.', 'TimerReboot' => 'Reboots the desktop on a schedule.'], + 'type' => 'string', + 'required' => false, + 'example' => 'TimerBoot', + 'title' => '', + ], + 'CronExpression' => ['description' => 'The Cron expression for the scheduled task.'."\n" + ."\n" + .'> The Cron expression must be in UTC. For example, to schedule a task for 00:00 daily in China Standard Time (UTC+8), set this parameter to `0 0 16 ? * 1,2,3,4,5,6,7`.', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n", 'title' => ''], + 'Interval' => ['description' => 'The interval, in minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'Enforce' => ['description' => 'Specifies whether to force execution. If this parameter is set to `true`, the scheduled task runs regardless of the desktop and connection status.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'ResetType' => [ + 'description' => 'Specifies which disks to reset.', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => 'Resets the system disk.', 'RESET_TYPE_USER_DISK' => 'Resets the data disk.', 'RESET_TYPE_BOTH' => 'Resets both the system disk and the data disk.'], + 'type' => 'string', + 'required' => false, + 'example' => 'RESET_TYPE_SYSTEM', + 'title' => '', + ], + 'AllowClientSetting' => ['description' => 'Specifies whether to allow end users to configure scheduled tasks.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'OperationType' => [ + 'description' => 'The operation to perform. This parameter applies only if `TimerType` is set to `NoConnect`.', + 'enumValueTitles' => ['Hibernate' => 'Hibernates the desktop.', 'Shutdown' => 'Shuts down the desktop.'], + 'type' => 'string', + 'required' => false, + 'example' => 'Shutdown', + 'title' => '', + ], + 'TriggerType' => [ + 'description' => 'The method for detecting inactivity.', + 'enumValueTitles' => ['Advanced' => 'Advanced detection.', 'Standard' => 'Standard detection.'], + 'type' => 'string', + 'required' => false, + 'example' => 'Standard', + 'title' => '', + ], + 'ProcessWhitelist' => [ + 'description' => 'The process whitelist for advanced inactivity detection. The scheduled task is not triggered if a process from this list is running.', + 'type' => 'array', + 'items' => ['description' => 'The process name.', 'type' => 'string', 'required' => false, 'example' => 'chrome', 'title' => ''], + 'required' => false, + 'maxItems' => 30, + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'SegmentTimers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'StartCronExpression' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'EndCronExpression' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Interval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'TriggerType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ProcessWhitelist' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 30, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Timezone' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'Enforce' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ResetType' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + 'ImageId' => ['title' => '', 'description' => 'Image ID for image-change scheduled tasks.', 'type' => 'string', 'example' => 'm-5b0vjqbiqu010XXXXXX', 'required' => false], + 'LockScreenTime' => ['title' => '', 'description' => 'Lock screen time for inactivity-based lock screen. Not supported for non-AD desktops.', 'type' => 'integer', 'format' => 'int32', 'example' => '1800', 'required' => false], + 'AppointmentTimer' => ['title' => '', 'description' => 'Timestamp for scheduled task execution. The task runs at the specified time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1764660600967', 'required' => false], + 'VerificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'IpSegments' => [ + 'type' => 'array', + 'items' => ['type' => 'string'], + 'maxItems' => 10, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the configuration group.', 'type' => 'string', 'example' => 'Scheduled task', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => 'The description of the configuration group.', 'type' => 'string', 'example' => 'Scheduled task', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + 'title' => '', + 'description' => 'Response schema', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'GroupId' => ['description' => 'The ID of the configuration group.', 'type' => 'string', 'example' => 'cg-i1ruuudp92qpj****', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'OperationTooFrequent', 'errorMessage' => 'The operation is too frequent, please try again later.', 'description' => 'Operation is too frequent, please try again later'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"GroupId\\": \\"cg-i1ruuudp92qpj****\\"\\n}","type":"json"}]', + 'title' => 'Modify Configuration Group Settings ', + 'changeSet' => [ + ['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-22T12:24:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-11T10:01:34.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2025-05-26T02:20:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ModifyUserEntitlement' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'PolicyGroupId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'EndUserId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computer policies.'."\n", + 'description' => 'The ID of the users.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-53iyi2aar0nd6****', - ], + 'items' => ['description' => 'The ID of the user.', 'type' => 'string', 'required' => false, 'example' => 'Alice', 'title' => ''], 'required' => false, + 'docRequired' => true, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Scope', + 'name' => 'AuthorizeDesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The effective scope of the cloud computer policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy applies to specific IP addresses.'."\n" - .'* GLOBAL: The policy applies globally.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computers to which you want to add end users.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer to which you want to add end users.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'GLOBAL', + 'docRequired' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BusinessType', + 'name' => 'RevokeDesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The business type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: public cloud'."\n" - .'* 8: commercial edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - 8 => '', + 'description' => 'The IDs of the cloud computers whose end users you want to remove.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a cloud computer whose end users you want to remove.', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****', 'title' => ''], + 'required' => false, + 'docRequired' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => '1', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ModifyUserEntitlement', + 'summary' => 'Grants permissions on cloud desktops to end users, or revokes the permissions from the end users.', + 'description' => 'You can modify end users only for cloud computers that are in the Running state.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserEntitlement'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyUserEntitlement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'desktop', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ModifyUserToDesktopGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PortProxy', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ModelLibrary', + 'name' => 'DesktopGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud computer share.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], + ], + [ + 'name' => 'OldEndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The IDs of the end users that you want to remove. You can configure 1 to 500 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of an end user that you want to remove.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], + 'required' => true, + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AcademicProxy', + 'name' => 'NewEndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The IDs of the end users that you want to add. You can configure 1 to 500 IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of an end user that you want to add.'."\n", 'type' => 'string', 'required' => false, 'example' => 'jack', 'title' => ''], + 'required' => true, + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'DescribePolicyGroups' => [ - 'description' => 'The details about the cloud computer policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about the cloud computer policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'PolicyStatus' => [ - 'description' => 'The status of the cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'AVAILABLE', - ], - 'Html5Access' => [ - 'description' => 'The web client access policy.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'WatermarkType' => [ - 'description' => 'The watermark type.'."\n", - 'type' => 'string', - 'example' => 'EndUserId', - ], - 'WatermarkCustomText' => [ - 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n", - 'type' => 'string', - 'example' => 'custom-watermark', - ], - 'Clipboard' => [ - 'description' => 'The read/write permissions on the clipboard.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'PolicyGroupId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'PrinterRedirection' => [ - 'description' => 'The printer redirection policy.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'Html5FileTransfer' => [ - 'description' => 'The file transfer feature on the web client.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'UsbRedirect' => [ - 'description' => 'The USB redirection policy.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'PolicyGroupType' => [ - 'description' => 'The type of the policy.'."\n", - 'type' => 'string', - 'example' => 'SYSTEM', - ], - 'Watermark' => [ - 'description' => 'The watermark policy.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'VisualQuality' => [ - 'description' => 'The image quality policy.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'Name' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'example' => 'testPolicyGroupName', - ], - 'LocalDrive' => [ - 'description' => 'The read/write permissions on the on-premises drive.'."\n", - 'type' => 'string', - 'example' => 'readwrite', - ], - 'AuthorizeSecurityPolicyRules' => [ - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n", - 'type' => 'string', - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization policy of the security group rule.'."\n", - 'type' => 'string', - 'example' => 'accept', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule.'."\n", - 'type' => 'string', - 'example' => '22/22', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n", - 'type' => 'string', - 'example' => 'tcp', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value indicates a higher priority.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object to which the security group rule applies. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/16', - ], - ], - ], - ], - 'AuthorizeAccessPolicyRules' => [ - 'description' => 'The client IP address whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The remarks on the client CIDR block.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block from which end users can connect to cloud computers. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/16', - ], - ], - ], - ], - 'ClientTypes' => [ - 'description' => 'The logon method control rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The logon method control rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether a specific client type can connect to cloud computers.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'ClientType' => [ - 'description' => 'The client type.'."\n", - 'type' => 'string', - 'example' => 'windows', - ], - ], - ], - ], - 'GpuAcceleration' => [ - 'description' => 'Indicates whether image quality control is enabled. For optimal computer performance and user experience in professional design scenarios, we recommend enabling this feature.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'UsbSupplyRedirectRule' => [ - 'description' => 'The USB redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The USB redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'VendorId' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'example' => '04**', - ], - 'ProductId' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'example' => '08**', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'UsbRedirectType' => [ - 'description' => 'Indicates whether USB redirection is allowed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - 'DomainResolveRuleType' => [ - 'description' => 'Indicates whether domain name resolution is allowed.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'DomainResolveRule' => [ - 'description' => 'The domain resolution policies.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CFC74699-6F9C-5437-861A-D186E3347B7E\\n","errorExample":""}]', + 'title' => 'ModifyUserToDesktopGroup', + 'summary' => 'Replaces the existing authorized users of a cloud computer share with different users', + 'changeSet' => [ + ['createdAt' => '2022-03-23T11:44:45.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-03-23T11:44:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserToDesktopGroup'], + ], + ], + 'ramActions' => [], + ], + 'MoveCdsFile' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cloud disk.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-346063****', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the file.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63f3257b68b018170b194d87b875512d108f****', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID that you want to use to access the cloud disk.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user01', 'title' => ''], + ], + [ + 'name' => 'ParentFolderId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent folder that you want to move. If you want to remove the root folder, set the value to root.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '6409848a6da91d6240604e7ba7337d85ba8a1****', 'title' => ''], + ], + [ + 'name' => 'ConflictPolicy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The processing mode of files that have the same name.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* '."\n" + ."\n" + .' refuse'."\n" + ."\n" + .' '."\n" + ."\n" + .' : If you want to create a file that uses the same name as an existing file in the cloud, the system denies your request and returns the details of the existing file.'."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' auto_rename'."\n" + ."\n" + .' '."\n" + ."\n" + .' : If you want to create a file that uses the same name as an existing file in the cloud, the system renames the file that you want to create by appending the current time point.'."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' ignore'."\n" + ."\n" + .' '."\n" + ."\n" + .' : The system allows you to create a file that uses the same name as an existing file in the cloud.'."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' over_write'."\n" + ."\n" + .' '."\n" + ."\n" + .' : After you create a file that uses the same name as an existing file in the cloud, the new file overwrites the existing file.'."\n" + ."\n" + .' '."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => ['refuse' => '', 'auto_rename' => '', 'ignore' => '', 'over_write' => ''], + 'example' => 'ignore', + 'title' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The group ID.', 'example' => 'cg-hvyou5jbob3b0****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Success' => [ + 'description' => 'Indicates whether the request is successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* '."\n" + ."\n" + .' true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], + 'Code' => ['description' => 'The result of the modification. A value of success indicates that the modification is successful. If the modification failed, an error message is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned. This parameter is not returned if the value of Code is success.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'MoveCdsFileModel' => [ + 'description' => 'The response object when you move a file.'."\n", + 'type' => 'object', + 'properties' => [ + 'AsyncTaskId' => ['description' => 'The ID of the asynchronous task. This parameter is not returned if you copy files. This parameter is returned if you copy folders in the backend in an asynchronous manner. You can call the GetAsyncTask operation to obtain the ID and details of an asynchronous task.'."\n", 'type' => 'string', 'example' => 'fe307518-825a-4c8b-a69c-958f0e8a****', 'title' => ''], + 'Exist' => [ + 'description' => 'Indicates whether the file exists.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* '."\n" + ."\n" + .' true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* '."\n" + ."\n" + .' false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'false', + 'title' => '', + ], + 'FileId' => ['description' => 'The ID of the file.'."\n", 'type' => 'string', 'example' => '63636837e47e5a24a8a940218bef395c210e****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'MoveCdsFile', + 'summary' => 'Move files or folders.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MoveCdsFile'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"MoveCdsFileModel\\": {\\n \\"AsyncTaskId\\": \\"fe307518-825a-4c8b-a69c-958f0e8a****\\",\\n \\"Exist\\": false,\\n \\"FileId\\": \\"63636837e47e5a24a8a940218bef395c210e****\\"\\n }\\n}","type":"json"}]', + ], + 'QueryHistoryActiveUserCount' => [ + 'summary' => 'Queries the historical daily and monthly active user counts for a specified date.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'DataDate', + 'in' => 'query', + 'schema' => ['description' => 'The date for which to query data, in YYYY-MM-DD format. Default: the previous day (T-1).', 'type' => 'string', 'required' => false, 'example' => '2023-01-01', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1234567890abcdefg'], + 'ActiveUserCount' => [ + 'type' => 'object', + 'properties' => [ + 'DailyActiveUserCount' => ['description' => 'The number of daily active users.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'MonthlyActiveUserCount' => ['description' => 'The number of monthly active users.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + ], + 'description' => 'The active user statistics.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The container for the response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryHistoryActiveUserCount', + 'description' => '## Usage notes'."\n" + ."\n" + .'- The `AliUid` parameter is automatically resolved from your AccessKey pair and does not need to be specified in the request.'."\n" + ."\n" + .'- The `BusinessChannel` parameter defaults to Enterprise Edition, but you can select other business channels.'."\n" + ."\n" + .'- By default, the query returns data for the previous day (T-1). To query for a different day, use the `DataDate` parameter in YYYY-MM-DD format.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890abcdefg\\",\\n \\"ActiveUserCount\\": {\\n \\"DailyActiveUserCount\\": 20,\\n \\"MonthlyActiveUserCount\\": 300\\n }\\n}","type":"json"}]', + ], + 'QueryHistoryAvgMetricList' => [ + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The metric to query.', + 'enumValueTitles' => ['LOAD_SCORE' => 'Health score', 'GPU_USAGE' => 'GPU usage', 'CPU_TOTAL_USAGE' => 'CPU usage', 'MEMORY_USAGE' => 'Memory usage', 'ROUND_TRIP_TIME' => 'End-to-end latency', 'TOTAL_DISK_USAGE' => 'Disk usage'], + 'type' => 'string', + 'required' => false, + 'example' => 'LOAD_SCORE', + 'title' => '', + ], + ], + [ + 'name' => 'DataDate', + 'in' => 'query', + 'schema' => ['description' => 'The start date of the statistics. The format is `YYYY-MM-DD`. The default value is T-1.', 'type' => 'string', 'required' => false, 'example' => '2026-04-01', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-2h7u3ymhm33qy****', 'title' => ''], + 'maxItems' => 100, + 'description' => 'The desktop ID list. A maximum of 100 IDs are supported.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The desktop region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Range', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The range label, which is used for the return value.', 'type' => 'string', 'required' => false, 'example' => 'label-02\'', 'title' => ''], + 'Min' => ['description' => 'The minimum value.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], + 'IncludeMin' => ['description' => 'Specifies whether to include the minimum value. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Max' => ['description' => 'The maximum value.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20', 'title' => ''], + 'IncludeMax' => ['description' => 'Specifies whether to include the maximum value. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'description' => 'The list of custom numeric ranges.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method.', + 'enumValueTitles' => ['ASC' => 'Ascending', 'DESC' => 'Descending'], + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + 'title' => '', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number, which must be greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. Valid values: 1 to 200. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '100', 'required' => false, 'example' => '20', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC2****'], + 'AvgMetricList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DesktopId' => ['description' => '**The desktop ID.**', 'type' => 'string', 'example' => 'ecd-bx9i0nsjd3zmibnzq', 'title' => ''], + 'DesktopName' => ['description' => '**The desktop name.**', 'type' => 'string', 'example' => 'C-051', 'title' => ''], + 'DesktopGroupId' => ['description' => 'The desktop group ID.', 'type' => 'string', 'example' => 'dg-bogo95eob5avnis9k', 'title' => ''], + 'MultiResource' => ['description' => 'Whether the desktop is a multi-user shared desktop.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DesktopStatus' => ['description' => 'The status of the desktop. Valid values:'."\n" + ."\n" + .'- `Stopped`: The desktop is stopped.'."\n" + ."\n" + .'- `Starting`: The desktop is being started.'."\n" + ."\n" + .'- `Rebuilding`: The desktop is being rebuilt.'."\n" + ."\n" + .'- `Running`: The desktop is running.'."\n" + ."\n" + .'- `Stopping`: The desktop is being stopped.'."\n" + ."\n" + .'- `Expired`: The desktop has expired.'."\n" + ."\n" + .'- `Deleted`: The desktop has been deleted.'."\n" + ."\n" + .'- `Pending`: The desktop is in a pending state.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'ManagementFlag' => ['description' => 'The management flag.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method of the desktop. Valid values:'."\n" + ."\n" + .'- `PostPaid`: pay-as-you-go'."\n" + ."\n" + .'- `PrePaid`: subscription'."\n" + ."\n" + .'Default value: `PostPaid`.', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], + 'DesktopType' => ['description' => 'The desktop type.', 'type' => 'string', 'example' => 'eds.enterprise_office.8c16g', 'title' => ''], + 'Platform' => ['description' => 'The type of the system image.', 'type' => 'string', 'example' => 'Winserver2025', 'title' => ''], + 'SubPayType' => ['description' => 'The payment type.', 'type' => 'string', 'example' => 'monthPackage', 'title' => ''], + 'AvgValue' => ['description' => 'The aggregated metric value.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'Cpu' => ['description' => 'The number of vCPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'GpuSpec' => ['description' => 'The GPU memory size.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Memory' => ['description' => 'The memory size, in MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '2048', 'title' => ''], + 'EndUserIds' => [ 'type' => 'array', - 'items' => [ - 'description' => 'The domain resolution policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => '*.example.com', - ], - 'Policy' => [ - 'description' => 'The resolution policy.'."\n", - 'type' => 'string', - 'example' => 'allow', - ], - 'Description' => [ - 'description' => 'The policy description.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], + 'items' => ['description' => 'The ID of an authorized end user.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'description' => 'The IDs of the authorized end users.', + 'title' => '', + 'example' => '', ], - 'NetRedirectRule' => [ - 'description' => 'The network redirection policies.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", + 'Sessions' => [ 'type' => 'array', 'items' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", 'type' => 'object', 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => '*.example.com', - ], - 'RuleType' => [ - 'description' => 'The rule type.'."\n", - 'type' => 'string', - 'example' => 'domain', - ], - 'Policy' => [ - 'description' => 'The redirection policy.'."\n", - 'type' => 'string', - 'example' => 'allow', - ], + 'EndUserId' => ['description' => 'The ID of the end user.', 'type' => 'string', 'example' => 'testUser', 'title' => ''], + 'NickName' => ['description' => 'The nickname of the end user.', 'type' => 'string', 'example' => 'sz-sygc-07-03', 'title' => ''], + 'ExternalUserName' => ['description' => 'The external username of the end user.', 'type' => 'string', 'example' => 'testUserName', 'title' => ''], + 'EstablishmentTime' => ['description' => 'The time when the session was created.', 'type' => 'string', 'example' => '2026-04-17T14:51:53Z', 'title' => ''], ], + 'description' => 'The details of a session.', + 'title' => '', + 'example' => '', ], + 'description' => 'A list of session details.', + 'title' => '', + 'example' => '', ], - 'Recording' => [ - 'description' => 'Indicates whether screen recording is enabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'RecordingStartTime' => [ - 'description' => 'The start time of screen recording. The value is in the HH:MM:SS format. The value is meaningful only when you set Recording to period.'."\n", - 'type' => 'string', - 'example' => '08:00:00', - ], - 'RecordingEndTime' => [ - 'description' => 'The end time of screen recording. The value is in the HH:MM:SS format. The value is meaningful only when you set Recording to period.'."\n", - 'type' => 'string', - 'example' => '08:59:00', - ], - 'RecordingFps' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'RecordingExpires' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'CameraRedirect' => [ - 'description' => 'Indicates whether on-premises webcam redirection is enabled.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'NetRedirect' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'AppContentProtection' => [ - 'description' => 'Indicates whether anti-screenshot is enabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'RecordContent' => [ - 'description' => 'Indicates whether custom screen recording is enabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'RecordContentExpires' => [ - 'description' => 'The duration for which custom screen recordings are kept before they expire. Default value: 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'RemoteCoordinate' => [ - 'description' => 'The keyboard and mouse control permissions during remote assistance.'."\n", - 'type' => 'string', - 'example' => 'fullControl', - ], - 'RecordingDuration' => [ - 'description' => 'The length of the screen recording file. Unit: minutes. Screen recording files are split by the specified length and uploaded to OSS buckets. Once a file reaches 300 MB, the system prioritizes rolling updates for that file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Scope' => [ - 'description' => 'The effective scope of the policy.'."\n", - 'type' => 'string', - 'example' => 'GLOBAL', - ], - 'ScopeValue' => [ - 'description' => 'The effective scopes specified by CIDR blocks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/24', - ], - ], - 'RecordingAudio' => [ - 'description' => 'Indicates whether audio files generated on cloud computers are recorded.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'InternetCommunicationProtocol' => [ - 'description' => 'The network communication protocol.'."\n", - 'type' => 'string', - 'example' => 'tcp', - ], - 'VideoRedirect' => [ - 'description' => 'Indicates whether multimedia redirection is enabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'WatermarkTransparencyValue' => [ - 'description' => 'The watermark transparency. A higher value means the watermark is less transparent. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'WatermarkColor' => [ - 'description' => 'The font color of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WatermarkFontSize' => [ - 'description' => 'The font size of the watermark. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'WatermarkFontStyle' => [ - 'description' => 'The font style of the watermark.'."\n", - 'type' => 'string', - 'example' => 'plain', - ], - 'WatermarkDegree' => [ - 'description' => 'The watermark rotation. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '-10', - ], - 'WatermarkRowAmount' => [ - 'description' => 'The number of watermark rows.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'EndUserApplyAdminCoordinate' => [ - 'description' => 'Indicates whether end users are allowed to request administrator help.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'EndUserGroupCoordinate' => [ - 'description' => 'Indicates whether end users in the same office network can share cloud computers.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'CpuProtectedMode' => [ - 'description' => 'The CPU spike protection policy.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'CpuRateLimit' => [ - 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'CpuSampleDuration' => [ - 'description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CpuSingleRateLimit' => [ - 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'CpuDownGradeDuration' => [ - 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'CpuProcessors' => [ - 'description' => 'The CPU processors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The CPU processor.'."\n", - 'type' => 'string', - 'example' => 'chrome.exe', - ], - ], - 'MemoryProtectedMode' => [ - 'description' => 'The memory spike protection policy.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'MemoryRateLimit' => [ - 'description' => 'The overall memory usage. Valid values: 70 to 90. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'MemorySampleDuration' => [ - 'description' => 'The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemorySingleRateLimit' => [ - 'description' => 'The memory usage per process. Valid values: 30 to 60. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemoryDownGradeDuration' => [ - 'description' => 'The memory underclocking duration per process. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemoryProcessors' => [ - 'description' => 'The memory processors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The memory processor.'."\n", - 'type' => 'string', - 'example' => 'notepad.exe', - ], - ], - 'WatermarkSecurity' => [ - 'description' => 'Indicates whether security priority is enabled for invisible watermarks.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'WatermarkAntiCam' => [ - 'description' => 'Indicates whether anti-screen capture is enabled for invisible watermarks.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'WatermarkPower' => [ - 'description' => 'The enhancement level for invisible watermarks.'."\n", - 'type' => 'string', - 'example' => 'medium', - ], - 'RecordingUserNotify' => [ - 'description' => 'Indicates whether to notify end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'RecordingUserNotifyMessage' => [ - 'description' => 'The notification sent to end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'AdminAccess' => [ - 'description' => 'Indicates whether the admin permissions are granted to end users.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", - 'type' => 'string', - 'example' => 'deny', - ], - 'MaxReconnectTime' => [ - 'description' => 'The maximum duration to retry reconnecting to cloud computers after an unexpected disconnection (non-human causes). Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DisplayMode' => [ - 'description' => 'The display mode.'."\n", - 'type' => 'string', - 'example' => 'adminCustom', - ], - 'StreamingMode' => [ - 'description' => 'The streaming mode.'."\n", - 'type' => 'string', - 'example' => 'smooth', - ], - 'ColorEnhancement' => [ - 'description' => 'Indicates whether color enhancement is enabled for design and 3D applications.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'SmoothEnhancement' => [ - 'description' => 'Indicates whether smoothness enhancement is enabled for daily office use.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'QualityEnhancement' => [ - 'description' => 'Indicates whether image quality enhancement is enabled for design and 3D applications.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'VideoEncPolicy' => [ - 'description' => 'The video encoding policy.'."\n", - 'type' => 'string', - 'example' => 'qualityFirst', - ], - 'TargetFps' => [ - 'description' => 'The target frame rate. Valid values: 10 to 60. Unit: fps.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'VideoEncMinQP' => [ - 'description' => 'The minimum quantizer parameter (QP) for video files. A lower QP means better video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'VideoEncMaxQP' => [ - 'description' => 'The maximum QP for video files. Higher QP values result in lower video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'VideoEncAvgKbps' => [ - 'description' => 'The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'VideoEncPeakKbps' => [ - 'description' => 'The peak bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'DeviceRedirects' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n", - 'type' => 'string', - 'example' => 'camera', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n", - 'type' => 'string', - 'example' => 'usbRedirect', - ], - ], - ], - ], - 'DeviceRules' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n", - 'type' => 'string', - 'example' => 'storage', - ], - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'example' => 'sandisk', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'example' => '0x0781', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'example' => '0x55b1', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n", - 'type' => 'string', - 'example' => 'usbRedirect', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'example' => '2:0', - ], - 'Platforms' => [ - 'type' => 'string', - ], - ], - ], - ], - 'WyAssistant' => [ - 'description' => 'Indicates whether the Xiaoying AI Assistant entry is displayed in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'StatusMonitor' => [ - 'description' => 'Indicates whether the metric status entry is displayed in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'example' => 'on', - ], - 'MobileRestart' => [ - 'description' => 'Indicates whether the Restart button is displayed in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'MobileShutdown' => [ - 'description' => 'Indicates whether the Stop button is displayed in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'DesktopCount' => [ - 'description' => 'The number of cloud computers that are associated with the policy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DesktopGroupCount' => [ - 'description' => 'The number of cloud computer shares that are associated with the policy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ResourceGroupCount' => [ - 'description' => 'The number of resource groups that are associated with the policy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ResolutionModel' => [ - 'description' => 'The resolution type.'."\n", - 'type' => 'string', - 'example' => 'adaptive', - ], - 'ResolutionWidth' => [ - 'description' => 'The width of the resolution. Unit: pixel.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1920', - ], - 'ResolutionHeight' => [ - 'description' => 'The height of the resolution. Unit: pixel.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1280', - ], - 'Taskbar' => [ - 'description' => 'Indicates whether the application taskbar is displayed.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'NoOperationDisconnect' => [ - 'description' => 'Indicates whether a disconnection is enforced upon inactivity.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'NoOperationDisconnectTime' => [ - 'description' => 'The duration of disconnection after inactivity. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DisconnectKeepSession' => [ - 'description' => 'Indicates whether the session is retained after disconnection.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'string', - 'example' => 'persistent', - ], - 'DisconnectKeepSessionTime' => [ - 'description' => 'The retention period of the session after disconnection. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DomainRegisterValue' => [ - 'description' => 'The field where the domain resolution policy is applied.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RecordEventFilePaths' => [ - 'description' => 'The absolute paths to screen recording files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording file.'."\n", - 'type' => 'string', - 'example' => 'd:/data', - ], - ], - 'RecordEventRegisters' => [ - 'description' => 'The absolute paths to screen recording registries.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording registry.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - 'RecordEventDuration' => [ - 'description' => 'The duration of screen recording after the specified event is detected. Unit: minutes. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'InternetPrinter' => [ - 'type' => 'string', - ], - 'SafeMenu' => [ - 'type' => 'string', - ], - 'ScreenDisplayMode' => [ - 'type' => 'string', - ], - 'ClientControlMenu' => [ - 'type' => 'string', - ], - 'FileTransferSpeedLocation' => [ - 'type' => 'string', - ], - 'FileTransferAddress' => [ - 'type' => 'string', - ], - 'FileTransferSpeed' => [ - 'type' => 'string', - ], - 'CpdDriveClipboard' => [ - 'type' => 'string', - ], - 'UseTime' => [ - 'type' => 'string', - ], - 'ResolutionDpi' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'HoverConfigMsg' => [ - 'type' => 'string', - ], - 'ClientHibernate' => [ - 'type' => 'string', - ], - 'ClientRestart' => [ - 'type' => 'string', - ], - 'ClientShutdown' => [ - 'type' => 'string', - ], - 'HoverHibernate' => [ - 'type' => 'string', - ], - 'HoverRestart' => [ - 'type' => 'string', - ], - 'HoverShutdown' => [ - 'type' => 'string', - ], - 'MultiScreen' => [ - 'type' => 'string', - ], - 'AcademicProxy' => [ - 'type' => 'string', - ], - 'ModelLibrary' => [ - 'type' => 'string', - ], - 'PortProxy' => [ - 'type' => 'string', - ], - 'WatermarkShadow' => [ - 'type' => 'string', - ], - 'MobileWyAssistant' => [ - 'type' => 'string', - ], - 'MobileSafeMenu' => [ - 'type' => 'string', - ], - 'MobileWuyingKeeper' => [ - 'type' => 'string', - ], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], ], + 'description' => 'The average metric data for a single resource.', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of average metric data.', + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DescribePolicyGroups\\": [\\n {\\n \\"PolicyStatus\\": \\"AVAILABLE\\",\\n \\"Html5Access\\": \\"off\\",\\n \\"WatermarkType\\": \\"EndUserId\\",\\n \\"WatermarkCustomText\\": \\"custom-watermark\\",\\n \\"Clipboard\\": \\"off\\",\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"PrinterRedirection\\": \\"off\\",\\n \\"Html5FileTransfer\\": \\"off\\",\\n \\"UsbRedirect\\": \\"off\\",\\n \\"PolicyGroupType\\": \\"SYSTEM\\",\\n \\"Watermark\\": \\"on\\",\\n \\"VisualQuality\\": \\"medium\\",\\n \\"Name\\": \\"testPolicyGroupName\\",\\n \\"LocalDrive\\": \\"readwrite\\",\\n \\"AuthorizeSecurityPolicyRules\\": [\\n {\\n \\"Type\\": \\"inflow\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Description\\": \\"test\\",\\n \\"PortRange\\": \\"22/22\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Priority\\": \\"1\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"AuthorizeAccessPolicyRules\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"ClientTypes\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"GpuAcceleration\\": \\"off\\",\\n \\"UsbSupplyRedirectRule\\": [\\n {\\n \\"VendorId\\": \\"04**\\",\\n \\"ProductId\\": \\"08**\\",\\n \\"Description\\": \\"测试规则\\",\\n \\"UsbRedirectType\\": 1,\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"off\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"tcp\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 3,\\n \\"EndUserApplyAdminCoordinate\\": \\"off\\",\\n \\"EndUserGroupCoordinate\\": \\"off\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"off\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"录屏已开启\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 2000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"ResolutionModel\\": \\"adaptive\\",\\n \\"ResolutionWidth\\": 1920,\\n \\"ResolutionHeight\\": 1280,\\n \\"Taskbar\\": \\"off\\",\\n \\"NoOperationDisconnect\\": \\"off\\",\\n \\"NoOperationDisconnectTime\\": 120,\\n \\"DisconnectKeepSession\\": \\"persistent\\",\\n \\"DisconnectKeepSessionTime\\": 120,\\n \\"DomainRegisterValue\\": \\"xxxx\\",\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"MobileWyAssistant\\": \\"\\",\\n \\"MobileSafeMenu\\": \\"\\",\\n \\"MobileWuyingKeeper\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeCenterPolicyList', - ], - 'CreateCenterPolicy' => [ - 'summary' => 'Creates a center policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryHistoryAvgMetricList', + 'summary' => 'Retrieves historical average monitoring metrics for a desktop resource over a specified date range.', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves historical average monitoring metrics for desktop resources that meet specified criteria within a time range.'."\n" + ."\n" + .'- The `DataDate` and `EndDate` parameters specify the time range. If omitted, the query defaults to the previous day.'."\n" + ."\n" + .'- You can filter results by criteria such as desktop ID, name, and custom numeric ranges.'."\n" + ."\n" + .'- The response contains the details of each matching desktop resource and its corresponding average values.'."\n" + ."\n" + .'- Use the `PageNum` and `PageSize` pagination parameters to control the number of results returned.'."\n" + ."\n" + .'- Note: When using the `Ranges` parameter, ensure that you provide reasonable intervals. Unreasonable intervals can degrade query performance or lead to invalid results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC2****\\",\\n \\"AvgMetricList\\": [\\n {\\n \\"DesktopId\\": \\"ecd-bx9i0nsjd3zmibnzq\\",\\n \\"DesktopName\\": \\"C-051\\",\\n \\"DesktopGroupId\\": \\"dg-bogo95eob5avnis9k\\",\\n \\"MultiResource\\": true,\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ManagementFlag\\": \\"0\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.8c16g\\",\\n \\"Platform\\": \\"Winserver2025\\",\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"AvgValue\\": 20,\\n \\"Cpu\\": 4,\\n \\"GpuSpec\\": \\"0\\",\\n \\"Memory\\": 2048,\\n \\"EndUserIds\\": [\\n \\"testUser\\"\\n ],\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"testUser\\",\\n \\"NickName\\": \\"sz-sygc-07-03\\",\\n \\"ExternalUserName\\": \\"testUserName\\",\\n \\"EstablishmentTime\\": \\"2026-04-17T14:51:53Z\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"TotalCount\\": 20\\n}","type":"json"}]', + ], + 'QueryHistoryMetricDistribution' => [ + 'summary' => 'Queries the historical distribution of a specific metric over a specified time period.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Set the value to cn-shanghai.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'cn-shanghai' => '', - ], - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'ResourceType', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', - ], - 'example' => 'desktop', - ], + 'schema' => ['description' => 'The start date of the query period. The date must be in the `YYYY-MM-DD` format. The default value is T-1.', 'type' => 'string', 'required' => false, 'example' => '2026-04-01', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The business type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: public cloud'."\n" - .'* 8: commercial edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 1 => '', - 8 => '', - ], - 'example' => '1', - ], + 'schema' => ['description' => 'The end date of the query period. The date must be in the `YYYY-MM-DD` format. The default value is T-1.', 'type' => 'string', 'required' => false, 'example' => '2026-04-01', 'title' => ''], ], [ - 'name' => 'Clipboard', + 'name' => 'MetricName', 'in' => 'query', 'schema' => [ - 'description' => 'The read/write permissions on the clipboard.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: specifies one-way transfer You can copy files only from on-premises devices to cloud computers.'."\n" - .'* readwrite: specifies two-way transfer. You can copy files between on-premises devices and cloud computers.'."\n" - .'* write: specifies one-way transfer. You can only copy files from cloud computers to on-premises devices.'."\n" - .'* off (default): disables all transfers, both one-way and two-way. Files cannot be copied directly between on-premises devices and cloud computers.'."\n", + 'description' => 'The name of the metric to query.', + 'enumValueTitles' => ['SYSTEM_DISK_USAGE' => 'system disk usage', 'LOAD_SCORE' => 'health score', 'GPU_USAGE' => 'GPU usage', 'CPU_TOTAL_USAGE' => 'CPU usage', 'MEMORY_USAGE' => 'memory usage', 'ROUND_TRIP_TIME' => 'round-trip time', 'TOTAL_DISK_USAGE' => 'total disk usage', 'DATA_DISK_USAGE' => 'data disk usage'], 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'write' => '', - 'off' => '', - ], - 'example' => 'off', + 'example' => 'LOAD_SCORE', + 'title' => '', ], ], [ - 'name' => 'LocalDrive', + 'name' => 'Ranges', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The read/write permissions on the on-premises drive.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: read-only. Cloud computers support on-premises disk mapping, but only for reading (copying) files—not modifying them.'."\n" - .'* readwrite: read and write. Cloud computers support on-premises disk mapping, allowing you to read (copy) and write (modify) on-premises files.'."\n" - .'* off (default): none. Cloud computers don\'t support on-premises disk mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'off' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The label for the value range. This label is returned in the response.', 'type' => 'string', 'required' => false, 'example' => 'label-02\'', 'title' => ''], + 'Min' => ['description' => 'The minimum value of the value range.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0', 'title' => ''], + 'IncludeMin' => ['description' => 'Specifies whether to include the minimum value in the range. The default value is `true`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Max' => ['description' => 'The maximum value of the value range.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20', 'title' => ''], + 'IncludeMax' => ['description' => 'Specifies whether to include the maximum value in the range. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'description' => 'An object that defines a custom value range.', + 'title' => '', + 'example' => '', ], - 'example' => 'off', + 'maxItems' => 100, + 'description' => 'An array of custom value ranges.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'UsbRedirect', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default): doesn\'t enable USB redirection.'."\n" - .'* on: enables USB redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2F2BF549-CBD9-1FED-9ABB-086B62D7B293'], + 'DistributionList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Label' => ['description' => 'The range label that you defined in the request.', 'type' => 'string', 'example' => '2F2BF549-CBD9-1FED-9ABB-086B62D7B293', 'title' => ''], + 'Min' => ['description' => 'The minimum value of the value range.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], + 'Max' => ['description' => 'The maximum value of the value range.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'Count' => ['description' => 'The number of data points in this value range.', 'type' => 'integer', 'format' => 'int32', 'example' => '40', 'title' => ''], + ], + 'description' => 'The distribution data for a specific value range.', + 'title' => '', + 'example' => '', + ], + 'description' => 'An array of objects, each representing the distribution data for a specific value range.', + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of data points that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'description' => 'The data returned for the request.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryHistoryMetricDistribution', + 'description' => '## Request'."\n" + ."\n" + .'This API queries the value distribution for specific metrics, such as CPU usage and memory usage, within a given date range. You can define custom value ranges for more detailed statistics. The API supports both the enterprise edition and commercial edition. By default, it returns statistics for the previous day (T-1).'."\n" + ."\n" + .'- **BusinessChannel**: Defaults to the enterprise edition. The commercial edition is also available.'."\n" + ."\n" + .'- **StartDate & EndDate**: Both default to T-1 (the previous day). The date must be in the `YYYY-MM-DD` format.'."\n" + ."\n" + .'- **MetricName**: The metric to query. For a list of valid metrics, see the parameter description in this topic.'."\n" + ."\n" + .'- **Ranges**: Defines multiple value ranges for a more detailed analysis. For each range, you can set a minimum value, a maximum value, and whether to include these boundary values.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F2BF549-CBD9-1FED-9ABB-086B62D7B293\\",\\n \\"DistributionList\\": [\\n {\\n \\"Label\\": \\"2F2BF549-CBD9-1FED-9ABB-086B62D7B293\\",\\n \\"Min\\": 0,\\n \\"Max\\": 20,\\n \\"Count\\": 40\\n }\\n ],\\n \\"TotalCount\\": 94\\n}","type":"json"}]', + ], + 'QueryHistoryUsageDurationRank' => [ + 'summary' => 'Queries and ranks historical usage duration by end user or desktop.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PrinterRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'The printer redirection policy. This parameter only applies if DeviceRedirects does not include a printer redirection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect (default):enables device redirection.'."\n" - .'* usbRedirect: enables USB redirection.'."\n" - .'* off: disables any type of redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'off', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'VisualQuality', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => 'The image display quality.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high: high-definition (HD).'."\n" - .'* low: smoothness.'."\n" - .'* lossless: no quality loss.'."\n" - .'* medium (default): scenario-specific adaptation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'lossless' => '', - 'medium' => '', - ], - 'example' => 'low', - ], + 'schema' => ['description' => 'The start date of the query in `YYYY-MM-DD` format. You can query data within the last 90 days.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2026-05-07', 'title' => ''], ], [ - 'name' => 'GpuAcceleration', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable image quality control. This feature is highly recommended for professional design scenarios where computer performance and user experience are critical.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable image quality control.'."\n" - .'* on: enables image quality control.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The end date of the query in `YYYY-MM-DD` format. You can query data within the last 90 days.', 'type' => 'string', 'required' => false, 'example' => '2026-04-19', 'title' => ''], ], [ - 'name' => 'Html5FileTransfer', + 'name' => 'Limit', 'in' => 'query', - 'schema' => [ - 'description' => 'The file transfer feature on the web client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: File upload and download are supported.'."\n" - .'* download: Only file download is supported.'."\n" - .'* upload: Only file upload is supported.'."\n" - .'* off (default): File upload and download are not supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'all' => '', - 'download' => '', - 'upload' => '', - 'off' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The number of entries to return. The default value is 5, and the maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'title' => ''], ], [ - 'name' => 'Watermark', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* blind: displays invisible watermarks.'."\n" - .'* off (default): displays no watermark.'."\n" - .'* on: displays visible watermarks.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'blind' => '', - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You can obtain this token from the response to the previous request.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'BizType', 'in' => 'query', + 'schema' => ['description' => 'The business type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The policy name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'testPolicyGroupName', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '94', 'title' => ''], + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is not returned, there are no more results.', 'type' => 'string', 'example' => 'AAAAAWvmfbFWy0uSlxZ6pIAKAnuwt1ezsRqxI6hPibm27fMH', 'title' => ''], + 'UsageDurationList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndUserId' => ['description' => '**The end user ID.**', 'type' => 'string', 'example' => 'endUserId', 'title' => ''], + 'DesktopId' => ['description' => '**The ID of the cloud desktop.**', 'type' => 'string', 'example' => 'ecd-8cndajrdrd424sb99', 'title' => ''], + 'DesktopName' => ['description' => '**The name of the cloud desktop.**', 'type' => 'string', 'example' => 'TestName', 'title' => ''], + 'ChargeType' => ['description' => 'The **charge type**. Valid values: `POST_PAID` (post-paid), `PRE_PAID` (pre-paid), `MONTH_PACKAGE` (monthly subscription), and `DURATION` (duration package).', 'type' => 'string', 'example' => 'PrePaid', 'title' => ''], + 'UsageDuration' => ['description' => 'The **usage duration**, in seconds. Note: This is a `Long` value. Ensure your client can handle the precision.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + ], + 'description' => 'The usage duration metric object.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of usage duration metrics.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'QueryHistoryUsageDurationRank', + 'description' => '## Usage notes'."\n" + ."\n" + .'- **Date range**: You can query data within the last 90 days.'."\n" + ."\n" + .'- **Pagination**: This operation uses the`NextToken` parameter for pagination. To retrieve the next page of results, use the `NextToken` value from the previous response.'."\n" + ."\n" + .'- **Default and maximum limits**: This operation returns 5 records by default, with a maximum of 200 records per page.'."\n" + ."\n" + .'- **Authentication**: This operation uses an AccessKey for authentication.'."\n" + ."\n" + .'- **Caller account information**: You do not need to specify an Alibaba Cloud account ID (AliUid). The system automatically resolves it.'."\n" + ."\n" + .'- **Billing**: This API operation is free of charge.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'WatermarkType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark type. You can specify up to three types. Separate multiple values with commas (,).'."\n" - ."\n" - .'> If you provide `custom` as the value for this parameter, you must configure `WatermarkCustomText` to specify custom text.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username.'."\n" - .'* Custom: the custom text.'."\n" - .'* DesktopIp: the IP address of the cloud computer.'."\n" - .'* ClientIp: the IP address of the client.'."\n" - .'* HostName: the rightmost 15 digits of the cloud computer ID.'."\n" - .'* ClientTime: the current time displayed on the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EndUserId' => '', - 'Custom' => '', - 'DesktopIp' => '', - 'ClientIp' => '', - 'HostName' => '', - 'ClientTime' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:QueryHistoryUsageDurationRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'EndUserId,HostName,ClientTime', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 94,\\n \\"NextToken\\": \\"AAAAAWvmfbFWy0uSlxZ6pIAKAnuwt1ezsRqxI6hPibm27fMH\\",\\n \\"UsageDurationList\\": [\\n {\\n \\"EndUserId\\": \\"endUserId\\",\\n \\"DesktopId\\": \\"ecd-8cndajrdrd424sb99\\",\\n \\"DesktopName\\": \\"TestName\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"UsageDuration\\": 20000,\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'RebootDesktops' => [ + 'summary' => 'Reboots one or more desktops.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'WatermarkCustomText', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The ID of the region. Call [DescribeRegions](~~DescribeRegions~~) to get a list of regions where Elastic Desktop Service is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'WatermarkTransparencyValue', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The watermark opacity. A higher value makes the watermark more opaque. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'An array of 1 to 100 desktop IDs.', + 'type' => 'array', + 'items' => ['description' => 'The desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-gx2x1dhsmucyy****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'WatermarkSecurity', + 'name' => 'OsUpdate', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to install system patches.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PatchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'example' => 'KB5082063', 'title' => '', 'description' => ''], + ], + [ + 'name' => 'CreateSnapshot', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'boolean', 'default' => 'false', 'title' => '', 'description' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable security priority for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables security priority for invisible watermarks.'."\n" - .'* on: enables security priority for invisible watermarks.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'on', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RebootDesktops', + 'description' => 'The desktops must be in the Running state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootDesktops'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CameraRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'The on-premises camera redirection policy. This parameter only applies if DeviceRedirects does not include an on-premises camera redirection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: enables device redirection.'."\n" - .'* off: disables device redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'off' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:RebootDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'off', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'RebuildDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'NetRedirect', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to find the regions where Elastic Desktop Service is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: enables network redirection globally.'."\n" - .'* off (default): disables network redirection.'."\n" - .'* on: enables the whitelist mode.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'all' => '', - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'description' => 'The IDs of the cloud computers to rebuild. You can specify 1 to 20 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-gx2x1dhsmucyy****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'AppContentProtection', + 'name' => 'ImageId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the new image.', 'type' => 'string', 'required' => false, 'example' => 'm-84mztzatmlnys****', 'title' => ''], + ], + [ + 'name' => 'OperateType', 'in' => 'query', 'schema' => [ - 'description' => 'The anti-screenshot policy.'."\n" + 'description' => 'Specifies how to handle the data disk.'."\n" ."\n" - .'Valid values:'."\n" + .'> This parameter is optional.'."\n" + ."\n" + .'- If a cloud computer does not have a data disk, this parameter is ignored.
'."\n" + ."\n" + .'- If a cloud computer has a data disk:'."\n" + ."\n" + .' 1. If the new image has the same operating system as the original one:'."\n" + ."\n" + .' - If you set this parameter to `replace`, the data disk is replaced.'."\n" + ."\n" + .' - If you do not specify this parameter, the data disk is retained.'."\n" ."\n" - .'* off (default): disables anti-screenshot.'."\n" - .'* on: enables anti-screenshot.'."\n", + .' 2. If the new image has a different operating system:'."\n" + ."\n" + .' - If you set this parameter to `replace`, the data disk is replaced.'."\n" + ."\n" + .' - If you do not specify this parameter, the data disk is erased.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'replace', + 'title' => '', ], ], [ - 'name' => 'RemoteCoordinate', + 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'description' => 'The keyboard and mouse control permissions during remote assistance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* optionalControl: By default, keyboard and mouse control is disabled during remote assistance. You can request permissions as needed.'."\n" - .'* fullControl: Keyboard and mouse control is enabled during remote assistance.'."\n" - .'* disableControl: Keyboard and mouse control is disabled during remote assistance.'."\n", + 'description' => 'The operating system language. This parameter applies only to system images. For Linux cloud computers, only English is supported.', + 'enumValueTitles' => ['en-US' => 'English', 'zh-HK' => 'Traditional Chinese (Hong Kong)', 'zh-CN' => 'Simplified Chinese', 'ja-JP' => 'Japanese'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'optionalControl' => '', - 'fullControl' => '', - 'disableControl' => '', - ], - 'example' => 'fullControl', + 'example' => 'en-US', + 'title' => '', ], ], [ - 'name' => 'InternetCommunicationProtocol', + 'name' => 'AfterStatus', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The protocol for network communication.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* tcp: TCP is used when UDP/AST is restricted.'."\n" - .'* rtc: AST is used for high-frequency audio and video streaming.'."\n" - .'* auto: UTO is used to enable automatic switch between AST and UDP modes based on desktop content.'."\n" - .'* both: UDP is used for office and HD graphic design use.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'tcp' => '', - 'rtc' => '', - 'auto' => '', - 'both' => '', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'RebuildResults' => [ + 'description' => 'The rebuild results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rebuild result.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The operation result. A value of `Success` indicates the rebuild was initiated. Otherwise, an error code is returned.', 'type' => 'string', 'example' => 'IncorrectDesktopStatus', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only if the value of `Code` is not `Success`.', 'type' => 'string', 'example' => 'The current status of the desktop does not support this operation.', 'title' => ''], + 'DesktopId' => ['description' => 'The desktop ID.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'both', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RebuildDesktops', + 'summary' => 'Replaces the image of one or more cloud computers.', + 'description' => 'This operation is subject to the following limitations:'."\n" + ."\n" + .'- For cloud computers in the China (Hong Kong) region and regions outside the Chinese mainland, you cannot switch to an image with a different operating system. For example, you cannot switch from a Windows image to a Linux image.'."\n" + ."\n" + .'- You cannot switch between GPU images and non-GPU images. Graphics-optimized cloud computers must use GPU images, and non-graphics cloud computers can only use non-GPU images.'."\n" + ."\n" + .'Changing the image re-initializes the cloud computer\'s system disk with the new image. This action has the following effects:'."\n" + ."\n" + .'- All data on the original system disk is erased. Any snapshots created from the original system disk become invalid, and the system automatically deletes them.'."\n" + ."\n" + .'- If the new image has a different operating system, all data on the data disk is erased. Snapshots created from the data disk become invalid, and the system automatically deletes them. If the new image has the same operating system, data on the data disk is retained and its snapshots remain usable.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '- If the HTTP status code is `200`, the request was successful. The `RebuildResults` array shows the outcome for each cloud computer: a `Code` of `Success` indicates the rebuild has started; otherwise, the returned error code explains why the process failed to start.'."\n" + ."\n" + .'- A `4xx` HTTP status code indicates an invalid parameter. In this case, the rebuild is not initiated for any of the specified cloud computers.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-09T09:54:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-17T13:00:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-05T08:09:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-25T03:53:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebuildDesktops'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VideoRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'The multimedia redirection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables multimedia redirection.'."\n" - .'* on: enables multimedia redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:RebuildDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'on', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RebuildResults\\": [\\n {\\n \\"Code\\": \\"IncorrectDesktopStatus\\",\\n \\"Message\\": \\"The current status of the desktop does not support this operation.\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'RemoveFilePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'WatermarkColor', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The font color of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'WatermarkDegree', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark rotation. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '-10', - ], + 'schema' => ['description' => 'The ID of the end user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'WatermarkFontSize', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The font size of the watermark. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The file ID. You can call the [ListCdsFiles](~~2247622~~) operation to query the ID of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****', 'title' => ''], ], [ - 'name' => 'WatermarkFontStyle', + 'name' => 'CdsId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the enterprise drive.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-066224****', 'title' => ''], + ], + [ + 'name' => 'MemberList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The font style of the watermark.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* plain'."\n" - .'* bold'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'plain' => '', - 'bold' => '', + 'description' => 'The users that you want to authorize to use the cloud disk.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The user that you want to authorize.'."\n", + 'type' => 'object', + 'properties' => [ + 'RoleId' => [ + 'description' => 'You can set permissions by specifying roles or by customizing operation permissions. This field is used to set permissions by specifying roles. This field is mutually exclusive with `ActionList`.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SystemFileEditorWithoutShareLink: the role that has the permissions to edit files but cannot share files.'."\n" + .'* SystemFileUploaderAndDownloaderWithShareLink: the role that has the permissions to upload, download, and share files.'."\n" + .'* SystemFileDownloader: the role that has the permissions to download files.'."\n" + .'* SystemFileEditorWithoutDelete: the role that has the permissions to edit files but cannot delete files.'."\n" + .'* SystemFileOwner: the role that has the permissions to collaborate with others.'."\n" + .'* SystemFileDownloaderWithShareLink: the role that has the permissions to download and share files'."\n" + .'* SystemFileUploaderAndViewer: the role that has the permissions to preview or upload files.'."\n" + .'* SystemFileViewer: the role that has the permissions to preview files.'."\n" + .'* SystemFileEditor: the role that has the permissions to edit files'."\n" + .'* SystemFileUploaderWithShareLink: the role that has the permissions to upload or share files.'."\n" + .'* SystemFileUploader: the role that has the permission to upload files.'."\n" + .'* SystemFileUploaderAndDownloader: the role that has the permissions to upload or download files.'."\n" + .'* SystemFileMetaViewer: the role that has the permissions to view files'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SystemFileEditorWithoutShareLink' => '', 'SystemFileUploaderAndDownloaderWithShareLink' => '', 'SystemFileDownloader' => '', 'SystemFileEditorWithoutDelete' => '', 'SystemFileOwner' => '', 'SystemFileDownloaderWithShareLink' => '', 'SystemFileUploaderAndViewer' => '', 'SystemFileViewer' => '', 'SystemFileEditor' => '', 'SystemFileUploaderWithShareLink' => '', + 'SystemFileUploader' => '', 'SystemFileUploaderAndDownloader' => '', 'SystemFileMetaViewer' => '', + ], + 'example' => 'SystemFileUploaderAndDownloader', + 'title' => '', + ], + 'CdsIdentity' => [ + 'description' => 'The permission information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The user ID or group ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '249dsfseee643h33g3dv****', 'title' => ''], + 'Type' => [ + 'description' => 'The object type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* IT_Group: group.'."\n" + .'* IT_User: user.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['IT_Group' => '', 'IT_User' => ''], + 'example' => 'IT_User', + 'default' => 'IT_User', + 'enum' => ['IT_User', 'IT_Group'], + 'title' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'plain', + 'required' => true, + 'docRequired' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'WatermarkRowAmount', + 'name' => 'GroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the team space.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cg-1fbmvrc7ug5m7****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of watermark rows. Valid values: 3 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RemoveFilePermission', + 'summary' => 'Unshare a folder on the network disk.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveFilePermission'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\"\\n}","type":"json"}]', + ], + 'RemoveUserFromDesktopGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'WatermarkColumnAmount', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of watermark columns. Valid values: 3 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to get a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CpuProtectedMode', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The CPU spike protection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables CPU spike protection.'."\n" - .'* on: enables CPU spike protection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The ID of the shared cloud desktop from which you revoke the user’s permission.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'CpuRateLimit', + 'name' => 'EndUserIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of authorized users to remove.', + 'type' => 'array', + 'items' => ['description' => 'The authorized user to remove.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], 'required' => false, - 'example' => '70', + 'maxItems' => 10000, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CpuSampleDuration', + 'name' => 'DesktopGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'A list of shared desktop group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a shared desktop group.', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****', 'title' => ''], 'required' => false, - 'example' => '60', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CpuSingleRateLimit', + 'name' => 'UserOuPath', 'in' => 'query', - 'schema' => [ - 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'CpuDownGradeDuration', + 'name' => 'UserGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'MemoryProtectedMode', + 'name' => 'SimpleUserGroupId', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The memory spike protection policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables memory spike protection.'."\n" - .'* on: enables memory spike protection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RemoveUserFromDesktopGroup', + 'summary' => 'Removes specified authorized users from a shared desktop group. After an authorized user is removed, that user can no longer connect to the cloud desktops in the group.', + 'changeSet' => [ + ['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveUserFromDesktopGroup'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'RenewDesktopGroup' => [ + 'summary' => 'Renews the subscription for a cloud computer pool.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MemoryRateLimit', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The overall memory usage. Valid values: 70 to 90. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '70', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions that are supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MemorySampleDuration', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], + 'schema' => ['description' => 'The ID of the cloud computer pool.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-7724r1jitbjzc****', 'title' => ''], ], [ - 'name' => 'MemorySingleRateLimit', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The memory usage per process. Valid values: 30 to 60. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '40', - ], + 'schema' => ['description' => 'The renewal duration. The valid values of this parameter vary based on the `PeriodUnit` value.'."\n" + ."\n" + .'- If you set `PeriodUnit` to `Month`, the valid values are 1, 2, 3, and 6.'."\n" + ."\n" + .'- If you set `PeriodUnit` to `Year`, the valid values are 1, 2, 3, 4, and 5.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MemoryDownGradeDuration', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The memory underclocking duration per process. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The unit of the renewal duration specified by the `Period` parameter.', + 'enumValueTitles' => ['Month' => 'Month (default)', 'Year' => 'Year'], + 'type' => 'string', 'required' => false, - 'example' => '40', + 'docRequired' => true, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'EndUserApplyAdminCoordinate', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable end users to request administrator help.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables end users to request administrator help.'."\n" - .'* on: enables end users to request administrator help.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Enables automatic payment. Make sure that your account has a sufficient balance. Otherwise, an unpaid order is generated. (Default)', 'false' => 'Generates an order but does not complete the payment. You can log on to the Elastic Desktop Service console and complete the payment in the Orders page.'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'docRequired' => false, + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'EndUserGroupCoordinate', + 'name' => 'AutoRenew', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to allow end users in the same office network to share cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t allow end users in the same office network to share cloud computers.'."\n" - .'* on: allows end users in the same office network to share cloud computers.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable auto-renewal.', + 'enumValueTitles' => ['true' => 'Enables auto-renewal.', 'false' => 'Disables auto-renewal.'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'Scope', + 'name' => 'ResellerOwnerUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy applies to specific IP addresses.'."\n" - .'* GLOBAL: The policy applies globally.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E55E6732-2028-52FA-AB06-EA29C36B****', 'title' => ''], + 'OrderId' => [ + 'description' => 'The order IDs.', + 'type' => 'array', + 'items' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '21455206303****', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], - 'example' => 'GLOBAL', + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RenewDesktopGroup', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktopGroup'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Recording', - 'in' => 'query', - 'schema' => [ - 'description' => 'The screen recording policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* period: Screen recording occurs at set intervals.'."\n" - .'* session: Screen recording is limited to sessions only.'."\n" - .'* off: Screen recording is disabled.'."\n" - .'* alltime: Screen recording is always enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'period' => '', - 'session' => '', - 'off' => '', - 'alltime' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:RenewDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'off', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E55E6732-2028-52FA-AB06-EA29C36B****\\",\\n \\"OrderId\\": [\\n \\"21455206303****\\"\\n ]\\n}","type":"json"}]', + ], + 'RenewDesktops' => [ + 'summary' => 'Renews one or more subscription-based WUYING Workspace instances.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordingAudio', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record audio files generated on cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t record audio files generated on cloud computers.'."\n" - .'* on: records audio files generated on cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~DescribeRegions~~) to list the regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RecordingStartTime', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The screen recording\'s start time in HH:MM:SS format. The value is meaningful only if `Recording` is set to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:00:00', - ], + 'schema' => ['description' => 'The renewal duration. Valid values depend on the value of `PeriodUnit`.'."\n" + ."\n" + .'- If `PeriodUnit` is `Month`, valid values are 1, 2, 3, and 6.'."\n" + ."\n" + .'- If `PeriodUnit` is `Year`, valid values are 1 to 5.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RecordingEndTime', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The screen recording\'s end time in HH:MM:SS format. The value is meaningful only if `Recording` is set to `PERIOD`.'."\n", + 'description' => 'The unit for the renewal duration, which applies to the `Period` parameter.', + 'enumValueTitles' => ['Month' => 'Month \\[default]', 'Year' => 'Year'], 'type' => 'string', 'required' => false, - 'example' => '08:59:00', + 'docRequired' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'RecordingFps', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Enable automatic payment. Ensure your account balance is sufficient. Otherwise, an abnormal order is generated \\[default].', 'false' => 'Create an order only. Do not pay. Log on to the console. Go to User Center > My Orders. Pay using the returned order ID.'], + 'type' => 'boolean', 'required' => false, - 'example' => '2', + 'docRequired' => false, + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'RecordingDuration', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The frame rate of screen recording. Screen recordings are split based on the specified duration and uploaded to Object Storage Service (OSS) buckets. If a file reaches 300 MB, the system prioritizes rolling updates for that file. Valid values: 10 to 60'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'A list of WUYING Workspace instance IDs. You can renew only instances purchased on a monthly basis.', + 'type' => 'array', + 'items' => ['description' => 'A WUYING Workspace instance ID. You can renew only instances purchased on a monthly basis.', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-ia2zw38bi6cm7****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'RecordingExpires', + 'name' => 'PromotionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '15', - ], + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '50003098015****', 'title' => ''], ], [ - 'name' => 'RecordingUserNotify', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to notify end users when screen recording is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t notify end users when screen recording is enabled.'."\n" - .'* on: notifies end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => '> This field is not available for public use.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], [ - 'name' => 'RecordingUserNotifyMessage', + 'name' => 'AutoRenew', 'in' => 'query', - 'schema' => [ - 'description' => 'The notification sent to end users when screen recording is enabled.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Specifies whether to enable auto-renewal.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'AdminAccess', + 'name' => 'ResellerOwnerUid', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to grant the admin permissions to end users.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow: forcibly grants admin permissions.'."\n" - .'* deny: forcibly rejects granting admin permissions.'."\n" - .'* inherited: inherits the admin permissions from the user dimension.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'deny' => '', - 'inherited' => '', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '20844399755****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'deny', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RenewDesktops', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-09T03:34:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-17T13:19:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-01T11:48:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-29T13:57:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktops'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"20844399755****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'RenewNetworkPackages' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableSessionRateLimiting', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enforce the peak bandwidth limit for sessions.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enforce the peak bandwidth limit for sessions.'."\n" - .'* on: enforces the peak bandwidth limit for sessions.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to list regions that support WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SessionMaxRateKbps', + 'name' => 'Period', 'in' => 'query', - 'schema' => [ - 'description' => 'The bandwidth peak allowed for sessions. Unit: Kbit/s. Valid values: 2000 to 100000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000', - ], + 'schema' => ['description' => 'The renewal duration. Valid values depend on the value of `PeriodUnit`.'."\n" + ."\n" + .'- If `PeriodUnit` is `Week`, valid values are: 1.'."\n" + ."\n" + .'- If `PeriodUnit` is `Month`, valid values are: 1, 2, 3, or 6.'."\n" + ."\n" + .'- If `PeriodUnit` is `Year`, valid values are: 1, 2, or 3.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DisplayMode', + 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => [ - 'description' => 'The display mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* clientCustom: suitable for user-defined scenarios.'."\n" - .'* adminOffice: suitable for daily office scenarios.'."\n" - .'* adminDesign: suitable for design and 3D application scenarios.'."\n" - .'* adminCustom: suitable for admin-customized scenarios.'."\n", + 'description' => 'The unit for the renewal duration.', + 'enumValueTitles' => ['Month' => 'Month \\[default]', 'Year' => 'Year', 'Week' => 'Week'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'clientCustom' => '', - 'adminOffice' => '', - 'adminDesign' => '', - 'adminCustom' => '', - ], - 'example' => 'clientCustom', + 'docRequired' => false, + 'example' => 'Month', + 'title' => '', ], ], [ - 'name' => 'StreamingMode', + 'name' => 'AutoPay', 'in' => 'query', 'schema' => [ - 'description' => 'The streaming mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* intelligent'."\n" - .'* smooth'."\n", - 'type' => 'string', + 'description' => 'Whether to enable automatic payment.', + 'enumValueTitles' => ['true' => 'Enable automatic payment. Ensure your account balance is sufficient. Otherwise, abnormal orders may occur. \\[default]', 'false' => 'Create an order only. Do not pay. Log on to the console. Go to User Center > My Orders. Pay using the returned order ID.'], + 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'intelligent' => '', - 'smooth' => '', - ], - 'example' => 'smooth', + 'docRequired' => false, + 'example' => 'true', + 'title' => '', ], ], [ - 'name' => 'ColorEnhancement', + 'name' => 'NetworkPackageId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable color enhancement for design and 3D applications.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable color enhancement for design and 3D applications.'."\n" - .'* on: enables color enhancement for design and 3D applications.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'description' => 'A list of premium public bandwidth IDs. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'A premium public bandwidth ID.', 'type' => 'string', 'required' => false, 'example' => 'np-jc31jdxfdydr1****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SmoothEnhancement', + 'name' => 'PromotionId', + 'in' => 'query', + 'schema' => ['description' => 'The promotion ID.', 'type' => 'string', 'required' => false, 'example' => '500038360030606', 'title' => ''], + ], + [ + 'name' => 'ResellerOwnerUid', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AutoRenew', 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable smoothness enhancement for daily office use.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enable smoothness enhancement for daily office use.'."\n" - .'* on: enables smoothness enhancement for daily office use.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The order ID.', 'type' => 'string', 'example' => '214726268900640', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Order.Unpaid', 'errorMessage' => 'You have unpaid orders, please pay such orders before placing a new order.', 'description' => ''], + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'User does not have permission to operate on the specified resource'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => ''], + ], + ], + 'title' => 'RenewNetworkPackages', + 'summary' => 'Renews subscription-based premium public bandwidth.', + 'changeSet' => [ + ['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-03T16:09:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-14T06:20:11.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-11-26T04:03:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-26T04:03:12.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewNetworkPackages'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214726268900640\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'ResetDesktops' => [ + 'summary' => 'Resets cloud desktops in a shared cloud desktop group.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'QualityEnhancement', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to list regions that support WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the shared cloud desktop.'."\n" + ."\n" + .'- If you specify `DesktopId`, the system ignores `DesktopGroupId`.'."\n" + ."\n" + .'- If `DesktopId` is empty, the system uses `DesktopGroupId` to retrieve the `DesktopId` of all cloud desktops in the shared cloud desktop group.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dg-07if7qsxoxkb6****', 'title' => ''], + ], + [ + 'name' => 'PayType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable image quality enhancement for design and 3D applications.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The billing method.'."\n" ."\n" - .'* off: doesn\'t enable image quality enhancement for design and 3D applications.'."\n" - .'* on: enables image quality enhancement for design and 3D applications.'."\n", + .'> This parameter applies only when resetting shared cloud desktops. If you leave it empty, the system resets all cloud desktops in the shared cloud desktop group, regardless of their billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go', 'PrePaid' => 'subscription'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'docRequired' => false, + 'example' => 'PrePaid', + 'title' => '', ], ], [ - 'name' => 'VideoEncPolicy', + 'name' => 'ResetType', 'in' => 'query', 'schema' => [ - 'description' => 'The video encoding policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* qualityFirst: prioritizes image quality.'."\n" - .'* bandwidthFirst: prioritizes bandwidth.'."\n", + 'description' => 'The reset type. This determines whether to reset and which disks to reset.', + 'enumValueTitles' => ['No reset', 'Reset only the system disk', 'Reset only the user disk', 'Reset both the system disk and the user disk'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'qualityFirst' => '', - 'bandwidthFirst' => '', - ], - 'example' => 'qualityFirst', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'TargetFps', + 'name' => 'ImageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The target frame rate. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], ], [ - 'name' => 'VideoEncMinQP', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The minimum quantizer parameter (QP) for video files. A lower QP means better video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'A list of cloud desktop IDs. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'A cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-07if7qsxoxkb3****', 'title' => ''], 'required' => false, - 'example' => '30', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'VideoEncMaxQP', + 'name' => 'DesktopGroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The maximum QP for video files. Higher QP values result in lower video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'A list of shared cloud desktop group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the shared cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****', 'title' => ''], 'required' => false, - 'example' => '30', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'VideoEncAvgKbps', + 'name' => 'ResetScope', 'in' => 'query', 'schema' => [ - 'description' => 'The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The scope of the reset operation. Set this parameter to reset either the image or the cloud desktop.', + 'enumValueTitles' => ['ALL' => 'Reset both the image and the cloud desktop. This is the default value.', 'IMAGE' => 'Reset only the image.'], + 'type' => 'string', 'required' => false, - 'example' => '2000', + 'example' => 'ALL', + 'title' => '', ], ], [ - 'name' => 'VideoEncPeakKbps', + 'name' => 'LastRetryTime', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The peak bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2000', + 'description' => 'Returns a collection of information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ResetDesktops', + 'description' => '> This operation applies only to shared cloud desktops. It does not support resetting standard cloud desktops.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T12:24:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-13T02:47:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-05-26T11:37:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDesktops'], + ], + ], + 'ramActions' => [], + ], + 'ResetNASDefaultMountTarget' => [ + 'summary' => 'Resets the mount target of a File Storage NAS (NAS) file system.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxReconnectTime', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum duration to retry reconnecting to cloud computers after an unexpected disconnection (non-human causes). Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'WyAssistant', + 'name' => 'FileSystemId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the NAS file system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3a6ef4****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to display the Xiaoying AI Assistant option in the DesktopAssistant menu when end users connect to cloud computers via desktop clients (Windows and macOS).'."\n" - ."\n" - .'> This feature applies to only desktop clients of version 7.7.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Xiaoying AI Assistant option in the DesktopAssistant menu.'."\n" - .'* on: displays the Xiaoying AI Assistant option in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'on', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ResetNASDefaultMountTarget', + 'description' => 'When you create a NAS file system, a mount target is automatically generated. By default, you do not need to modify the mount target of the NAS file system. If the mount target is disabled, you need to reset the mount target of the NAS file system.', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetNASDefaultMountTarget'], + ], + ], + 'ramActions' => [ [ - 'name' => 'CpuProcessors', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The CPU processors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The CPU processor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'notepad.exe', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetNASDefaultMountTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 5, ], ], + ], + ], + 'ResetSnapshot' => [ + 'summary' => 'Recovers disk data from a snapshot.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MemoryProcessors', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The memory processors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The memory processor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'chrome.exe', - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hzngahou', 'title' => ''], ], [ - 'name' => 'DomainResolveRule', + 'name' => 'SnapshotId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The domain resolution policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain resolution policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.example.com', - ], - 'Policy' => [ - 'description' => 'Specifies whether to allow the domain resolution policy to take effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow'."\n" - .'* block'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'allow', - ], - 'Description' => [ - 'description' => 'The policy description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The ID of the snapshot used to recover disk data.', 'type' => 'string', 'required' => true, 'example' => 's-2zeipxmnhej803x7****', 'title' => ''], ], [ - 'name' => 'NetRedirectRule', + 'name' => 'StopDesktop', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['title' => 'Shut down and recover snapshot.', 'description' => 'Indicates whether to shut down and recover the disk using the snapshot.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in private preview and only available to specific users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The network redirection policy.'."\n" - ."\n" - .'> This parameter is in invitational preview and not available to the public.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.taobao.com', - ], - 'RuleType' => [ - 'description' => 'The rule type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* prc: process.'."\n" - .'* domain: domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'prc' => '', - 'domain' => '', - ], - 'example' => 'domain', - ], - 'Policy' => [ - 'description' => 'The redirection policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'allow', - ], - ], - 'required' => false, + 'description' => 'The response elements.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'required' => false, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Recover disk data from the snapshot', + 'description' => 'When calling this interface, ensure the following:'."\n" + ."\n" + .'- You must back up any data on the disk that you want to save.'."\n" + ."\n" + .' > Data recovery is an irreversible operation. After you call this interface, the disk will revert to its state at the time the snapshot was created. Any data created between the snapshot creation time and the current time will be lost. Therefore, back up important data.'."\n" + ."\n" + .'- You must shut down the cloud computer to which the disk belongs.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-09-09T06:00:55.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSnapshot'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ScopeValue', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The effective scopes. This parameter is required when `Scope` is set to `IP`. If `Scope` is set to `IP`, this parameter doesn\'t take effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/24', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 50, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'RevokeCoordinatePrivilege' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientType', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The types of Alibaba Cloud Workspace clients that end users can use to connect to cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client that end users can use to connect to cloud computers.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Specifies whether end users can use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n" - ."\n" - .'> If you don\'t specify `ClientType`, any client can be used to connect to cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: End users cannot use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n" - .'* on: End users can use the specified type of Alibaba Cloud Workspace client to connect to cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'ClientType' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client that end users can use to connect to cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: the web client.'."\n" - .'* android: the Android client.'."\n" - .'* ios: the iOS client.'."\n" - .'* windows: the Windows client.'."\n" - .'* macos: the macOS client.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'ios' => '', - 'windows' => '', - 'macos' => '', - ], - 'example' => 'windows', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'UsbSupplyRedirectRule', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The USB redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The USB redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'VendorId' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04**', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 2: enables USB redirection based on products.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 2 => '', - ], - 'example' => '2', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'UsbRedirectType' => [ - 'description' => 'Specifies whether to allow USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: allows USB redirection.'."\n" - .'* 2: forbids USB redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'ProductId' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08**', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AuthorizeSecurityPolicyRule', + 'name' => 'Uuid', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound.'."\n" - .'* inflow: inbound.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization policy of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests. If no \'\'access denied\'\' messages are returned, the requests either timed out or failed.'."\n" - .'* accept (default): accepts all requests.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule. The value range of this parameter varies based on the value of IpProtocol.'."\n" - ."\n" - .'* If IpProtocol is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If IpProtocol is set to ICMP, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to GRE, set the value to -1/-1.'."\n" - .'* If IpProtocol is set to ALL, set the value to -1/-1.'."\n" - ."\n" - .'For more information about the common ports, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP: the Transmission Control Protocol (TCP) protocol.'."\n" - .'* UDP: the User Datagram Protocol (UDP) protocol.'."\n" - .'* ALL: any type of protocol.'."\n" - .'* GRE: the Generic Routing Encapsulation (GRE) protocol.'."\n" - .'* ICMP: the Internet Control Message Protocol (ICMP) for (IPv4).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'UDP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'TCP', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value specifies a higher priority.\\'."\n" - .'Valid values: 1 to 60.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object of the security group rule. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.0.XX.XX/8', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => 'C78CA9E99315687575DD2844C1F3****', 'title' => ''], ], [ - 'name' => 'AuthorizeAccessPolicyRule', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The client IP address whitelists that you want to add. Once an IP address whitelist is configured, end users can only access cloud computers from the IP addresses listed in it.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address whitelist that you want to add.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block from which end users can connect to cloud computers. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the end user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zhangsan', 'title' => ''], ], [ - 'name' => 'DeviceRedirects', + 'name' => 'CoId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: enables device redirection.'."\n" - .'* usbRedirect: enables USB redirection.'."\n" - .'* off: disables any type of redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* printer'."\n" - .'* scanner'."\n" - .'* serialport'."\n" - .'* camera'."\n" - .'* adb'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'printer' => '', - 'scanner' => '', - 'serialport' => '', - 'camera' => '', - 'adb' => 'adb', - ], - 'example' => 'camera', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the stream coordination task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'co-fqsm6e8ee75w61fp9', 'title' => ''], ], [ - 'name' => 'DeviceRules', + 'name' => 'UserType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sandisk', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection.'."\n" - .'* usbRedirect: USB redirection.'."\n" - .'* off: redirection disabled.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* usbKey: UKeys.'."\n" - .'* other: other peripheral devices.'."\n" - .'* graphicsTablet: graphics tablets.'."\n" - .'* cardReader: card readers.'."\n" - .'* printer: printers.'."\n" - .'* scanner: scanners.'."\n" - .'* storage: storage devices.'."\n" - .'* camera: cameras.'."\n" - .'* networkInterfaceCard: NIC devices.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'usbKey' => 'U key', - 'other' => '', - 'graphicsTablet' => '', - 'cardReader' => '', - 'printer' => '', - 'scanner' => '', - 'storage' => '', - 'camera' => '', - 'networkInterfaceCard' => '', - ], - 'example' => 'storage', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2:0', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x55b1', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x0781', - ], - 'Platforms' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, + 'description' => 'The type of user who requires the coordinate permissions.'."\n" + ."\n" + .'Set the value to TENANT_ADMIN. Only tenant administrators can be granted with the coordinate permissions.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'TENANT_ADMIN', + 'enumValueTitles' => ['TENANT_ADMIN' => '租户管理员'], + 'title' => '', ], ], - [ - 'name' => 'WatermarkAntiCam', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable anti-screen capture for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables anti-screen capture for invisible watermarks.'."\n" - .'* on: enables anti-screen capture for invisible watermarks.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RevokeCoordinatePrivilege', + 'summary' => 'Revokes the coordinate permissions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeCoordinatePrivilege'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'RunCommand' => [ + 'summary' => 'Runs a PowerShell or Bat script on one or more cloud computers that run Windows.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'WatermarkPower', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The enhancement level for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - .'* low'."\n" - .'* medium'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - ], - 'example' => 'medium', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DomainResolveRuleType', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enforce the domain resolution policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: disables the domain resolution policy.'."\n" - .'* on: enables the domain resolution policy.'."\n", + 'description' => 'The type of the script.', + 'enumValueTitles' => ['RunPowerShellScript' => 'Runs a PowerShell script.', 'RunBatScript' => 'Runs a Bat script.'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'required' => true, + 'example' => 'RunPowerShellScript', + 'title' => '', ], ], [ - 'name' => 'ClipboardScope', + 'name' => 'CommandContent', 'in' => 'query', - 'schema' => [ - 'title' => '剪切板生效范围', - 'type' => 'string', - 'example' => 'GLOBAL', - 'enum' => [ - 'global', - 'grained', - ], - ], + 'schema' => ['description' => 'The script content in plaintext or Base64-encoded format.
'."\n" + .'The Base64-encoded script content cannot exceed 16 KB.
'."\n" + ."\n" + .'> If the script content is Base64-encoded, you must set the `ContentEncoding` parameter to `Base64`.', 'type' => 'string', 'required' => true, 'example' => 'ipconfig', 'title' => ''], ], [ - 'name' => 'ClipboardGraineds', + 'name' => 'Timeout', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '剪切板精细化控制配置', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GrainedType' => [ - 'type' => 'string', - 'enum' => [ - 'text', - 'richtext', - 'file', - 'picture', - ], - ], - 'ClipboardType' => [ - 'type' => 'string', - 'enum' => [ - 'off', - 'read', - 'readwrite', - 'write', - ], - ], - 'ClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ClipboardSizeUnit' => [ - 'type' => 'string', - ], - 'InClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'InClipboardSizeUnit' => [ - 'type' => 'string', - ], - 'OutClipboardSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'OutClipboardSizeUnit' => [ - 'type' => 'string', - ], - ], - ], - 'maxItems' => 4, - ], + 'schema' => ['description' => 'The script execution timeout, in seconds. Default value: 300.
'."\n" + .'A command times out if the script cannot be run due to issues such as process conflicts, missing modules, or an unavailable Cloud Assistant client. When a command times out, the system forcibly terminates the script process.
', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600', 'title' => ''], ], [ - 'name' => 'StatusMonitor', + 'name' => 'ContentEncoding', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the metric status entry in the DesktopAssistant menu.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'The encoding mode of the script content.'."\n" ."\n" - .'* off: doesn\'t display the metric status entry in the DesktopAssistant menu.'."\n" - .'* on: displays the metric status entry in the DesktopAssistant menu.'."\n", + .'> If you specify a value that is not a valid enumeration member, the system defaults to `PlainText`.', + 'enumValueTitles' => ['Base64' => 'Base64 encoding', 'PlainText' => 'The content is in plaintext and is not encoded. \\[Default]'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'example' => 'Base64', + 'title' => '', ], ], [ - 'name' => 'MobileRestart', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to display the Restart button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Restart button in the DesktopAssistant menu.'."\n" - .'* on: displays the Restart button in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'description' => 'The IDs of the cloud computers on which to run the script. You can specify up to 50 IDs.
'."\n" + .'The API call is considered successful if the script runs on at least one of the specified cloud computers. The call fails only if the script fails on all of them.
', + 'type' => 'array', + 'items' => ['description' => 'The cloud computer ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + 'required' => true, + 'maxItems' => 300, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MobileShutdown', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the Stop button in the DesktopAssistant menu when end users connect to cloud computers from Android clients.'."\n" - ."\n" - .'> This feature applies to only mobile clients of version 7.4.0 or later.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t display the Stop button in the DesktopAssistant menu.'."\n" - .'* on: displays the Stop button in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'If you specify this parameter, the command runs with the permissions of the specified end user.'."\n" + ."\n" + .'> This user must have a session history on the cloud computer. This means the user must have logged in after the cloud computer started and their session was not taken over by another user. This parameter is not supported for Linux cloud computers.', 'type' => 'string', 'required' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'ResolutionModel', + 'name' => 'CommandRole', 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The resolution type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* adaptive: adaptive resolution.'."\n" - .'* customer: fixed resolution.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'adaptive' => '', - 'customer' => '', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'InvokeId' => ['description' => 'The script execution ID. You can use this ID with the [DescribeInvocations](~~DescribeInvocations~~) operation to query the script\'s execution status.', 'type' => 'string', 'example' => 't-hz01qgsqj2n****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'adaptive', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'RunCommand', + 'changeSet' => [ + ['createdAt' => '2025-07-01T03:13:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-13T06:29:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-29T06:07:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResolutionWidth', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resolution width. Unit: pixel. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '720', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:RunCommand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeId\\": \\"t-hz01qgsqj2n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'SendVerifyCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ResolutionHeight', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resolution height. Unit: pixel. Valid values for cloud applications: 500 to 50000. Valid values for cloud computers: 480 to 4096.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1280', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Taskbar', + 'name' => 'VerifyCodeAction', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to display the application taskbar.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" + 'description' => 'The action that you want to perform by using the verification code.'."\n" ."\n" - .'Valid values:'."\n" + .'Valid value:'."\n" ."\n" - .'* off: doesn\'t display the application taskbar.'."\n" - .'* on: displays the application taskbar.'."\n", + .'- eds\\_cenID\\_securityverification: Use the verification code to verify the CEN instance.', + 'enumValueTitles' => ['eds_cenID_securityverification' => 'eds\\_cenID\\_securityverification'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'required' => true, + 'docRequired' => true, + 'example' => 'eds_cenID_securityverification', + 'title' => '', ], ], [ - 'name' => 'NoOperationDisconnect', + 'name' => 'ExtraInfo', 'in' => 'query', + 'schema' => ['description' => 'The information that is required to send the verification code, in JSON format. When you verify the CEN instance of another Alibaba Cloud account, you must provide the ID of the CEN instance and the ID of the Alibaba Cloud account to which the instance belongs.'."\n" + ."\n" + .'- CenId: the ID of the CEN instance.'."\n" + ."\n" + .'- CenOwnerId: the ID of the Alibaba Cloud account to which the CEN instance belongs.'."\n" + ."\n" + .'> If you own the CEN instance, skip this parameter. If you do not own the CEN instance, specify the ID of the Alibaba Cloud account that owns the CEN instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"cenOwnerId": 1234567890******,"cenId": "cen-3weq30r6t0s7t4****"}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enforce a disconnection upon inactivity.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: doesn\'t enforce a disconnection upon inactivity.'."\n" - .'* on: enforces a disconnection upon inactivity.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The object that is returned.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'SendVerifyCode', + 'summary' => 'Obtains the verification code that is required when you bind an advanced office network to a Cloud Enterprise Network (CEN) instance that belongs to another Alibaba Cloud account.', + 'description' => 'You must call this operation to obtain the verification code that is required when you bind an advanced office network to a CEN instance that belongs to another Alibaba Cloud account. After you call this operation, the system sends a verification code to the email address associated with the Alibaba Cloud account to which the CEN instance belongs.', + 'changeSet' => [ + ['createdAt' => '2021-10-28T07:27:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SendVerifyCode'], + ], + ], + 'ramActions' => [ [ - 'name' => 'NoOperationDisconnectTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of disconnection after inactivity. Valid values: 120 to 7200. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:SendVerifyCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'SetDesktopGroupScaleTimer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'DisconnectKeepSession', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to retain the session upon disconnection.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* customTime: retains the session for a specified time period.'."\n" - .'* persistent: retains the session permanently.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'customTime' => '', - 'persistent' => '', - ], - 'example' => 'customTime', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DisconnectKeepSessionTime', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the session after disconnection. Valid values: 30 to 7200. Unit: seconds.'."\n" - ."\n" - .'> This parameter applies only to cloud application policies.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The ID of the cloud computer pool.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****', 'title' => ''], ], [ - 'name' => 'RecordEvents', + 'name' => 'ScaleTimerInfos', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The events that trigger screen recording.'."\n", + 'description' => 'The information about the scheduled auto scaling task.', 'type' => 'array', 'items' => [ - 'description' => 'The event that triggers screen recording.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* transferWithLocal: clipboard and file transfer events.'."\n" - .'* userInput: user input events.'."\n" - .'* usbRedirect: USB connection and disconnection events.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'transferWithLocal' => '', - 'userInput' => '', - 'usbRedirect' => '', + 'description' => 'The information about the scheduled auto scaling task.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the auto scaling policy.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- drop'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- normal'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- peak'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'- rise'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' ', + 'enumValueTitles' => ['drop' => '', 'normal' => '', 'peak' => '', 'rise' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'rise', + 'title' => '', + ], + 'RatioThreshold' => ['description' => 'The threshold for the ratio of connected sessions. This parameter is the condition that triggers auto scaling in a multi-session cloud computer pool. Formula:'."\n" + ."\n" + .'`Ratio of connected sessions = Number of connected sessions/(Total number of cloud computers × Maximum number of sessions allowed for each cloud computer) × 100%`.'."\n" + ."\n" + .'When the specified threshold is reached, new cloud computers are automatically created. When the specified threshold is not reached, idle cloud computers are released.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.85', 'title' => ''], + 'KeepDuration' => ['description' => 'The keep-alive duration of a session after the session is disconnected. Unit: milliseconds. Valid values: 180000 (3 minutes) to 345600000 (4 days). A value of 0 indicates that the session always keeps alive.'."\n" + ."\n" + .'If a session is disconnected by the end user or accidentally due to a factor and the end user does not re-establish a connection with the session within the keep-alive duration, the session expires and unsaved data is deleted. If the end user successfully re-establishes a connection with the session within the keep-alive duration, the end user returns to the session and can still access the original data.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '180000', 'title' => ''], + 'BuyResAmount' => ['description' => 'One option for the auto scaling policy. This option specifies the number of cloud computers that you want to create in the cloud computer pool. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'MinResAmount' => ['description' => 'One option for the auto scaling policy. This option specifies the minimum number of cloud computers that you must create in the cloud computer pool. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'MaxResAmount' => ['description' => 'One option for the auto scaling policy. This option specifies the maximum number of cloud computers that you can create in the cloud computer pool. Valid values: 0 to 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'Cron' => ['description' => 'The cron expression of the trigger time.', 'type' => 'string', 'required' => false, 'example' => '0 0 12 ? * 1', 'title' => ''], + 'LoadPolicy' => [ + 'description' => 'The load balancing policy for the multi-session cloud computer pool.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- 0: depth-first'."\n" + ."\n" + .'- 1: breadth first.', + 'enumValueTitles' => ['', ''], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'title' => '', + ], ], - 'example' => 'transferWithLocal', + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecordEventFilePaths', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The absolute paths to screen recording files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'C://test.txt', + 'description' => 'Schema of response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'required' => false, - 'maxItems' => 10, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'SetDesktopGroupScaleTimer', + 'summary' => 'Configures an auto scaling policy for a multi-session cloud computer. Elastic Desktop Service allows multiple end users to share a cloud computer in a multi-session cloud computer pool. This helps save costs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupScaleTimer'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RecordEventRegisters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The absolute paths to screen recording registries.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path to the screen recording registry.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetDesktopGroupScaleTimer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 10, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'SetDesktopGroupTimer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordEventDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The duration of screen recording after the specified event is detected. Unit: minutes. Valid values: 10 to 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'ResetDesktop', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The computer reset setting.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'DeviceConnectHint', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the peripheral connection prompt.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], + 'schema' => ['description' => 'The ID of the cloud computer share.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-dbdkfmh883****', 'title' => ''], ], [ - 'name' => 'FileMigrate', + 'name' => 'TimerType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable file transfer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', + 'description' => 'The type of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: scheduled reset'."\n" + .'* 2: scheduled startup'."\n" + .'* 3: scheduled stop'."\n" + .'* 4: scheduled restart', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [1 => '1', '2', '3', '4'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'WuyingKeeper', + 'name' => 'CronExpression', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable Cloud Computer Manager.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'off', - ], + 'schema' => ['description' => 'The cron expression for the scheduled task. This parameter is required when `TimerType` is set to 2, 3, or 4.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0 0 9 * * ?', 'title' => ''], ], [ - 'name' => 'InternetPrinter', + 'name' => 'ResetType', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The type of the disk that you want to reset.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- does not reset disks.'."\n" + .'- resets only the system disk.'."\n" + .'- resets only the user disk.'."\n" + .'- resets the system disk and the user disk.', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => ['does not reset disks.', 'resets only the system disk.', 'resets only the user disk.', 'resets the system disk and the user disk.'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'SafeMenu', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether to forcefully execute the scheduled task.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], - [ - 'name' => 'ScreenDisplayMode', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '388CF76E-FFB3-5174-9F91-CDD****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ClientControlMenu', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"388CF76E-FFB3-5174-9F91-CDD****\\"\\n}","type":"json"}]', + 'title' => 'SetDesktopGroupTimer', + 'summary' => 'Configures a scheduled start, stop, restart, or reset task for a cloud computer share.', + 'changeSet' => [ + ['createdAt' => '2024-02-04T08:49:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-11T08:21:03.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimer'], ], + ], + 'ramActions' => [], + ], + 'SetDesktopGroupTimerStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileTransferSpeedLocation', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'FileTransferSpeed', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FileTransferAddress', + 'name' => 'DesktopGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the cloud computer share.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-fgxsniu6at****', 'title' => ''], ], [ - 'name' => 'CpdDriveClipboard', + 'name' => 'TimerType', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The type of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: scheduled reset'."\n" + .'* 2: scheduled startup'."\n" + .'* 3: scheduled stop'."\n" + .'* 4: scheduled restart', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [1 => '', '', '', ''], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'UseTime', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The status of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 1: enabled'."\n" + .'* 2: disabled'."\n" + .'* 3: deleted'."\n" + .'* 100: unknown', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [1 => '', '', '', 100 => ''], + 'example' => '1', + 'title' => '', ], ], - [ - 'name' => 'AutoReconnect', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '客户端自动重连开关', - 'type' => 'string', - 'example' => 'off', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AC7912E7-8BDF-547F-BCAC****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC7912E7-8BDF-547F-BCAC****\\"\\n}","type":"json"}]', + 'title' => 'SetDesktopGroupTimerStatus', + 'summary' => 'Sets the status of a scheduled task for a cloud computer share, such as enabling or disabling it.', + 'changeSet' => [ + ['createdAt' => '2024-02-04T08:49:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-11T08:21:03.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimerStatus'], + ], + ], + 'ramActions' => [], + ], + 'SetDesktopMaintenance' => [ + 'summary' => 'Set the cloud computer maintenance mode.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MobileWuyingKeeper', - 'in' => 'query', - 'schema' => [ - 'title' => '移动端无影管家开关', - 'type' => 'string', - 'example' => 'off', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'MobileSafeMenu', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '移动端Windows 安全控制开关', - 'type' => 'string', - 'example' => 'off', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MobileWyAssistant', + 'name' => 'Mode', 'in' => 'query', 'schema' => [ - 'title' => '移动端小颖的开关', + 'description' => 'Enter or exit cloud computer maintenance mode.'."\n" + ."\n" + .'Enumerated values:'."\n" + ."\n" + .'* ENTER: The enters the maintenance mode.'."\n" + .'* EXIT: The exits the maintenance mode.'."\n", 'type' => 'string', - 'example' => 'off', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => ['ENTER' => '', 'EXIT' => ''], + 'example' => 'enter', + 'title' => '', ], ], [ - 'name' => 'RecordEventLevels', + 'name' => 'DesktopIds', 'in' => 'query', - 'style' => 'flat', + 'style' => 'repeatList', 'schema' => [ - 'title' => '录屏事件的级别', + 'description' => 'A list of cloud computer IDs for which you want to set maintenance mode. A maximum of 100 cloud computer IDs are supported.'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'title' => '事件类型', - 'type' => 'string', - 'example' => 'StartApplication', - ], - 'EventLevel' => [ - 'title' => '事件等级', - 'type' => 'string', - 'example' => 'HIGH', - ], - ], - ], - 'maxItems' => 20, + 'items' => ['description' => 'The ID of the cloud computer for which you want to set maintenance mode.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-dzeotbgawdnfo****', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecordEventFileExts', - 'in' => 'query', - 'style' => 'flat', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '录屏事件文件扩展名', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'example' => 'txt', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BA6A1853-3EA9-5EEB-86C8-3D14A3E01905', 'title' => ''], ], - 'maxItems' => 6, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ExternalDrive', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA6A1853-3EA9-5EEB-86C8-3D14A3E01905\\"\\n}","type":"json"}]', + 'title' => 'SetDesktopMaintenance', + 'description' => 'If you need to perform some maintenance operations on the cloud computer and want to prohibit end user from connecting and using the cloud computer during this period, you can switch it to maintenance mode.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopMaintenance'], ], + ], + 'ramActions' => [], + ], + 'SetDirectorySsoStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'WatermarkShadow', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ClientCreateSnapshot', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID. You can call [DescribeRegions](~~DescribeRegions~~) to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AcademicProxy', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the AD office network.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-h95efs1mbukd9****', 'title' => ''], ], [ - 'name' => 'ModelLibrary', + 'name' => 'EnableSso', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'Specifies whether to enable or disable single sign-on (SSO). Valid values:'."\n" + .'- true: enables SSO'."\n" + .'- false: disables SSO.', + 'enumValueTitles' => ['true' => 'enables SSO.', 'false' => 'disables SSO.'], + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'title' => '', ], ], - [ - 'name' => 'PortProxy', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + ], + 'title' => 'Set SSO status for an AD office network', + 'summary' => 'Enables or disables the single sign-on (SSO) feature for an AD-based office network.', + 'description' => 'This operation has the same effect as [SetOfficeSiteSsoStatus](~~SetOfficeSiteSsoStatus~~). Use the SetOfficeSiteSsoStatus operation instead.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDirectorySsoStatus'], ], + ], + 'ramActions' => [ [ - 'name' => 'DiskOverload', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:SetDirectorySsoStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'SetIdpMetadata' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CpuOverload', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'MemoryOverload', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResolutionDpi', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'maximum' => '400', - 'minimum' => '25', - ], + 'schema' => ['description' => 'The workspace ID. This parameter is the same as `OfficeSiteId`. We recommend that you use `OfficeSiteId` to replace `DirectoryId`. You can specify only `DirectoryId` or `OfficeSiteId`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-400695****', 'title' => ''], ], [ - 'name' => 'HoverConfigMsg', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****', 'title' => ''], ], [ - 'name' => 'MultiScreen', + 'name' => 'IdpMetadata', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The metadata of the IdP.'."\n", 'type' => 'string', 'required' => true, 'example' => '<EntityDescriptor ID********Descriptor>', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The information that is returned.'."\n", 'type' => 'object', 'properties' => [ - 'PolicyGroupId' => [ - 'description' => 'The cloud computer policy ID.'."\n", - 'type' => 'string', - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'IdpEntityId' => ['description' => 'The entity ID obtained after the IdP metadata file is parsed.'."\n", 'type' => 'string', 'example' => 'http://test****.cn/adfs/services/trust', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'CreateCenterPolicy', - ], - 'CloneCenterPolicy' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IdpEntityId\\": \\"http://test****.cn/adfs/services/trust\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F369A091-002F-49C8-AD55-02A776297C7B\\n http://test****.cn/adfs/services/trust\\n","errorExample":""}]', + 'title' => 'SetIdpMetadata', + 'summary' => 'Uploads the metadata of a Security Assertion Markup Language (SAML) 2.0-based identity provider (IdP).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetIdpMetadata'], + ], ], + 'ramActions' => [], + 'description' => 'You can call this operation only for workspaces of the Active Directory (AD) and convenience account types.'."\n", + ], + 'SetOfficeSiteSsoStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Set the value to cn-shanghai.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'cn-shanghai' => '', - ], - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceType', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app: cloud applications.'."\n" - .'* desktop: cloud computers.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 'app' => '', - 'desktop' => '', - ], - 'example' => 'desktop', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], ], [ - 'name' => 'BusinessType', + 'name' => 'EnableSso', 'in' => 'query', 'schema' => [ - 'description' => 'The business type.'."\n" + 'description' => 'Specifies whether to enable SSO.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* 1: public cloud'."\n" - .'* 8: commercial edition.'."\n", - 'type' => 'integer', - 'format' => 'int32', + .'* true'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .'* false'."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n" + ."\n" + .' '."\n", + 'type' => 'boolean', 'required' => true, - 'docRequired' => false, - 'enumValueTitles' => [ - 1 => '', - 8 => '', - ], - 'example' => '1', - ], + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the cloud computer policy that you want to clone.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'pg-gx2x1dhsmthe9****', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]', + 'title' => 'SetOfficeSiteSsoStatus', + 'summary' => 'Enables or disables single sign-on (SSO) for an office network.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-07T06:14:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetOfficeSiteSsoStatus'], + ], + ], + 'ramActions' => [], + ], + 'StartDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the cloud computer policy that you want to clone.'."\n", - 'type' => 'string', + 'description' => 'The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], 'required' => true, - 'docRequired' => false, - 'example' => 'testPolicyGroupName', + 'example' => 'ecd-7w78ozhjcwa3u****', + 'maxItems' => 100, + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of response.'."\n", 'type' => 'object', 'properties' => [ - 'PolicyGroupId' => [ - 'description' => 'The ID of the duplicated cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'CloneCenterPolicy', - 'summary' => 'Clones a policy based on an existing global policy.', - ], - 'CreatePolicyGroup' => [ - 'summary' => 'Creates a cloud computer policy.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53\\r\\n","errorExample":""}]', + 'title' => 'StartDesktops', + 'summary' => 'Starts stopped cloud computers. After the API operation is successfully called, the cloud computers enter the Running state.', + 'description' => 'The cloud computers that you want to start must be in the Stopped state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDesktops'], + ], ], + 'ramActions' => [], + ], + 'StopDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to get a list of regions that Elastic Desktop Service supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Clipboard', + 'name' => 'StoppedMode', 'in' => 'query', 'schema' => [ - 'description' => 'The permissions on the clipboard.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: specifies one-way transfer. You can copy files only from local devices to cloud computers.'."\n" - .'* readwrite: specifies two-way transfer. You can copy files between local devices and cloud computers.'."\n" - .'* write: specifies one-way transfer. You can only copy files from cloud computers to local devices.'."\n" - .'* off (default): disables both one-way and two-way transfer. Files cannot be copied between local devices and cloud computers.'."\n", + 'description' => 'Specifies the billing mode for the cloud desktops after they are stopped.', + 'enumValueTitles' => ['StopCharging' => 'Releases compute resources after the cloud desktops are stopped. This stops charges for compute resources, but billing for storage resources continues. (Default)', 'KeepCharging' => 'Retains all resources after the cloud desktops are stopped. This ensures that the cloud desktops can be restarted and avoids startup failures due to insufficient resources. Billing for all resources continues.'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'write' => '', - 'off' => '', - ], - 'example' => 'off', + 'example' => 'StopCharging', + 'title' => '', ], ], [ - 'name' => 'LocalDrive', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The permissions on local disk mapping.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: read-only. Local disk mapping is available on cloud computers. However, you can only read (copy) local files but cannot modify the files.'."\n" - .'* readwrite: read and write. Local disk mapping is available on cloud computers. You can read (copy) and write (modify) local files.'."\n" - .'* off (default): disabled. Local disk mapping is unavailable on cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'off' => '', - ], - 'example' => 'off', + 'description' => 'An array of 1 to 100 cloud desktop IDs.', + 'type' => 'array', + 'items' => ['description' => 'A cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-7w78ozhjcwa3u****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'UsbRedirect', + 'name' => 'OsUpdate', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: USB redirection is disabled. This value is the default value.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* on: USB redirection is enabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to apply pending patch updates.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'VisualQuality', + 'name' => 'PatchId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'example' => 'KB5082063', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'CreateSnapshot', 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['type' => 'string', 'example' => 'false', 'description' => '', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The policy for image display quality.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* low'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* lossless'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* medium: adaptive. This value is the default value.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'lossless' => '', - 'medium' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'medium', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'StopDesktops', + 'summary' => 'Stops one or more running cloud desktops. After a successful call, the specified cloud desktops enter the Stopped state.', + 'description' => 'The cloud desktops must be in the Running state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDesktops'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Html5Access', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to allow web client access.'."\n" - ."\n" - .'> We recommend that you use the ClientType-related parameters to control the Alibaba Cloud Workspace client type for cloud computer logon.``'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:StopDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'off', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'StopInvocation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Html5FileTransfer', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'InvokeId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the execution.', 'type' => 'string', 'required' => true, 'example' => 't-hz059ngm63k****', 'title' => ''], + ], + [ + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The file transfer feature on the web client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: Files can be uploaded and downloaded between local computers and the web client.'."\n" - .'* download: Files on the web client can be downloaded to local computers.'."\n" - .'* upload: Files on local computers can be uploaded to the web client.'."\n" - .'* off (default): Files cannot be transferred between the web client and local computers.'."\n", - 'type' => 'string', + 'description' => 'The ID of cloud desktop N. Valid values of N: 1 to 50.', + 'type' => 'array', + 'items' => ['description' => 'The ID of cloud desktop N.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'all' => '', - 'download' => '', - 'upload' => '', - 'off' => '', + 'example' => 'ecd-7w78ozhjcwa3u****', + 'maxItems' => 50, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'StopInvocation', + 'summary' => 'Stop a process that executes the Cloud Assistant script in one or more cloud computers.', + 'description' => 'When you stop a one-time execution of a command, the command continues to run on the cloud desktops where it has started to run, and will not run on the cloud desktops where it has not started to run.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInvocation'], + ], + ], + 'ramActions' => [ [ - 'name' => 'Watermark', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermarking feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* blind: Invisible watermarks are applied.'."\n" - .'* off (default): The watermarking feature is disabled.'."\n" - .'* on: Visible watermarks are applied.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'blind' => '', - 'off' => '', - 'on' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:StopInvocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'off', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Name', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions supported by Wuying Cloud Desktop.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the policy.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => 'Cloud desktop'], 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'testPolicyGroupName', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::GWS::INSTANCE', + 'title' => '', ], ], [ - 'name' => 'WatermarkType', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The watermark content. You can select up to three items as the watermark content. Separate multiple items with commas (,).'."\n" - ."\n" - .'> If you set this parameter to `Custom`, specify `WatermarkCustomText`'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username.'."\n" - .'* Custom: the custom text.'."\n" - .'* DesktopIp: the IP address of the cloud computer.'."\n" - .'* ClientIp: the IP address of the Alibaba Cloud Workspace client.'."\n" - .'* HostName: the rightmost 15 digits of the cloud computer ID.'."\n" - .'* ClientTime: the current time displayed on the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EndUserId' => '', - 'Custom' => '', - 'DesktopIp' => '', - 'ClientIp' => '', - 'HostName' => '', - 'ClientTime' => '', - ], - 'example' => 'EndUserId', + 'description' => 'The list of resource IDs, that is, the list of cloud desktop IDs. You can specify 1 to 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The resource ID, that is, the cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-ia2zw38bi6cm7****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'WatermarkTransparency', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The transparency of the watermark.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LIGHT'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DARK'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* MIDDLE'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LIGHT' => '', - 'DARK' => '', - 'MIDDLE' => '', + 'description' => 'The list of tags. You can specify 1 to 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. If you specify this parameter, the value cannot be an empty string. The value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], + 'Value' => ['description' => 'The tag value. The value can be an empty string. The value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'design', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'example' => 'LIGHT', + 'required' => true, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PreemptLogin', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The cloud computer preemption feature.'."\n" - ."\n" - .'> To ensure user experience and data security, when a cloud computer is used by an end user, other end users cannot connect to the cloud computer. By default, this parameter is set to `off`, which cannot be modified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default): Multiple end users cannot connect to the same cloud computer at the same time.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', + 'description' => 'The returned object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Adds tags to cloud desktops', + 'summary' => 'Adds tags to specified cloud desktops. This makes it easier to filter and manage cloud desktops by tag.', + 'description' => 'If the specified TagKey already exists, the new TagValue overwrites the original TagValue.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-04-17T08:21:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'TransferTaskApprovalCallback' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the transmission task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'trt-msndfksm18fs****', 'title' => ''], + ], [ - 'name' => 'DomainList', + 'name' => 'Result', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether the access control for domain names is enabled. Domain names support wildcards (\\*). Separate multiple domain names with commas (,).'."\n" + 'description' => 'The approval result.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* off'."\n" - .'* on'."\n", + .'* Approved'."\n" + .'* Rejected'."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'enumValueTitles' => ['Approved' => '', 'Rejected' => ''], + 'example' => 'Approved', + 'title' => '', ], ], [ - 'name' => 'PrinterRedirection', + 'name' => 'OssBucketRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the OSS bucket storing the file resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OssBucketName', 'in' => 'query', + 'schema' => ['description' => 'The name of the OSS bucket where the file resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ed****-17337752804***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The policy for printer redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: Printer redirection is disabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* on: Printer redirection is enabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AE7B699F-625C-587E-BC5F-1395CA****', 'title' => ''], ], - 'example' => 'on', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'TransferTaskApprovalCallback', + 'summary' => 'Queries the transmission and approval result for a submitted file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA****\\"\\n}","type":"json"}]', + ], + 'UnbindConfigGroup' => [ + 'summary' => 'Unbinds a configuration group from resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], + ], [ - 'name' => 'PreemptLoginUser', + 'name' => 'Type', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The usernames that are allowed to connect to the cloud computer in use. You can specify up to five usernames.'."\n" + 'description' => 'The type of the configuration group.'."\n" ."\n" - .'> To ensure user experience and data security, other end users cannot connect to the cloud computer that is used by an end user.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username that can preempt to connect to the cloud computer in use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], - 'required' => false, - 'example' => 'Alice', - 'maxItems' => 5, + .'Valid value:'."\n" + ."\n" + .'* Timer: the scheduled task type.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => ['Timer' => ''], + 'example' => 'Timer', + 'title' => '', ], ], [ - 'name' => 'AuthorizeSecurityPolicyRule', + 'name' => 'ResourceInfos', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The security group rules.'."\n", + 'description' => 'The resources from which you want to unbind the configuration group.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The security group rule.'."\n", + 'description' => 'The resource from which you want to unbind the configuration group.'."\n", 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound.'."\n" - .'* inflow: inbound.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization of the security group rule.'."\n" + 'ResourceId' => ['description' => 'The ID of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-ctwj0bk3l5nz****', 'title' => ''], + 'ResourceRegionId' => ['description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-chengdu', 'title' => ''], + 'ResourceType' => [ + 'description' => 'The type of the resource.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* drop: denies all access requests. If no messages of access denied are returned, the requests timed out or failed.'."\n" - .'* accept (default): accepts all requests.'."\n", + .'* RESOURCE_GROUP: the resource group.'."\n" + .'* CLOUD_DESKTOP: the cloud computer service.'."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', + 'enumValueTitles' => ['RESOURCE_GROUP' => '', 'CLOUD_DESKTOP' => ''], + 'example' => 'CLOUD_DESKTOP', + 'title' => '', ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule. The value range of this parameter varies based on the value of the IpProtocol parameter.'."\n" + 'ProductType' => [ + 'description' => 'The service type of the resource.'."\n" ."\n" - .'* If the IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If the IpProtocol parameter is set to ICMP, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to GRE, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to ALL, set the value to -1/-1.'."\n" + .'Valid value:'."\n" ."\n" - .'For more information about the common ports applied in EDS, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", + .'* CLOUD_DESKTOP: the cloud computer service.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP: the Transmission Control Protocol (TCP) protocol.'."\n" - .'* UDP: the User Datagram Protocol (UDP) protocol.'."\n" - .'* ALL: all protocols.'."\n" - .'* GRE: the Generic Routing Encapsulation (GRE) protocol.'."\n" - .'* ICMP: the Internet Control Message Protocol (ICMP) for IPv4.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'UDP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'tcp', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value indicates a higher priority.\\'."\n" - .'Valid values: 1 to 60.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object to which the security group rule applies. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', + 'enumValueTitles' => ['CLOUD_DESKTOP' => ''], + 'example' => 'CLOUD_DESKTOP', + 'title' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - 'maxItems' => 200, + 'required' => true, + 'maxItems' => 500, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AuthorizeAccessPolicyRule', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The client IP address whitelist. After you configure the whitelist, end users can access cloud computers only from the IP addresses in the whitelist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address that you want to add to the whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'North China Branch'."\n", - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block from which end users can connect to cloud computers. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'AD0FF13D-FC7D-56AD-934F-91C8487*****'], + 'GroupIds' => [ + 'description' => 'The IDs of the configuration groups.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the configuration group.'."\n", 'type' => 'string', 'example' => 'ccg-0cfaiedov605c****', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 100, + 'example' => '', ], ], + ], + 'title' => 'UnbindConfigGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD0FF13D-FC7D-56AD-934F-91C8487*****\\",\\n \\"GroupIds\\": [\\n \\"ccg-0cfaiedov605c****\\"\\n ]\\n}","type":"json"}]', + ], + 'UnlockVirtualMFADevice' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientType', + 'AK' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The logon method control rules to limit the type of the Alibaba Cloud Workspace client used by end users to connect to cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The logon method control rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Specifies whether to allow end users to use a specific type of the client to connect to cloud computers.'."\n" - ."\n" - .'> If you do not specify the `ClientType` parameter, all types of the client are allowed by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', - ], - 'ClientType' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client.'."\n" - ."\n" - .'> If you do not specify the `ClientType` parameter, all types of the client are allowed by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: web client'."\n" - .'* android: Android client'."\n" - .'* ios: iOS client'."\n" - .'* windows: Windows client'."\n" - .'* macos: macOS client'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'ios' => '', - 'windows' => '', - 'macos' => '', - ], - 'example' => 'windows', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GpuAcceleration', + 'name' => 'SerialNumber', 'in' => 'query', + 'schema' => ['description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" + ."\n" + .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device bound to Active Directory (AD) users.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable the Image Quality Control feature. If you have high requirements on the performance and user experience in scenarios such as professional design, we recommend that you enable this feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'UnlockVirtualMFADevice', + 'summary' => 'Unlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnlockVirtualMFADevice'], + ], + ], + 'ramActions' => [ [ - 'name' => 'UsbSupplyRedirectRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The USB redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The USB redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'VendorId' => [ - 'description' => 'The ID of the vendor. For more information, see [Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04**', - ], - 'ProductId' => [ - 'description' => 'The ID of the service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08**', - ], - 'Description' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test rule'."\n", - ], - 'UsbRedirectType' => [ - 'description' => 'The type of USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: allows USB redirection'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2: forbids USB redirection'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'DeviceClass' => [ - 'description' => 'The class of the device. If you set the `usbRuleType` parameter to 1, you must specify this parameter. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0Eh', - ], - 'DeviceSubclass' => [ - 'description' => 'The subclass of the device. If you set the `usbRuleType` parameter to 1, you must specify this parameter. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxh', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: by device class'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* 2: by device vendor'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - ], - 'required' => false, + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:UnlockVirtualMFADevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'maxItems' => 100, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'summary' => '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.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'DomainResolveRuleType', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service (EDS).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the domain name resolution policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* ON'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + 'description' => 'The type of the resource.', + 'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => 'Cloud desktop'], 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'OFF', + 'required' => true, + 'docRequired' => true, + 'example' => 'ALIYUN::GWS::INSTANCE', + 'title' => '', ], ], [ - 'name' => 'DomainResolveRule', + 'name' => 'All', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to unbind all tags from the resource. This parameter takes effect only when TagKey.N is not specified. Default value: false.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The details of the domain name resolution rule.'."\n", + 'description' => 'The IDs of the resources, that is, the IDs of the cloud desktops. You can specify 1 to 50 IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The domain name resolution rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.baidu.com', - ], - 'Policy' => [ - 'description' => 'Specifies whether to allow the domain name resolution rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow: allows the rule.'."\n" - .'* block: denies the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'allow', - ], - 'Description' => [ - 'description' => 'The description of domain name resolution rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system policy', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, + 'items' => ['description' => 'The ID of the resource, that is, the ID of the cloud desktop.', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-ia2zw38bi6cm7****', + 'maxItems' => 50, + 'title' => '', ], ], [ - 'name' => 'Recording', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable the screen recording feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* byaction_cmd_ft: enables the operation-triggered screen recording upon command execution and file transfer.'."\n" - .'* ALLTIME: enables the whole-process screen recording. That is, the recording starts when cloud computers are connected and ends when the cloud computers are disconnected.'."\n" - .'* session: enables the screen recording for session lifecycle listening.'."\n" - .'* PERIOD: enables the interval-based screen recording. You must specify an interval between the start time and end time of this type of recording.'."\n" - .'* byaction_commands: enables the operation-triggered screen recording upon command execution.'."\n" - .'* OFF: disables the screen recording feature.'."\n" - .'* byaction_file_transfer: enables the operation-triggered screen recording upon file transfer.'."\n", - 'type' => 'string', + 'description' => 'The tag keys. You can specify 1 to 20 tag keys.', + 'type' => 'array', + 'items' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], 'required' => false, - 'enumValueTitles' => [ - 'byaction_cmd_ft' => '', - 'ALLTIME' => '', - 'session' => '', - 'PERIOD' => '', - 'byaction_commands' => '', - 'OFF' => '', - 'byaction_file_transfer' => '', + 'example' => 'TestKey', + 'maxItems' => 20, + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'example' => 'OFF', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'Remove tags from cloud desktops', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'UpdateFotaTask' => [ + 'summary' => 'Enables or disables the auto-push feature for an image update task.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordingStartTime', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the screen recording starts. The value is in the HH:MM:SS format. The value is meaningful only when you set the `Recording` parameter to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:00:00', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RecordingEndTime', + 'name' => 'TaskUid', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the screen recording ends. The value is in the HH:MM:SS format. The value is meaningful only when you set the `Recording` parameter to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:59:00', - ], + 'schema' => ['description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aot-c4khwrp9ocml4****', 'title' => ''], ], [ - 'name' => 'RecordingFps', + 'name' => 'UserStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n" + 'description' => 'Specifies whether to automatically push the image update task.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* 2'."\n" - .'* 5'."\n" - .'* 10'."\n" - .'* 15'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'- Running: automatically pushes the image update task.'."\n" + ."\n" + .'- Pending: does not automatically push the image update task.', + 'enumValueTitles' => ['Running' => '', 'Pending' => ''], + 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 2 => '2', - 5 => '5', - 10 => '10', - 15 => '15', + 'docRequired' => true, + 'example' => 'Pending', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], - 'example' => '2', + 'example' => '', ], ], + ], + 'title' => 'UpdateFotaTask', + 'description' => 'You can call this operation to manage each image update task. This operation is valid only when the auto-update switch in the image update module for global image updates is turned off. If the auto-update switch is turned on, the switches for each image update task are always turned on. If you want to turn on or off the auto-update switch, go to the Elastic Desktop Service console and choose **Operations > Image Updates** in the left-side navigation pane.', + 'changeSet' => [ + ['createdAt' => '2024-03-25T11:43:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFotaTask'], + ], + ], + 'ramActions' => [ [ - 'name' => 'RecordingExpires', - 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UpdateFotaTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + ], + 'UploadImage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CameraRedirect', + 'AK' => [], + ], + ], + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'OssObjectPath', + 'in' => 'query', + 'schema' => ['description' => 'The object path of the image file in Object Storage Service (OSS).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ossbucket:endpoint/object', 'title' => ''], + ], + [ + 'name' => 'ImageName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the image. The name must be 2 to 128 characters in length. The name must start with a letter but cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Win10_Test', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the image. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test description', 'title' => ''], + ], + [ + 'name' => 'OsType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the webcam redirection feature.'."\n" + 'description' => 'The type of the operating system.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* off: Webcam redirection is disabled.'."\n" + .'* Linux'."\n" ."\n" .' '."\n" ."\n" @@ -43026,7 +39385,7 @@ ."\n" .' '."\n" ."\n" - .'* on: Webcam redirection is enabled. This value is the default value.'."\n" + .'* Windows'."\n" ."\n" .' '."\n" ."\n" @@ -43035,667 +39394,159 @@ .' '."\n", 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', + 'docRequired' => false, + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], + 'example' => 'Windows', + 'title' => '', ], ], [ - 'name' => 'NetRedirect', + 'name' => 'GpuCategory', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the image is a GPU-accelerated image.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the network redirection feature.'."\n" - ."\n" - .'> This feature is in invitational preview and is not available to the public.'."\n" + 'description' => 'The protocol type.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* off (default): The network redirection feature is disabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* on: The network redirection feature is enabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + .'* ASP: in-house Adaptive Streaming Protocol (ASP)', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'docRequired' => false, + 'enumValueTitles' => ['ASP' => ''], + 'example' => 'ASP', + 'title' => '', ], ], [ - 'name' => 'AppContentProtection', + 'name' => 'DataDiskSize', + 'in' => 'query', + 'schema' => ['description' => 'The size of the data disk. Valid values: 80 to 500. Unit: GiB.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '5', 'example' => '80', 'title' => ''], + ], + [ + 'name' => 'GpuDriverType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the anti-screenshot feature.'."\n" + 'description' => 'The type of the pre-installed GPU driver.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* off: Anti-screenshot is disabled. This value is the default value.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* on: Anti-screenshot is enabled.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", + .'* gpu_grid9: This GPU driver is used on cloud computers of the following two specifications: graphics – 4 vCPUs, 23 GiB memory, 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, 8 GiB GPU memory.'."\n" + .'* gpu_custom: You can install the driver later.'."\n" + .'* gpu_grid12: This GPU driver is used on graphical cloud computers of specifications other than the following two specifications: graphics – 4 vCPUs, 23 GiB memory, & 4 GiB GPU memory, and graphics – 10 vCPUs, 46 GiB memory, & 8 GiB GPU memory.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', + 'enumValueTitles' => ['gpu_grid9' => '', 'gpu_custom' => '', 'gpu_grid12' => ''], + 'example' => 'gpu_grid9', + 'title' => '', ], ], [ - 'name' => 'RecordContent', + 'name' => 'LicenseType', 'in' => 'query', 'schema' => [ - 'description' => 'Specifies whether to enable the custom screen recording feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: Custom screen recording is disabled. This value is the default value.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* on: Custom screen recording is enabled.'."\n" + 'description' => 'The type of the license that is used to activate the operating system after the image is imported. Valid values:'."\n" ."\n" - .' '."\n" + .'* Auto: Elastic Desktop Service detects the operating system of the image and allocates a license to the operating system. In this mode, the system first checks whether a license allocated by an official Alibaba Cloud channel is specified in the `Platform`. If a license allocated by an official Alibaba Cloud channel is specified, the system allocates the license to the imported image. If no such license is specified, the BYOL (Bring Your Own License) mode is used.'."\n" + .'* Aliyun: The license that is allocated by an official Alibaba Cloud channel and is specified by `Platform` is used for the operating system distribution.'."\n" + .'* BYOL: The license that comes with the source operating system is used. When you use the BYOL mode, make sure that your license key is supported by Alibaba Cloud.'."\n" ."\n" - .' '."\n" + .'Default value: Auto.'."\n" ."\n" - .' '."\n", + .'> Windows 10 cannot be activated by Alibaba Cloud. Set the `LicenseType` to BYOL for Windows 10.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'OFF', + 'enumValueTitles' => ['Auto' => '', 'Aliyun' => '', 'BYOL' => ''], + 'example' => 'Auto', + 'title' => '', ], ], [ - 'name' => 'RecordContentExpires', + 'name' => 'EnableSecurityCheck', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration in which the custom screen recording is valid. Default value: 30. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'Specifies whether to enable security check.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'RemoteCoordinate', + 'name' => 'SystemDiskSize', 'in' => 'query', + 'schema' => ['description' => 'The size of the system disk. Unit: GiB.'."\n" + ."\n" + .'> The system disk must be at least as large as the image.'."\n", 'type' => 'string', 'required' => false, 'example' => '80', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The permission to control the keyboard and the mouse during remote assistance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* optionalControl: By default, this feature is disabled. You can enable it by applying permissions.'."\n" - ."\n" - .'* fullControl: The permission is granted.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* disableControl: The permission is revoked.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' ', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'optionalControl' => '', - 'fullControl' => '', - 'disableControl' => '', - ], - 'example' => 'fullControl', - ], - ], - [ - 'name' => 'RecordingDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file length of the screen recording. Unit: minutes. Screen recording files are split based on the specified file length and uploaded to Object Storage Service (OSS) buckets. When a screen recording file reaches 300 MB in size, the system preferentially performs rolling update for the file.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 10'."\n" - .'* 20'."\n" - .'* 30'."\n" - .'* 60'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 10 => '10', - 20 => '20', - 30 => '30', - 60 => '60', - ], - 'example' => '15', - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy takes effect based on the IP address.'."\n" - .'* GLOBAL: The policy takes effect globally.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'GLOBAL', - ], - ], - [ - 'name' => 'ScopeValue', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'This parameter is required when the `Scope` parameter is set to `IP`.````'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/24', - ], - 'required' => false, - 'maxItems' => 3, - ], - ], - [ - 'name' => 'RecordingAudio', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record audio files generated from cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: records only video files.'."\n" - .'* on: records video and audio files.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'InternetCommunicationProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol for network communication.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP (default): TCP'."\n" - .'* BOTH: TCP and UDP'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'BOTH' => '', - ], - 'example' => 'both', - ], - ], - [ - 'name' => 'VideoRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the multimedia redirection switch.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'WatermarkTransparencyValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark opacity. A larger value indicates more opaque watermarks. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'WatermarkColor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The font color in red, green, and blue (RGB) of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'WatermarkDegree', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark rotation. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '-10', - ], - ], - [ - 'name' => 'WatermarkFontSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark font size. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'WatermarkFontStyle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark font style.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* plain'."\n" - .'* bold'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'plain' => '', - 'bold' => '', - ], - 'example' => 'plain', - ], - ], - [ - 'name' => 'WatermarkRowAmount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of watermark rows.'."\n" - ."\n" - .'> This parameter is not available for public use.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - [ - 'name' => 'EndUserApplyAdminCoordinate', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on the Contact Administrator for Help switch.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', - ], - ], - [ - 'name' => 'EndUserGroupCoordinate', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on the User Stream Collaboration switch.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', - ], - ], - [ - 'name' => 'WatermarkSecurity', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the security priority feature for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'AdminAccess', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether end users have the administrator permissions.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'deny', - ], - ], - [ - 'name' => 'WatermarkAntiCam', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the anti-screen photo feature for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', + 'description' => 'The information that is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ImageId' => ['description' => 'The ID of the custom image.'."\n", 'type' => 'string', 'example' => 'm-d4dwr5tgrgvd****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****', 'title' => ''], ], - 'example' => 'off', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'WatermarkPower', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark enhancement feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - .'* low'."\n" - .'* medium'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - ], - 'example' => 'medium', - ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'UploadImage', + 'summary' => 'Uploads your custom Windows image.', + 'description' => '> You can upload only Windows images.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadImage'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-d4dwr5tgrgvd****\\",\\n \\"RequestId\\": \\"2CC66B0A-BA3B-5D87-BFBE-11AAAD7A****\\"\\n}","type":"json"}]', + ], + 'VerifyCen' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecordingUserNotify', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the screen recording notification feature after end users log on to the Alibaba Cloud Workspace client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'RecordingUserNotifyMessage', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The notification content of screen recording. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Your desktop is being recorded.'."\n", - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MaxReconnectTime', + 'name' => 'CenId', 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum retry period for reconnecting to cloud computers when the cloud computers are disconnected due to none-human reasons. Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], + 'schema' => ['description' => 'The ID of the CEN instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cen-3gwy16dojz1m65****', 'title' => ''], ], [ - 'name' => 'DeviceRedirects', + 'name' => 'CenOwnerId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* printer'."\n" - .'* scanner'."\n" - .'* camera'."\n" - .'* adb: the Android Debug Bridge (ADB) device.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'printer' => '', - 'scanner' => '', - 'camera' => '', - 'adb' => '', - ], - 'example' => 'camera', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection'."\n" - .'* usbRedirect: USB redirection'."\n" - .'* off: redirection disabled'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'deviceRedirect', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The Alibaba Cloud account to which the CEN instance belongs.'."\n" + ."\n" + .'* If you own the CEN instance, you can skip this parameter.'."\n" + .'* If you do not own the CEN instance, you must specify the ID of the account that owns the CEN instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****', 'title' => ''], ], [ - 'name' => 'DeviceRules', + 'name' => 'CidrBlock', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* usbKey: UKeys.'."\n" - .'* other: other peripheral devices.'."\n" - .'* graphicsTablet: graphics tablets.'."\n" - .'* printer: printers.'."\n" - .'* cardReader: card readers.'."\n" - .'* scanner: scanners.'."\n" - .'* storage: storage devices.'."\n" - .'* camera: web cameras.'."\n" - .'* adb: Android Debug Bridge (ADB) devices.'."\n" - .'* networkInterfaceCard: NIC devices.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'usbKey' => 'UKey', - 'other' => '', - 'graphicsTablet' => '', - 'printer' => '', - 'cardReader' => '', - 'scanner' => '', - 'storage' => '', - 'camera' => '', - 'adb' => '', - 'networkInterfaceCard' => '', - ], - 'example' => 'storage', - ], - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sandisk', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x0781', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x55b1', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection'."\n" - .'* usbRedirect: USB redirection'."\n" - .'* off: redirection disabled'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2:0', - ], - 'Platforms' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The IPv4 CIDR block of the associated office network.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.168.0.0/16', 'title' => ''], ], [ - 'name' => 'WyAssistant', + 'name' => 'VerifyCode', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to provide the AI Assistant function in the DesktopAssistant when the cloud computer is accessed from the Alibaba Cloud Workspace desktop clients (including the Windows client and the macOS client).'."\n" - ."\n" - .'> Desktop clients of V7.7 and higher versions required.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- off: the AI Aisstant function is not provided.'."\n" - .'- on: the AI Aisstant function is provided.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], + 'schema' => ['description' => 'The verification code. If you do not own the CEN instance, you must call the [SendVerifyCode](~~436847~~) operation to obtain a verification code.'."\n", 'type' => 'string', 'required' => false, 'example' => '12****', 'title' => ''], ], ], 'responses' => [ @@ -43704,14055 +39555,5855 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'PolicyGroupId' => [ - 'description' => 'The cloud computer policy ID.'."\n", + 'Status' => [ + 'description' => 'The check result of CIDR block conflict.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* InvalidCen.CenUidInvalid: The Alibaba Cloud account is invalid or the Alibaba Cloud account does not have the permission to access Elastic Desktop Service.'."\n" + .'* VerifyCode.InvalidTokenCode: The verification code is invalid.'."\n" + .'* VerifyCode.ReachTokenRetryTime: The maximum number of times for entering a verification code reaches the limit.'."\n" + .'* Conflict: A CIDR block conflict exists. If the verification result of at least one route is Conflict, Conflict is returned for this parameter.'."\n" + .'* Access: The verification is passed. If the verification result for all routes is Access, Access is returned for this parameter.'."\n" + .'* InvalidCen.ParameterCenInstanceId: The Alibaba Cloud account does not own the CEN instance.', 'type' => 'string', - 'example' => 'pg-gx2x1dhsmthe9****', + 'enumValueTitles' => ['InvalidCen.CenUidInvalid' => '', 'VerifyCode.InvalidTokenCode' => '', 'VerifyCode.ReachTokenRetryTime' => '', 'Conflict' => '', 'Access' => '', 'InvalidCen.ParameterCenInstanceId' => ''], + 'example' => 'Access', + 'title' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0AF9D857-AE96-53D6-B317-5DD665EC4EC0', 'title' => ''], + 'CidrBlocks' => [ + 'description' => 'The recommended IPv4 CIDR blocks. Three CIDR blocks are randomly recommended. This parameter is returned when the `Status` value is `Conflict`.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The recommended IPv4 CIDR blocks. Three CIDR blocks are randomly recommended. This parameter is returned when the `Status` value is `Conflict`.'."\n", 'type' => 'string', 'example' => ' ["10.0.XX.XX","172.24.XX.XX","192.168.XX.XX"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RouteEntries' => [ + 'description' => 'The routes provided by the CEN instance.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the routes of the CEN instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The verification result of the route.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Conflict: A CIDR block conflict exists.'."\n" + .'* Access: The verification is passed.', + 'type' => 'string', + 'enumValueTitles' => ['Conflict' => '', 'Access' => ''], + 'example' => 'Access', + 'title' => '', + ], + 'NextHopInstanceId' => ['description' => 'The ID of the instance corresponding to the route.'."\n", 'type' => 'string', 'example' => 'vpc-uf62bu0xs5j8md54p****', 'title' => ''], + 'DestinationCidrBlock' => ['description' => 'The CIDR block of the route.'."\n", 'type' => 'string', 'example' => '172.16.XX.XX', 'title' => ''], + 'RegionId' => ['description' => 'The region ID of the route.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\npg-gx2x1dhsmthe9****\\n","errorExample":""}]', - 'title' => 'CreatePolicyGroup', - 'description' => 'A cloud computer policy is a collection of rules to manage cloud computers in performance and security. For example, you can create a basic policy that involves the disk mapping, USB redirection, watermarking features and rules such as DNS rules. For more information, see [Policy overview](~~189345~~).'."\n", + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'TransitRouterService.TrNotExistInRegion', 'errorMessage' => 'The transit router need create in current region.', 'description' => 'There is no transit router in the current region in the cloud enterprise network, please go to the cloud enterprise network console to create a new router.'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Access\\",\\n \\"RequestId\\": \\"0AF9D857-AE96-53D6-B317-5DD665EC4EC0\\",\\n \\"CidrBlocks\\": [\\n \\" [\\\\\\"10.0.XX.XX\\\\\\",\\\\\\"172.24.XX.XX\\\\\\",\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"RouteEntries\\": [\\n {\\n \\"Status\\": \\"Access\\",\\n \\"NextHopInstanceId\\": \\"vpc-uf62bu0xs5j8md54p****\\",\\n \\"DestinationCidrBlock\\": \\"172.16.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Access\\n \\n Access\\n 100.64.X.X/10\\n cn-shanghai\\n \\n \\n Access\\n 172.16.111.0/27\\n cn-shanghai\\n vpc-uf62bu0xs5j8md54****\\n \\n \\n Access\\n 192.168.0.0/24\\n cn-shanghai\\n vpc-uf6n17kvw0t15br3s****\\n \\n 06D87278-F765-5FC9-9978-ADD7DC070C7D\\n","errorExample":""}]', + 'title' => 'VerifyCen', + 'summary' => 'Verifies the ID of a Cloud Enterprise Network (CEN) instance and the ID of the Alibaba Cloud account to which the instance belongs and checks whether a CIDR block conflict exists between the routes of the instance and the IPv4 CIDR blocks of the associated office network.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeletePolicyGroups' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-09-23T07:04:51.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyCen'], + ], ], + 'ramActions' => [], + ], + 'WakeupDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by EDS.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PolicyGroupId', + 'name' => 'DesktopId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The cloud computer policy IDs. You can specify 1 to 100 policies.'."\n", + 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers.', 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer policy ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], + 'items' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-j2eoqgf5u4mwj****', 'title' => ''], 'required' => true, - 'example' => 'pg-gx2x1dhsmthe9****', 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameter.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6557DBA9-CF3E-5C1B-B1F1-68FDA599****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 8BBD24F5-DECA-48D8-B08C-15619790F07B\\r\\n","errorExample":""}]', - 'title' => 'DeletePolicyGroups', - 'summary' => 'Deletes one or more custom cloud computer policies.', - 'description' => '* You cannot delete the cloud computer policy created by the Elastic Desktop Service (EDS) system.'."\n" - .'* You cannot delete the cloud computer policies that are associated with cloud computers.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6557DBA9-CF3E-5C1B-B1F1-68FDA599****\\"\\n}","type":"json"}]', + 'title' => 'WakeupDesktops', + 'summary' => 'Wakes up cloud computers.', + 'description' => 'Only cloud computers that are in the Hibernated state can be waked up.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '160', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WakeupDesktops'], + ], + ], + 'ramActions' => [], ], - 'ModifyPolicyGroup' => [ - 'summary' => 'Modifies the cloud computer policy.', - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-beijing.aliyuncs.com', 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-qingdao.aliyuncs.com', 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-shanghai.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-hongkong.aliyuncs.com', 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-nanjing.aliyuncs.com', 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-northeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-chengdu.aliyuncs.com', 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-guangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-5.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-6.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-7.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.eu-west-1.aliyuncs.com', 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.us-west-1.aliyuncs.com', 'endpoint' => 'ecd.us-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.eu-central-1.aliyuncs.com', 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ecd.me-east-1.aliyuncs.com', 'endpoint' => 'ecd.me-east-1.aliyuncs.com', 'vpc' => 'ecd-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ecd.me-central-1.aliyuncs.com', 'endpoint' => 'ecd.me-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'ecd-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'App.Authing', 'message' => 'App is authing.', 'http_code' => 400, 'description' => 'The app is being set to be visible, please try again later.'], + ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'], + ['code' => 'Benefit.NotExist', 'message' => 'The specified benefit is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Benefit.StockInsufficient', 'message' => 'The specified benefit is out of stock.', 'http_code' => 400, 'description' => ''], + ['code' => 'Channel.NotExist', 'message' => 'The specified channel is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Channel.TokenInvalid', 'message' => 'The channel service request token is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ChooseClusterError.ZoneId', 'message' => 'Cannot choose zone, please try other zone.', 'http_code' => 400, 'description' => 'The property of the resource zone does not match. Check whether the target office network supports the zone to which the resource belongs.'], + ['code' => 'DeletedBundleStatus', 'message' => 'The specified bundle status is deleted.', 'http_code' => 400, 'description' => 'The specified template has been deleted'], + ['code' => 'DesktopCpuHighLoad%s', 'message' => 'The specified desktop cpu high load.', 'http_code' => 400, 'description' => 'The CPU usage of this cloud computer is too high, causing the connection to time out. The application with the highest CPU usage is% s. Please reconnect or restart the cloud computer. If the connection failure still occurs, contact your IT administrator.'], + ['code' => 'DesktopMemoryHighLoad%s', 'message' => 'The specified desktop memory high load.', 'http_code' => 400, 'description' => 'A time out error occurred when connecting to this cloud computer because the memory usage of it is too high. The app consuming the most memory is %s. Please reconnect or restart the cloud computer. If the issue persists, please contact your IT administrator.'], + ['code' => 'ExistedFingerPrintTemplate', 'message' => 'The fingerprint is already registered as %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExistedHostname', 'message' => 'The specified hostname is existed on the domain.', 'http_code' => 400, 'description' => 'The specified hostname already exists in the current workspace'], + ['code' => 'ExportDesktop.UnknowError', 'message' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExportDesktopGroup.UnknowError', 'message' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => ''], + ['code' => 'FengyuTestCode1.%s', 'message' => 'FengyuTestMsg1.%s.', 'http_code' => 400, 'description' => 'Feng Yu Test Dynamic Error Description 1, Dynamic Error Message (%s)'], + ['code' => 'FengyuTestCode2', 'message' => 'FengyuTestMsg2.', 'http_code' => 400, 'description' => 'Feng Yu tests Chinese'], + ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'User does not have permission to operate on the specified resource'], + ['code' => 'FOTAVersion.NotSupported', 'message' => 'Desktop version does not support this function, please upgrade.', 'http_code' => 400, 'description' => 'The current desktop version does not support this feature. Update the version.'], + ['code' => 'HostnameCannotCustomizeForLinux', 'message' => 'Customizing hostname is not supported for Linux desktop.', 'http_code' => 400, 'description' => 'The custom hostname feature does not support Linux desktops'], + ['code' => 'IncorrectDirectoryStatus', 'message' => 'Only registered directory can create desktop.', 'http_code' => 400, 'description' => 'Workspace status error, only desktop creation with registered workspace is supported'], + ['code' => 'IncorrectDirectoryType', 'message' => 'The protocol type of directory and desktop do not match.', 'http_code' => 400, 'description' => 'The protocol types of the specified workspace and the target desktop do not match, please check'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAmount', 'message' => 'The specified Amount is not a valid value.', 'http_code' => 400, 'description' => 'The specified quantity is illegal'], + ['code' => 'InvalidAmount.NotTimesOfUsers', 'message' => 'The specified Amount is notmatch EndUserId size.', 'http_code' => 400, 'description' => 'The number of desktops specified is not equal to the number of users to be assigned, please re-specify'], + ['code' => 'InvalidClientIp.Policy', 'message' => 'Client ip %s is not in white list.', 'http_code' => 400, 'description' => 'The IT administrator has set an IP whitelist policy that prevents you from connecting to this cloud computer under your current IP environment (%s). Please contact the IT administrator.'], + ['code' => 'InvalidDesktopBundle.NotFound', 'message' => 'The specified param BundleId is not found.', 'http_code' => 400, 'description' => 'Specified BundleId not found'], + ['code' => 'InvalidDirectoryId.NotFound', 'message' => 'The specified param DirectoryId is not found.', 'http_code' => 400, 'description' => 'Unable to find workspace ID, please check workspace'], + ['code' => 'InvalidDirectoryType.NotSupported', 'message' => 'The specified DirectoryType is not supported.', 'http_code' => 400, 'description' => 'Specified'], + ['code' => 'InvalidEncryptionEnabled.Invalid', 'message' => 'The parameter VolumeEncryptionEnabled is invalid.', 'http_code' => 400, 'description' => 'When specifying the encryption key, you need to turn on the disk encryption function.'], + ['code' => 'InvalidEncryptionKey.Missing', 'message' => 'Parameter VolumeEncryptionKey is missing.', 'http_code' => 400, 'description' => 'When the disk encryption function is enabled, the encryption key cannot be empty.'], + ['code' => 'InvalidEncryptionKey.NotAuthorized', 'message' => 'Eds service cannot access the given VolumeEncryptionKey.', 'http_code' => 400, 'description' => 'Unable to access unauthorized encryption keys'], + ['code' => 'InvalidEncryptionKey.NotFound', 'message' => 'The specified VolumeEncryptionKey is not found.', 'http_code' => 400, 'description' => 'The specified encryption key could not be found'], + ['code' => 'InvalidFingerPrintTemplate', 'message' => 'The fingerprint template is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFingerPrintTemplateIndex', 'message' => 'The index of the fingerprint template is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageStatus.NotValid', 'message' => 'The specified image status is not valid.', 'http_code' => 400, 'description' => 'The status of the specified image is unavailable and cannot be created.'], + ['code' => 'InvalidImageVersion.NotSupported', 'message' => 'The specified image version is no longer supported.', 'http_code' => 400, 'description' => 'The specified image version is no longer supported. Please select another image.'], + ['code' => 'InvalidMemberIp.DesktopAmount', 'message' => 'The desktop amount need to be 1.', 'http_code' => 400, 'description' => 'When you specify an IP to create a desktop, the number of desktops can only be 1'], + ['code' => 'InvalidOssObjectPath.NotFound', 'message' => 'Cannot parse input oss object path. eg: http://bucket/object.vhd.', 'http_code' => 400, 'description' => 'It is detected that the uploaded image file is not available, please ensure that the correct custom image is uploaded to the specified OSS bucket address.'], + ['code' => 'InvalidParameter.ResourceId', 'message' => 'The specified parameter ResourceId is invalid.', 'http_code' => 400, 'description' => 'The specified parameter ResourceId is invalid.'], + ['code' => 'InvalidParameterError', 'message' => 'Cannot query with end user id and include assigned user.', 'http_code' => 400, 'description' => 'Querying unassigned user and end user ID at the same time is not supported.'], + ['code' => 'InvalidPolicyGroup.Status', 'message' => 'The target policy group is being created. Please try again later.', 'http_code' => 400, 'description' => ''], + ['code' => 'LockedUser', 'message' => 'User is locked.', 'http_code' => 400, 'description' => ''], + ['code' => 'NetworkSpace.DependencyViolation', 'message' => 'networkSpace dependency violation.', 'http_code' => 400, 'description' => 'Resources exist in the current office network and cannot be deleted directly.'], + ['code' => 'NetworkSpace.VpcInfoExist', 'message' => 'vpc info already exist.', 'http_code' => 400, 'description' => 'Office network already exists for the corresponding VPC'], + ['code' => 'NoStock.ZoneInvalid', 'message' => 'The requested resource is sold out in the specified zone.', 'http_code' => 400, 'description' => 'The specified resource is out of stock in the selected Availability Zone.'], + ['code' => 'OperationTooFrequent', 'message' => 'The operation is too frequent, please try again later.', 'http_code' => 400, 'description' => 'Operation is too frequent, please try again later'], + ['code' => 'Order.Unpaid', 'message' => 'You have unpaid orders, please pay such orders before placing a new order.', 'http_code' => 403, 'description' => ''], + ['code' => 'ParamError.NoDesktopGroupId', 'message' => 'You must specify desktopGroupId.', 'http_code' => 400, 'description' => ''], + ['code' => 'Protocol.NotAllowed', 'message' => 'Procotol of the image is not allowed.', 'http_code' => 400, 'description' => 'The protocol type of the image is not supported. Check the image ID.'], + ['code' => 'RedeemCode.QuantityExceeded', 'message' => 'The number of redeem codes obtained at a time is out of the valid range.', 'http_code' => 400, 'description' => ''], + ['code' => 'RESOURCE_GROUP_ALREADY_BOUND_APP_RULE', 'message' => 'Resource group already bound app rule.', 'http_code' => 400, 'description' => 'The resource group to which the cloud computer belongs is binding/unbinding application control rules.'], + ['code' => 'RISK.RISK_CONTROL_REJECTION', 'message' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', 'http_code' => 400, 'description' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.'], + ['code' => 'SALES_SERVICE_ERROR_INFORMATION', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your information is incomplete. Please complete all required fields here(超链接：https://myaccount.alibabacloud.com/user_info.htm?callback=#/userinfo ) before proceeding.'], + ['code' => 'StartApplicationFail', 'message' => 'The application start fail.', 'http_code' => 400, 'description' => 'Failed to start, please go to the "start" menu of win system to open shadowless housekeeper'], + ['code' => 'StartApplicationGuestNoApp', 'message' => 'The application no start app.', 'http_code' => 400, 'description' => 'Please go to shadowless application center to download shadowless butler'], + ['code' => 'StartApplicationGuestOffline', 'message' => 'The application guest offline.', 'http_code' => 400, 'description' => 'Desktop exception, please go to the "start" menu of win system to open shadowless housekeeper'], + ['code' => 'StartApplicationGuestTimeout', 'message' => 'The application guest timeout.', 'http_code' => 400, 'description' => 'The call timed out, please go to the "start" menu of win system to open shadowless housekeeper.'], + ['code' => 'Throttling.FingerPrintTemplateSet', 'message' => 'The previous fingerprint template setting is not completed yet.', 'http_code' => 400, 'description' => ''], + ['code' => 'TooManyFingerPrintTemplateForDevice', 'message' => 'The maximum number of fingerprint templates that any user can save on the current device is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'TooManyFingerPrintTemplateForUser', 'message' => 'The maximum number of fingerprint templates that you can save in the current environment is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'TransitRouterService.TrNotExistInRegion', 'message' => 'The transit router need create in current region.', 'http_code' => 400, 'description' => 'There is no transit router in the current region in the cloud enterprise network, please go to the cloud enterprise network console to create a new router.'], + ['code' => 'UnavailableDesktop', 'message' => 'Authentication failure.', 'http_code' => 400, 'description' => 'Authentication failed, unable to connect.'], + ['code' => 'DesktopCanOnlyAssignedToOneUser', 'message' => 'The desktop can only assigned to one user.', 'http_code' => 400, 'description' => 'Forced connection is not allowed when multiple users are assigned to the cloud computer'], + ['code' => 'GET_APP_RULE_LOCK_FAILED', 'message' => 'Get app rule lock failed.', 'http_code' => 400, 'description' => 'The operation is too frequent, please try again later.'], + ['code' => 'INSUFFICIENT_QUOTA', 'message' => 'Insufficient quota.', 'http_code' => 400, 'description' => 'Insufficient user quota'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopMetadata'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopTypes'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-12-27T14:57:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTemplate'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTemplate'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-12-25T06:33:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeGlobalTimerRecords'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2025-12-24T11:16:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateConfigGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeConfigGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTimerGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTimerGroup'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testPolicyGroupName', - ], - ], - [ - 'name' => 'Clipboard', - 'in' => 'query', - 'schema' => [ - 'description' => 'The permissions on the clipboard.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: specifies one-way transfer. You can copy files only from local devices to cloud computers.'."\n" - .'* readwrite: specifies two-way transfer You can copy files between local devices and cloud computers.'."\n" - .'* write: specifies one-way transfer. You can only copy files from cloud computers to local devices.'."\n" - .'* off: disables both one-way and two-way transfer. Files cannot be copied between local devices and cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'write' => '', - 'off' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'LocalDrive', - 'in' => 'query', - 'schema' => [ - 'description' => 'The permissions on local disk mapping.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: read-only. Local disk mapping is available on cloud computers. However, you can only read (copy) local files but cannot modify the files.'."\n" - .'* readwrite: read and write. Local disk mapping is available on cloud computers. You can read (copy) and write (modify) local files.'."\n" - .'* off (default): no permissions. Local disk mapping is unavailable on cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'off' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'UsbRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the USB redirection feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'VisualQuality', - 'in' => 'query', - 'schema' => [ - 'description' => 'The image display quality.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high: high-definition (HD)'."\n" - .'* low: smoothness'."\n" - .'* lossless: no quality loss'."\n" - .'* medium (default): scenario-specific adaptation'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'lossless' => '', - 'medium' => '', - ], - 'example' => 'low', - ], - ], - [ - 'name' => 'Html5Access', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to allow web client access.'."\n" - ."\n" - .'> We recommend that you specify the ClientType-related parameters to control the Alibaba Cloud Workspace client type for cloud computer connection.``'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'Html5FileTransfer', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file transfer feature on the web client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: Files can be uploaded and downloaded between local computers and the web client.'."\n" - .'* download: Files on the web client can be downloaded to local computers.'."\n" - .'* upload: Files on local computers can be uploaded to the web client.'."\n" - .'* off (default): Files cannot be transferred between the web client and local computers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'all' => '', - 'download' => '', - 'upload' => '', - 'off' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'Watermark', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermarking feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* blind: Invisible watermarks are applied.'."\n" - .'* off: The watermarking feature is disabled.'."\n" - .'* on: Visible watermarks are applied.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'blind' => '', - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'WatermarkType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark content. You can select up to three items as the watermark content. Separate multiple items with commas (,).'."\n" - ."\n" - .'> If you set this parameter to `Custom`, you must specify `WatermarkCustomText`.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username'."\n" - .'* Custom: the custom text'."\n" - .'* DesktopIp: the IP address of the cloud computer'."\n" - .'* ClientIp: the IP address of the Alibaba Cloud Workspace client'."\n" - .'* HostName: the rightmost 15 digits of the cloud computer ID'."\n" - .'* ClientTime: the current time displayed on the cloud computer'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'EndUserId' => '', - 'Custom' => '', - 'DesktopIp' => '', - 'ClientIp' => '', - 'HostName' => '', - 'ClientTime' => '', - ], - 'example' => 'EndUserId', - ], - ], - [ - 'name' => 'WatermarkTransparency', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark transparency.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LIGHT (default)'."\n" - .'* DARK'."\n" - .'* MIDDLE'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'LIGHT' => '', - 'DARK' => '', - 'MIDDLE' => '', - ], - 'example' => 'LIGHT', - ], - ], - [ - 'name' => 'PreemptLogin', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer preemption feature.'."\n" - ."\n" - .'> To ensure user experience and data security, when a cloud computer is used by an end user, other end users cannot connect to the cloud computer. By default, this parameter is set to `off`, which cannot be modified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default): Multiple end users cannot connect to the same cloud computer at the same time.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'DomainList', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the access control for domain names is enabled. Domain names support wildcards (\\*). Separate multiple domain names with commas (,).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => '[black:],example1.com,example2.com', - ], - ], - [ - 'name' => 'PrinterRedirection', - 'in' => 'query', - 'schema' => [ - 'description' => 'The printer redirection feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'PreemptLoginUser', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The usernames that are allowed to connect to the cloud computer in use. You can specify up to five usernames.'."\n" - ."\n" - .'> To ensure user experience and data security, other end users cannot connect to the cloud computer that is used by an end user.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username that can preempt to connect to the cloud computer in use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], - 'required' => false, - 'maxItems' => 5, - ], - ], - [ - 'name' => 'AuthorizeSecurityPolicyRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound'."\n" - .'* inflow: inbound'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests. If no messages of access denied are returned, the requests timed out or failed.'."\n" - .'* accept: accepts all requests.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule. The value range of this parameter varies based on the value of the IpProtocol parameter.'."\n" - ."\n" - .'* If the IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If the IpProtocol parameter is set to ICMP, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to GRE, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to ALL, set the value to -1/-1.'."\n" - ."\n" - .'For more information about the common ports applied in EDS, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* UDP: the User Datagram Protocol (UDP) protocol.'."\n" - .'* TCP: the Transmission Control Protocol (TCP) protocol.'."\n" - .'* ALL: all protocols.'."\n" - .'* GRE: the Generic Routing Encapsulation (GRE) protocol.'."\n" - .'* ICMP: the Internet Control Message Protocol (ICMP) for (IPv4)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'UDP' => '', - 'TCP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'tcp', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value indicates a higher priority. Valid values: 1 to 60. Default value: 1'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object to which the security group rule applies. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.0.XX.XX/8', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - [ - 'name' => 'RevokeSecurityPolicyRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The security group rules that you want to delete.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule that you want to delete.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound'."\n" - .'* inflow: inbound'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'outflow', - ], - 'Policy' => [ - 'description' => 'The authorization of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests. If no messages of access denied are returned, the requests timed out or failed.'."\n" - .'* accept (default): accepts all requests.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule that you want to delete. The value range of this parameter varies based on the value of the IpProtocol parameter.'."\n" - ."\n" - .'* If the IpProtocol parameter is set to TCP or UDP, the port range is 1 to 65535. Separate the start port number and the end port number with a forward slash (/). Example: 1/200.'."\n" - .'* If the IpProtocol parameter is set to ICMP, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to GRE, set the value to -1/-1.'."\n" - .'* If the IpProtocol parameter is set to ALL, set the value to -1/-1.'."\n" - ."\n" - .'For more information about the common ports applied in EDS, see [Common ports](~~40724~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '22/22', - ], - 'Description' => [ - 'description' => 'The description of the security group rule that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule that you want to delete.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP'."\n" - .'* UDP'."\n" - .'* ALL'."\n" - .'* GRE'."\n" - .'* ICMP'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'UDP' => '', - 'ALL' => '', - 'GRE' => '', - 'ICMP' => '', - ], - 'example' => 'tcp', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule that you want to delete. A smaller value indicates a higher priority. Valid values: 1 to 60. Default value: 1.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object of the security group rule that you want to delete. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - [ - 'name' => 'AuthorizeAccessPolicyRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The client IP address whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address whitelists.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'RevokeAccessPolicyRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The client IP address whitelists that you want to delete.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address whitelist that you want to delete.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the client IP address whitelist that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The client CIDR block that you want to delete. Specify an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/16', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The logon method control rules to limit the type of the Alibaba Cloud Workspace client used by end users to connect to cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The logon method control rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'ClientType' => [ - 'description' => 'The type of the Alibaba Cloud Workspace client.'."\n" - ."\n" - .'> If you do not specify the `ClientType` parameter, all types of the client are allowed by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: web client'."\n" - .'* android: Android client'."\n" - .'* windows: Windows client'."\n" - .'* ios: iOS client'."\n" - .'* macos: macOS client'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'windows' => '', - 'ios' => '', - 'macos' => '', - ], - 'example' => 'windows', - ], - 'Status' => [ - 'description' => 'Specifies whether to allow end users to use a specific type of the client to connect to cloud computers.'."\n" - ."\n" - .'> If you do not specify the `ClientType` parameter, all types of the client are allowed by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'ON', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'GpuAcceleration', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the Image Quality Control feature for Graphic-based cloud computers. If you have high requirements on the performance and user experience in scenarios such as professional design, we recommend that you enable this feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'UsbSupplyRedirectRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The USB redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The USB redirection rules.'."\n", - 'type' => 'object', - 'properties' => [ - 'VendorId' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04**', - ], - 'ProductId' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08**', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test rule', - ], - 'UsbRedirectType' => [ - 'description' => 'Specifies whether to allow USB redirection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: allows USB redirection.'."\n" - .'* 2: forbids USB redirection.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'DeviceClass' => [ - 'description' => 'The device class. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0Eh', - ], - 'DeviceSubclass' => [ - 'description' => 'The device subclass. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxh', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: by device class'."\n" - .'* 2: by device vendor'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'DomainResolveRuleType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the domain name resolution rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'OFF', - ], - ], - [ - 'name' => 'DomainResolveRule', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The domain resolution rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The domain resolution rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.igetget.com', - ], - 'Policy' => [ - 'description' => 'The resolution policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow'."\n" - .'* block'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'block', - ], - 'Description' => [ - 'description' => 'The policy description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'description policy', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], - ], - [ - 'name' => 'Recording', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the screen recording feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* byaction_cmd_ft: enables the operation-triggered screen recording upon command execution and file transfer.'."\n" - .'* ALLTIME: enables the whole-process screen recording. That is, the recording starts when cloud computers are connected and ends when the cloud computers are disconnected.'."\n" - .'* session: enables the screen recording for session lifecycle listening.'."\n" - .'* PERIOD: enables the interval-based screen recording. You must specify an interval between the start time and end time of this type of recording.'."\n" - .'* byaction_commands: enables the operation-triggered screen recording upon command execution.'."\n" - .'* OFF: disables the screen recording feature.'."\n" - .'* byaction_file_transfer: enables the operation-triggered screen recording upon file transfer.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'byaction_cmd_ft' => '', - 'ALLTIME' => '', - 'session' => '', - 'PERIOD' => '', - 'byaction_commands' => '', - 'OFF' => '', - 'byaction_file_transfer' => '', - ], - 'example' => 'OFF', - ], - ], - [ - 'name' => 'RecordingStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the screen recording starts. Specify the value in the HH:MM:SS format. The value is meaningful only when you set the `Recording` parameter to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:00:00', - ], - ], - [ - 'name' => 'RecordingEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the screen recording stops. Specify the value in the HH:MM:SS format. The value is meaningful only when you set `Recording` to `PERIOD`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:59:00', - ], - ], - [ - 'name' => 'RecordingFps', - 'in' => 'query', - 'schema' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 2'."\n" - .'* 5'."\n" - .'* 10'."\n" - .'* 15'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 2 => '2', - 5 => '5', - 10 => '10', - 15 => '15', - ], - 'example' => '5', - ], - ], - [ - 'name' => 'RecordingExpires', - 'in' => 'query', - 'schema' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'NetRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable network redirection.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'CameraRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the webcam redirection feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on (default)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'AppContentProtection', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the anti-screenshot feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'RecordContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the custom screen recording feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'OFF', - ], - ], - [ - 'name' => 'RecordContentExpires', - 'in' => 'query', - 'schema' => [ - 'description' => 'The duration in which the custom screen recording is valid. Default value: 30. Unit: days.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'RemoteCoordinate', - 'in' => 'query', - 'schema' => [ - 'description' => 'The permissions on keyboard and mouse control during remote assistance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* optionalControl: By default, you are not granted the permissions. You can apply for the permissions.'."\n" - .'* fullControl: You are granted the full permissions.'."\n" - .'* disableControl: You are not granted the permissions.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'optionalControl' => '', - 'fullControl' => '', - 'disableControl' => '', - ], - 'example' => 'fullControl', - ], - ], - [ - 'name' => 'RecordingDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The file length of the screen recording. Unit: minutes. Screen recording files are split based on the specified file length and uploaded to Object Storage Service (OSS) buckets. When a screen recording file reaches 300 MB in size, the system preferentially performs rolling update for the file.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 10'."\n" - .'* 20'."\n" - .'* 30'."\n" - .'* 60'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 10 => '10', - 20 => '20', - 30 => '30', - 60 => '60', - ], - 'example' => '15', - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy takes effect based on the IP address.'."\n" - .'* GLOBAL: The policy takes effect globally.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'GLOBAL', - ], - ], - [ - 'name' => 'ScopeValue', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'This parameter is required when the `Scope` parameter is set to `IP`.````'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '47.100.XX.XX/24', - ], - 'required' => false, - 'maxItems' => 3, - ], - ], - [ - 'name' => 'RecordingAudio', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record the audio files generated from cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: records only video files.'."\n" - .'* on: records video and audio files.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'InternetCommunicationProtocol', - 'in' => 'query', - 'schema' => [ - 'description' => 'The protocol for network communication.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP (default): TCP'."\n" - .'* BOTH: TCP and UDP'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TCP' => '', - 'BOTH' => '', - ], - 'example' => 'BOTH', - ], - ], - [ - 'name' => 'VideoRedirect', - 'in' => 'query', - 'schema' => [ - 'description' => 'The multimedia redirection feature.', - 'type' => 'string', - 'required' => false, - 'example' => 'on', - ], - ], - [ - 'name' => 'WatermarkTransparencyValue', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark opacity. A larger value indicates more opaque watermarks. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'WatermarkColor', - 'in' => 'query', - 'schema' => [ - 'description' => 'The font color in red, green, and blue (RGB) of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'WatermarkDegree', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark rotation. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '-10', - ], - ], - [ - 'name' => 'WatermarkFontSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark font size. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'WatermarkFontStyle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark font style.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* plain'."\n" - .'* bold'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'plain' => '', - 'bold' => '', - ], - 'example' => 'plain', - ], - ], - [ - 'name' => 'WatermarkRowAmount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of watermark rows.'."\n" - ."\n" - .'> This parameter is not available for public use.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'EndUserApplyAdminCoordinate', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on the Contact Administrator for Help switch.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'EndUserGroupCoordinate', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on the User Stream Collaboration switch.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - ], - [ - 'name' => 'WatermarkSecurity', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the security priority feature for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'AdminAccess', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether end users have the administrator permissions.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'deny', - ], - ], - [ - 'name' => 'WatermarkAntiCam', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the anti-screen photo feature for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'WatermarkPower', - 'in' => 'query', - 'schema' => [ - 'description' => 'The watermark enhancement feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - .'* low'."\n" - .'* medium'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - ], - 'example' => 'medium', - ], - ], - [ - 'name' => 'RecordingUserNotify', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the screen recording notification feature after end users log on to the Alibaba Cloud Workspace client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - ], - [ - 'name' => 'RecordingUserNotifyMessage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The notification content of screen recording. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Your desktop is being recorded.'."\n", - ], - ], - [ - 'name' => 'MaxReconnectTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum retry period for reconnecting to cloud computers when the cloud computers are disconnected due to none-human reasons. Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120', - ], - ], - [ - 'name' => 'DeviceRedirects', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* printer'."\n" - .'* scanner'."\n" - .'* camera'."\n" - .'* adb: the Android Debug Bridge (ADB) device'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'printer' => '', - 'scanner' => '', - 'camera' => '', - 'adb' => '', - ], - 'example' => 'camera', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection'."\n" - .'* usbRedirect: USB redirection'."\n" - .'* off: redirection disabled'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'DeviceRules', - 'in' => 'query', - 'allowEmptyValue' => false, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* usbKey: UKeys'."\n" - .'* other: other peripheral devices.'."\n" - .'* graphicsTablet: graphics tablets.'."\n" - .'* printer: printers.'."\n" - .'* cardReader: card readers.'."\n" - .'* scanner: scanners.'."\n" - .'* storage: storage devices.'."\n" - .'* camera: web cameras.'."\n" - .'* adb: Android Debug Bridge (ADB) device'."\n" - .'* networkInterfaceCard: NIC devices.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'usbKey' => 'UKey', - 'other' => '', - 'graphicsTablet' => '', - 'printer' => '', - 'cardReader' => '', - 'scanner' => '', - 'storage' => '', - 'camera' => '', - 'adb' => '', - 'networkInterfaceCard' => '', - ], - 'example' => 'storage', - ], - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sandisk', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x0781', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0x55b1', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect: device redirection'."\n" - .'* usbRedirect: USB redirection.'."\n" - .'* off: redirection disabled'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2:0', - ], - 'Platforms' => [ - 'type' => 'string', - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'WyAssistant', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the Xiaoying AI Assistant entry in the DesktopAssistant menu.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: does not display the Xiaoying AI Assistant entry in the DesktopAssistant menu.'."\n" - .'* on: displays the Xiaoying AI Assistant entry in the DesktopAssistant menu.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyPolicyGroup', - ], - 'ModifyDesktopsPolicyGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.'."\n" - ."\n" - .'> If the `PolicyGroupIds` parameter is used, ignore the current parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify one or more cloud computers IDs. The value is a JSON array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - ], - 'required' => true, - 'example' => 'ecd-ia2zw38bi6cm7****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'PolicyGroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer policies that you want to associate with cloud computers.'."\n" - ."\n" - .'> You can specify up to one cloud computer policy that takes effect globally, and up to four cloud computer policies that apply to specific IP addresses. If you specify more than one cloud computer policy that takes effect globally, only the policy first associate with the cloud computer can take effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer policy that you want to associate with cloud computers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'required' => false, - 'maxItems' => 5, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'ModifyResults' => [ - 'description' => 'The request results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The returned message. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed. This parameter is not returned if the value of Code is success.``'."\n", - 'type' => 'string', - 'example' => 'The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.', - ], - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.\\",\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D3A17B8E-066B-421F-87DC-0B6451D89751\\n \\n ecd-7w78ozhjcwa3u****\\n success\\n \\n","errorExample":""}]', - 'title' => 'ModifyDesktopsPolicyGroup', - 'summary' => 'Changes an existing cloud computer policy for cloud computers.', - 'description' => 'The cloud computers for which you want to change their policies must be in the Running state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribePolicyGroups' => [ - 'summary' => 'Queries the details of a cloud computer policy.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '52839', - 'abilityTreeNodes' => [ - 'FEATUREgwsN6S2WW', - ], - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Valid values: 1 to 100'."\n" - .'* Default value: 10'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computer policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system-all-enabled-policy', - ], - 'required' => false, - 'example' => 'system-all-enabled-policy', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The effective scope of the cloud computer policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALL'."\n" - .'* IP'."\n" - .'* GLOBAL'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ALL' => '', - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'ALL', - ], - ], - [ - 'name' => 'ExternalPolicyGroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The array of cloud computer policy IDs to be excluded.', - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer policy ID to be excluded.', - 'type' => 'string', - 'required' => false, - 'example' => 'pg-0cid8v30p16k4****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - ], - [ - 'name' => 'BusinessChannel', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'Count' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DescribePolicyGroups' => [ - 'description' => 'The details of the cloud computer policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the cloud computer policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'PolicyStatus' => [ - 'description' => 'The status of the cloud computer policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AVAILABLE'."\n" - .'* CREATING'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AVAILABLE' => '', - 'CREATING' => '', - ], - 'example' => 'AVAILABLE', - ], - 'Html5Access' => [ - 'description' => 'Specifies whether to allow web client access.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'WatermarkType' => [ - 'description' => 'The watermark content.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* EndUserId: the username.'."\n" - .'* Custom'."\n" - .'* DesktopIp: the IP address of the cloud computer.'."\n" - .'* ClientIp: the IP address of the Alibaba Cloud Workspace client.'."\n" - .'* HostName: the rightmost 15 digits of the cloud computer ID.'."\n" - .'* ClientTime: the current time displayed on the cloud computer.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'EndUserId' => '', - 'Custom' => '', - 'DesktopIp' => '', - 'ClientIp' => '', - 'HostName' => '', - 'ClientTime' => '', - ], - 'example' => 'EndUserId', - ], - 'PreemptLogin' => [ - 'description' => 'The cloud computer preemption feature.'."\n" - ."\n" - .'> To ensure user experience and data security, when a cloud computer is used by an end user, other end users cannot connect to the cloud computer. By default, this parameter is set to `off`, which cannot be modified.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off: Preemption is not allowed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - ], - 'example' => 'off', - ], - 'WatermarkCustomText' => [ - 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Clipboard' => [ - 'description' => 'The permissions on the clipboard.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: specifies one-way transfer. You can copy files only from local devices to cloud computers.'."\n" - .'* readwrite: specifies two-way transfer. You can copy files between local devices and cloud computers.'."\n" - .'* write: specifies one-way transfer. You can only copy files from cloud computers to local devices.'."\n" - .'* off: disables both one-way and two-way transfer. Files cannot be copied between local devices and cloud computers.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'write' => '', - 'off' => '', - ], - 'example' => 'readwrite', - ], - 'PolicyGroupId' => [ - 'description' => 'The ID of the cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'pg-gx2x1dhsmthe9****', - ], - 'PrinterRedirection' => [ - 'description' => 'Indicates whether the printer redirection feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'WatermarkTransparency' => [ - 'description' => 'The watermark transparency.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LIGHT'."\n" - .'* DARK'."\n" - .'* MIDDLE'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'LIGHT' => '', - 'DARK' => '', - 'MIDDLE' => '', - ], - 'example' => 'LIGHT', - ], - 'Html5FileTransfer' => [ - 'description' => 'The file transfer feature on the web client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* all: Files can be uploaded and downloaded between local computers and the web client.'."\n" - .'* download: Files on the web client can be downloaded to local computers.'."\n" - .'* upload: Files on local computers can be uploaded to the web client.'."\n" - .'* off (default): Files cannot be transferred between the web client and local computers.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'all' => '', - 'download' => '', - 'upload' => '', - 'off' => '', - ], - 'example' => 'off', - ], - 'UsbRedirect' => [ - 'description' => 'Indicates whether the USB redirection feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'PolicyGroupType' => [ - 'description' => 'The type of the cloud computer policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM'."\n" - .'* CUSTOM'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'CUSTOM' => '', - ], - 'example' => 'SYSTEM', - ], - 'Watermark' => [ - 'description' => 'The watermarking feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* blind: Invisible watermarks are applied.'."\n" - .'* off: The watermarking feature is disabled.'."\n" - .'* on: Visible watermarks are applied.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'blind' => '', - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'VisualQuality' => [ - 'description' => 'The image display quality.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high: high-definition (HD)'."\n" - .'* low: fluent'."\n" - .'* medium (default): adaptive'."\n" - .'* lossless: no quality loss'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - 'lossless' => '', - ], - 'example' => 'medium', - ], - 'EdsCount' => [ - 'description' => 'The number of cloud computers that are associated with the policy. The number of cloud computers that are associated only with custom policies is returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Name' => [ - 'description' => 'The name of the cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'testPolicyGroupName', - ], - 'LocalDrive' => [ - 'description' => 'The permissions on local disk mapping.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* read: read-only. Local disk mapping is available on cloud computers. However, you can only read (copy) local files but cannot modify the files.'."\n" - .'* readwrite: read and write. Local disk mapping is available on cloud computers. You can read (copy) and write (modify) local files.'."\n" - .'* off (default): none.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'read' => '', - 'readwrite' => '', - 'off' => '', - ], - 'example' => 'readwrite', - ], - 'AuthorizeSecurityPolicyRules' => [ - 'description' => 'The security group rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The security group rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The direction of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* outflow: outbound'."\n" - .'* inflow: inbound'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'outflow' => '', - 'inflow' => '', - ], - 'example' => 'inflow', - ], - 'Policy' => [ - 'description' => 'The authorization of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* drop: denies all access requests.'."\n" - .'* accept: accepts all requests.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'drop' => '', - 'accept' => '', - ], - 'example' => 'accept', - ], - 'Description' => [ - 'description' => 'The description of the security group rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'PortRange' => [ - 'description' => 'The port range of the security group rule.'."\n", - 'type' => 'string', - 'example' => '22/22', - ], - 'IpProtocol' => [ - 'description' => 'The protocol type of the security group rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* tcp: Transmission Control Protocol (TCP)'."\n" - .'* udp: User Datagram Protocol (UDP)'."\n" - .'* all: all protocols'."\n" - .'* gre: Generic Routing Encapsulation (GRE)'."\n" - .'* icmp: Internet Control Message Protocol (ICMP) for IPv4'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'tcp' => '', - 'udp' => '', - 'all' => '', - 'gre' => '', - 'icmp' => '', - ], - 'example' => 'tcp', - ], - 'Priority' => [ - 'description' => 'The priority of the security group rule. A smaller value indicates a higher priority.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CidrIp' => [ - 'description' => 'The object to which the security group rule applies. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/16', - ], - ], - ], - ], - 'AuthorizeAccessPolicyRules' => [ - 'description' => 'The client IP address whitelist. End users can access cloud computers only from the IP addresses in the whitelist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The client IP address in the whitelist.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The remarks on the CIDR block that is allowed to access the client.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CidrIp' => [ - 'description' => 'The CIDR block that is allowed to access the client. The value is an IPv4 CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/16', - ], - ], - ], - ], - 'ClientTypes' => [ - 'description' => 'The logon method control rules to limit the type of the Alibaba Cloud Workspace client used by end users to connect to cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The logon method control rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether end users are allowed to use a specific type of the client to connect to cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], - 'example' => 'ON', - ], - 'ClientType' => [ - 'description' => 'The client type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: web client'."\n" - .'* android: Android client'."\n" - .'* windows: Windows client'."\n" - .'* ios: iOS client'."\n" - .'* macos: macOS client'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'windows' => '', - 'ios' => '', - 'macos' => '', - ], - 'example' => 'windows', - ], - ], - ], - ], - 'PreemptLoginUsers' => [ - 'description' => 'The usernames that can preempt to connect to the cloud computer.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username that can preempt to connect to the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'Alice', - ], - ], - 'GpuAcceleration' => [ - 'description' => 'Indicates whether the Image Quality Control feature is enabled. If you have high requirements on the performance and user experience in scenarios such as professional design, we recommend that you enable this feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'UsbSupplyRedirectRule' => [ - 'description' => 'The USB redirection rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The USB redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'VendorId' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'example' => '04**', - ], - 'ProductId' => [ - 'description' => 'The product ID.'."\n", - 'type' => 'string', - 'example' => '08**', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'UsbRedirectType' => [ - 'description' => 'Indicates whether USB redirection is allowed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: allowed'."\n" - .'* 2: not allowed'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - 'DeviceClass' => [ - 'description' => 'The device class. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'example' => '0Eh', - ], - 'DeviceSubclass' => [ - 'description' => 'The subclass of the device. This parameter is required when `usbRuleType` is set to 1. For more information, see [Defined Class Codes](https://www.usb.org/defined-class-codes).'."\n", - 'type' => 'string', - 'example' => 'xxh', - ], - 'UsbRuleType' => [ - 'description' => 'The type of the USB redirection rule.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: by device class'."\n" - .'* 2: by device vendor'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '1', - ], - ], - ], - ], - 'DomainResolveRuleType' => [ - 'description' => 'Indicates whether the switch for domain name resolution is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'DomainResolveRule' => [ - 'description' => 'The domain name resolution rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the domain name resolution rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The destination domain name.'."\n", - 'type' => 'string', - 'example' => '*.com', - ], - 'Policy' => [ - 'description' => 'Indicates whether the domain name resolution rule is allowed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow'."\n" - .'* block'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'allow', - ], - 'Description' => [ - 'description' => 'The rule description.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - ], - ], - ], - 'NetRedirectRule' => [ - 'description' => 'The network redirection rule.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the network redirection rule.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The rule content.'."\n", - 'type' => 'string', - 'example' => '*.com', - ], - 'RuleType' => [ - 'description' => 'The rule type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* prc: process'."\n" - .'* domain: domain name'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'prc' => '', - 'domain' => '', - ], - 'example' => 'domain', - ], - 'Policy' => [ - 'description' => 'Indicates whether the rule is allowed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* allow'."\n" - .'* block'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'allow' => '', - 'block' => '', - ], - 'example' => 'allow', - ], - ], - ], - ], - 'Recording' => [ - 'description' => 'Indicates whether the screen recording feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* byaction_cmd_ft: enables the operation-triggered screen recording upon command execution and file transfer.'."\n" - .'* ALLTIME: enables the whole-process screen recording. That is, the recording starts when cloud computers are connected and ends when the cloud computers are disconnected.'."\n" - .'* PERIOD: enables the interval-based screen recording. You must specify an interval between the start time and end time of this type of recording.'."\n" - .'* byaction_commands: enables the operation-triggered screen recording upon command execution.'."\n" - .'* OFF: disables the screen recording feature.'."\n" - .'* byaction_file_transfer: enables the operation-triggered screen recording upon file transfer.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'byaction_cmd_ft' => '', - 'ALLTIME' => '', - 'PERIOD' => '', - 'byaction_commands' => '', - 'OFF' => '', - 'byaction_file_transfer' => '', - ], - 'example' => 'OFF', - ], - 'RecordingStartTime' => [ - 'description' => 'The time when the screen recording was started. The value is in the HH:MM:SS format. The value takes effect only when Recording is set to PERIOD.'."\n", - 'type' => 'string', - 'example' => '08:00:00', - ], - 'RecordingEndTime' => [ - 'description' => 'The time when the screen recording ended. The value is in the HH:MM:SS format. The value takes effect only when Recording is set to PERIOD.'."\n", - 'type' => 'string', - 'example' => '08:59:00', - ], - 'RecordingFps' => [ - 'description' => 'The frame rate of screen recording. Unit: fps.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 2'."\n" - .'* 5'."\n" - .'* 10'."\n" - .'* 15'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 2 => '2', - 5 => '5', - 10 => '10', - 15 => '15', - ], - 'example' => '5', - ], - 'RecordingExpires' => [ - 'description' => 'The retention period of the screen recording file. Valid values: 1 to 180. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'CameraRedirect' => [ - 'description' => 'Indicates whether the webcam redirection feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on (default)'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'NetRedirect' => [ - 'description' => 'Indicates whether the network redirection feature is enabled.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'AppContentProtection' => [ - 'description' => 'Indicates whether the anti-screenshot feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'RecordContent' => [ - 'description' => 'Indicates whether the custom screen recording feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default)'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'RecordContentExpires' => [ - 'description' => 'The period when the custom screen recording can be retained before expiration. Default value: 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'RemoteCoordinate' => [ - 'description' => 'The permissions on keyboard and mouse control during remote assistance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* optionalControl: By default, you are not granted the permissions. You can apply for the permissions.'."\n" - .'* fullControl: You are granted the full permissions.'."\n" - .'* disableControl: You are not granted the permissions.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'optionalControl' => '', - 'fullControl' => '', - 'disableControl' => '', - ], - 'example' => 'fullControl', - ], - 'RecordingDuration' => [ - 'description' => 'The file length of the screen recording. Unit: minutes. Screen recording files are split based on the specified file length and uploaded to Object Storage Service (OSS) buckets. When a screen recording file reaches 300 MB in size, the system preferentially performs rolling update for the file.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 10'."\n" - .'* 20'."\n" - .'* 30'."\n" - .'* 60'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - 10 => '10', - 20 => '20', - 30 => '30', - 60 => '60', - ], - 'example' => '10', - ], - 'Scope' => [ - 'description' => 'The effective scope of the policy.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* IP: The policy takes effect based on the IP address.'."\n" - .'* GLOBAL: The policy takes effect globally.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'IP' => '', - 'GLOBAL' => '', - ], - 'example' => 'GLOBAL', - ], - 'ScopeValue' => [ - 'description' => 'This parameter is required when the `Scope` parameter is set to `IP`.````'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The effective scope specified by a CIDR block.'."\n", - 'type' => 'string', - 'example' => '47.100.XX.XX/24', - ], - ], - 'RecordingAudio' => [ - 'description' => 'Indicates whether audio files generated from cloud computers are recorded.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off (default): records only video files.'."\n" - .'* on: records video and audio files.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'InternetCommunicationProtocol' => [ - 'description' => 'The protocol for network communication.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* TCP (default): TCP.'."\n" - .'* BOTH: TCP and UDP.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'TCP' => '', - 'BOTH' => '', - ], - 'example' => 'BOTH', - ], - 'VideoRedirect' => [ - 'description' => 'Indicates whether the multimedia redirection feature is enabled.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'WatermarkTransparencyValue' => [ - 'description' => 'The watermark transparency. A greater value indicates that the watermark is less transparent. Valid values: 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'WatermarkColor' => [ - 'description' => 'The font color in red, green, and blue (RGB) of the watermark. Valid values: 0 to 16777215.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WatermarkFontSize' => [ - 'description' => 'The font size of the watermark. Valid values: 10 to 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'WatermarkFontStyle' => [ - 'description' => 'The watermark font style.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* plain'."\n" - .'* bold'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'plain' => '', - 'bold' => '', - ], - 'example' => 'plain', - ], - 'WatermarkDegree' => [ - 'description' => 'The slope of the watermark. Valid values: -10 to -30.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '-10', - ], - 'WatermarkRowAmount' => [ - 'description' => 'The number of watermark rows.'."\n" - ."\n" - .'> This parameter is not available for public use.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'EndUserApplyAdminCoordinate' => [ - 'description' => 'Indicates whether the Contact Administrator for Help switch is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'EndUserGroupCoordinate' => [ - 'description' => 'Indicates whether the User Stream Collaboration switch is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'CpuProtectedMode' => [ - 'description' => 'Indicates whether the CPU spike protection switch is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'CpuRateLimit' => [ - 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'CpuSampleDuration' => [ - 'description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CpuSingleRateLimit' => [ - 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'CpuDownGradeDuration' => [ - 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'CpuProcessors' => [ - 'description' => 'The process whitelist that is not restricted by the CPU usage limit.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'example' => 'chrome.exe', - ], - ], - 'MemoryProtectedMode' => [ - 'description' => 'Indicates whether the memory spike protection switch is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'MemoryRateLimit' => [ - 'description' => 'The overall memory usage. Valid values: 70 to 90. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '70', - ], - 'MemorySampleDuration' => [ - 'description' => 'The overall memory sampling duration. Valid values: 30 to 60. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemorySingleRateLimit' => [ - 'description' => 'The memory usage of a single process. Valid values: 30 to 60. Unit: %.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemoryDownGradeDuration' => [ - 'description' => 'The memory underclocking duration for a single process. Valid values: 30 to 120. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'MemoryProcessors' => [ - 'description' => 'The whitelist of processes that are not restricted by the memory usage limit.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'example' => 'notepad.exe', - ], - ], - 'WatermarkSecurity' => [ - 'description' => 'Indicates whether the security priority feature is enabled for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'on', - ], - 'WatermarkAntiCam' => [ - 'description' => 'Indicates whether the anti-screen photo feature is enabled for invisible watermarks.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'WatermarkPower' => [ - 'description' => 'The watermark enhancement feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* high'."\n" - .'* low'."\n" - .'* medium'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'high' => '', - 'low' => '', - 'medium' => '', - ], - 'example' => 'medium', - ], - 'RecordingUserNotify' => [ - 'description' => 'Indicates whether the screen recording notification feature is enabled after end users log on to the Alibaba Cloud Workspace client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'RecordingUserNotifyMessage' => [ - 'description' => 'The notification content of screen recording. By default, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'Your desktop is being recorded'."\n", - ], - 'AdminAccess' => [ - 'description' => 'Indicates whether end users are granted the administrator permissions.'."\n" - ."\n" - .'> This parameter is in invitational preview for specific users and not available to the public.'."\n", - 'type' => 'string', - 'example' => 'deny', - ], - 'MaxReconnectTime' => [ - 'description' => 'The maximum retry period for reconnecting to cloud computers when the cloud computers are disconnected due to none-human reasons. Valid values: 30 to 7200. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120', - ], - 'DisplayMode' => [ - 'description' => 'The display mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* clientCustom: suitable for user-defined scenarios.'."\n" - .'* adminOffice: suitable for daily office scenarios.'."\n" - .'* adminDesign: suitable for 3D application scenarios.'."\n" - .'* adminCustom: administrator-customized scenarios'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'clientCustom' => '', - 'adminOffice' => '', - 'adminDesign' => '', - 'adminCustom' => '', - ], - 'example' => 'adminCustom', - ], - 'StreamingMode' => [ - 'description' => 'The streaming mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* intelligent: suitable for daily office scenarios (Intelligent Mode).'."\n" - .'* smooth: suitable for design and 3D application scenarios (Smooth Mode).'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'intelligent' => '', - 'smooth' => '', - ], - 'example' => 'smooth', - ], - 'ColorEnhancement' => [ - 'description' => 'Indicates whether the Color Enhancement switch is turned on in design and 3D scenarios.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'SmoothEnhancement' => [ - 'description' => 'Indicates whether the Smooth Enhancement switch is turned on.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'QualityEnhancement' => [ - 'description' => 'Indicates whether the Image Quality Enhancement switch is turned on for design and 3D scenarios.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'VideoEncPolicy' => [ - 'description' => 'The video encoding feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* qualityFirst: The priority given to the image quality.'."\n" - .'* bandwidthFirst: The priority given to the bitrate.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'qualityFirst' => '', - 'bandwidthFirst' => '', - ], - 'example' => 'qualityFirst', - ], - 'TargetFps' => [ - 'description' => 'The destination frame rate. Valid values: 10 to 60. Unit: fps.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'VideoEncMinQP' => [ - 'description' => 'The minimum quantizer parameter (QP) of video files. A smaller QP value indicates higher video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'VideoEncMaxQP' => [ - 'description' => 'The maximum quantizer parameter (QP) of video files. A larger QP value indicates worse video quality. Valid values: 0 to 51.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'VideoEncAvgKbps' => [ - 'description' => 'The average bitrate for video encoding. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'VideoEncPeakKbps' => [ - 'description' => 'The peak bitrate for video encoding. Valid values: 1000 to 50000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1000', - ], - 'DeviceRedirects' => [ - 'description' => 'The device redirection rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The device redirection rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* printer'."\n" - .'* scanner'."\n" - .'* camera'."\n" - .'* adb: the Android Debug Bridge (ADB) device.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'printer' => '', - 'scanner' => '', - 'camera' => '', - 'adb' => '', - ], - 'example' => 'camera', - ], - 'RedirectType' => [ - 'description' => 'The redirection type. Valid values:'."\n" - ."\n" - .'* usbRedirect'."\n" - .'* deviceRedirect'."\n" - .'* off: direction disabled.'."\n", - 'type' => 'string', - 'example' => 'usbRedirect', - ], - ], - ], - ], - 'DeviceRules' => [ - 'description' => 'The custom peripheral rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom peripheral rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceType' => [ - 'description' => 'The peripheral type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* usbKey'."\n" - .'* other'."\n" - .'* graphicsTablet'."\n" - .'* printer'."\n" - .'* cardReader'."\n" - .'* scanner'."\n" - .'* storage'."\n" - .'* camera'."\n" - .'* adb'."\n" - .'* networkInterfaceCard: the NIC device.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'usbKey' => 'usbKey', - 'other' => 'other', - 'graphicsTablet' => 'graphicsTablet', - 'printer' => 'printer', - 'cardReader' => 'cardReader', - 'scanner' => 'scanner', - 'storage' => 'storage', - 'camera' => 'camera', - 'adb' => 'adb', - 'networkInterfaceCard' => 'networkInterfaceCard', - ], - 'example' => 'storage', - ], - 'DeviceName' => [ - 'description' => 'The device name.'."\n", - 'type' => 'string', - 'example' => 'sandisk', - ], - 'DeviceVid' => [ - 'description' => 'The vendor ID (VID). For more information, see [Valid USB VIDs](https://www.usb.org/sites/default/files/vendor_ids032322.pdf\\_1.pdf).'."\n", - 'type' => 'string', - 'example' => '0x0781', - ], - 'DevicePid' => [ - 'description' => 'The product ID (PID).'."\n", - 'type' => 'string', - 'example' => '0x55b1', - ], - 'RedirectType' => [ - 'description' => 'The redirection type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* deviceRedirect'."\n" - .'* usbRedirect'."\n" - .'* off: redirection disabled.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'deviceRedirect' => '', - 'usbRedirect' => '', - 'off' => '', - ], - 'example' => 'usbRedirect', - ], - 'OptCommand' => [ - 'description' => 'The link optimization command.'."\n", - 'type' => 'string', - 'example' => '2:0', - ], - 'Platforms' => [ - 'type' => 'string', - ], - ], - ], - ], - 'WyAssistant' => [ - 'description' => 'Specifies whether to provide the AI Assistant function in the DesktopAssistant when the cloud computer is accessed from the Alibaba Cloud Workspace desktop clients (including the Windows client and the macOS client).'."\n" - ."\n" - .'> Desktop clients of V7.7 and higher versions required.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- off: the AI Aisstant function is not provided.'."\n" - .'- on: the AI Aisstant function is provided.', - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', - ], - 'ResourceRegionId' => [ - 'description' => 'The region of the cloud computer policy.'."\n" - ."\n" - .'> The value of a region-less policy is `center`.', - 'type' => 'string', - 'example' => 'center', - ], - 'DomainList' => [ - 'description' => 'Specifies whether to enable the access control for domain names. Domain names support wildcards (\\*). Separate multiple domain names with commas (,).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* off'."\n" - .'* on'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => '', - 'on' => '', - ], - 'example' => 'off', - ], - 'StatusMonitor' => [ - 'description' => 'Specifies whether to provide the Metrics function in the DesktopAssistant. Valid values:'."\n" - ."\n" - .'- off: not provided.'."\n" - .'- on: provided.', - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'on', - ], - 'MobileRestart' => [ - 'description' => 'Specifies whether to display the restart button in the DesktopAssistant when the cloud computer is accessed from the Alibaba Cloud Workspace mobile clients (including the Android client and the iOS client).'."\n" - ."\n" - .'> Mobile clients of V7.4 and higher versions required.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- off: not provided.'."\n" - .'- on: provided.', - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'off', - ], - 'MobileShutdown' => [ - 'description' => 'Specifies whether to display the shut down button in the DesktopAssistant when the cloud computer is accessed from the Alibaba Cloud Workspace mobile clients (including the Android client and the iOS client).'."\n" - ."\n" - .'> Mobile clients of V7.4 and higher versions required.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'- off: not provided.'."\n" - .'- on: provided.', - 'type' => 'string', - 'enumValueTitles' => [ - 'off' => 'off', - 'on' => 'on', - ], - 'example' => 'off', - ], - 'DesktopCount' => [ - 'description' => 'The number of cloud computers bound with this policy.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DesktopGroupCount' => [ - 'description' => 'The number of shared cloud computers bound with this policy.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ResourceGroupCount' => [ - 'description' => 'The number of resource groups bound with this policy.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RecordEventFilePaths' => [ - 'description' => 'The array of absolute paths of the monitored files in the screen recording audit policy.', - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path of the monitored file in the screen recording audit policy.', - 'type' => 'string', - 'example' => 'd:/data', - ], - ], - 'RecordEventRegisters' => [ - 'description' => 'The array of absolute paths of the monitored registry entries in the screen recording audit policy.', - 'type' => 'array', - 'items' => [ - 'description' => 'The absolute path of the monitored registry entry in the screen recording audit policy.', - 'type' => 'string', - 'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR', - ], - ], - 'RecordEventDuration' => [ - 'description' => 'The recording duration since a target event is detected by the screen recording audit policy. Unit: Minute. Valid values: 10-60.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'ResetDesktop' => [ - 'description' => 'Resets the cloud computer.', - 'type' => 'string', - 'example' => 'null', - ], - 'FileTransfer' => [ - 'description' => 'Transfers files.', - 'type' => 'string', - 'example' => 'null', - ], - 'DeviceConnectHint' => [ - 'type' => 'string', - ], - 'ResolutionModel' => [ - 'type' => 'string', - ], - 'ResolutionWidth' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ResolutionHeight' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'FileMigrate' => [ - 'type' => 'string', - ], - 'WuyingKeeper' => [ - 'type' => 'string', - ], - 'InternetPrinter' => [ - 'type' => 'string', - ], - 'SafeMenu' => [ - 'type' => 'string', - ], - 'ScreenDisplayMode' => [ - 'type' => 'string', - ], - 'ClientControlMenu' => [ - 'type' => 'string', - ], - 'FileTransferSpeedLocation' => [ - 'type' => 'string', - ], - 'FileTransferAddress' => [ - 'type' => 'string', - ], - 'FileTransferSpeed' => [ - 'type' => 'string', - ], - 'CpdDriveClipboard' => [ - 'type' => 'string', - ], - 'UseTime' => [ - 'type' => 'string', - ], - 'AutoReconnect' => [ - 'title' => '客户端自动重连配置项', - 'description' => 'The automatic client connection recovery configurations.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'MobileWuyingKeeper' => [ - 'title' => '移动端无影管家开关', - 'description' => 'Indicates whether the Cloud Computer Manager is enabled for mobile clients.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'MobileSafeMenu' => [ - 'title' => '移动端Windows安全控制开关', - 'description' => 'Indicates whether the Windows security control is enabled for mobile clients.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'MobileWyAssistant' => [ - 'title' => '移动端无影小颖开关', - 'description' => 'Indicates whether the Xiaoying AI Assistant is enabled for mobile clients.'."\n", - 'type' => 'string', - 'example' => 'off', - ], - 'ExternalDrive' => [ - 'type' => 'string', - ], - 'ClientCreateSnapshot' => [ - 'type' => 'string', - ], - 'WatermarkShadow' => [ - 'type' => 'string', - ], - 'AcademicProxy' => [ - 'type' => 'string', - ], - 'ModelLibrary' => [ - 'type' => 'string', - ], - 'PortProxy' => [ - 'type' => 'string', - ], - 'DiskOverload' => [ - 'type' => 'string', - ], - 'CpuOverload' => [ - 'type' => 'string', - ], - 'MemoryOverload' => [ - 'type' => 'string', - ], - 'ResolutionDpi' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'HoverConfigMsg' => [ - 'type' => 'string', - ], - 'MultiScreen' => [ - 'type' => 'string', - ], - 'HoverShutdown' => [ - 'type' => 'string', - ], - 'HoverRestart' => [ - 'type' => 'string', - ], - 'HoverHibernate' => [ - 'type' => 'string', - ], - 'ClientShutdown' => [ - 'type' => 'string', - ], - 'ClientRestart' => [ - 'type' => 'string', - ], - 'ClientHibernate' => [ - 'type' => 'string', - ], - 'RecordEventLevels' => [ - 'title' => '录屏事件等级开关', - 'description' => 'Indicates whether the screen recording event severity is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventType' => [ - 'title' => '事件类型', - 'description' => 'The event type.'."\n", - 'type' => 'string', - ], - 'EventLevel' => [ - 'title' => '事件等级', - 'description' => 'The event severity.'."\n", - 'type' => 'string', - ], - ], - 'description' => '', - ], - ], - 'RecordEventFileExts' => [ - 'title' => '录屏事件后缀', - 'description' => 'The screen recording file suffix.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'description' => '', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"Count\\": 0,\\n \\"PageNumber\\": 0,\\n \\"PageSize\\": 0,\\n \\"DescribePolicyGroups\\": [\\n {\\n \\"PolicyStatus\\": \\"AVAILABLE\\",\\n \\"Html5Access\\": \\"off\\",\\n \\"WatermarkType\\": \\"EndUserId\\",\\n \\"PreemptLogin\\": \\"off\\",\\n \\"WatermarkCustomText\\": \\"custom-watermark\\",\\n \\"Clipboard\\": \\"off\\",\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"PrinterRedirection\\": \\"on\\",\\n \\"WatermarkTransparency\\": \\"LIGHT\\",\\n \\"Html5FileTransfer\\": \\"off\\",\\n \\"UsbRedirect\\": \\"on\\",\\n \\"PolicyGroupType\\": \\"SYSTEM\\",\\n \\"Watermark\\": \\"on\\",\\n \\"VisualQuality\\": \\"medium\\",\\n \\"EdsCount\\": 2,\\n \\"Name\\": \\"testPolicyGroupName\\",\\n \\"LocalDrive\\": \\"readwrite\\",\\n \\"AuthorizeSecurityPolicyRules\\": [\\n {\\n \\"Type\\": \\"inflow\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Description\\": \\"test\\",\\n \\"PortRange\\": \\"22/22\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Priority\\": \\"1\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"AuthorizeAccessPolicyRules\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"ClientTypes\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"PreemptLoginUsers\\": [\\n \\"Alice\\"\\n ],\\n \\"GpuAcceleration\\": \\"off\\",\\n \\"UsbSupplyRedirectRule\\": [\\n {\\n \\"VendorId\\": \\"04**\\",\\n \\"ProductId\\": \\"08**\\",\\n \\"Description\\": \\"测试规则\\",\\n \\"UsbRedirectType\\": 1,\\n \\"DeviceClass\\": \\"0Eh\\",\\n \\"DeviceSubclass\\": \\"xxh\\",\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"OFF\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"BOTH\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 5,\\n \\"EndUserApplyAdminCoordinate\\": \\"on\\",\\n \\"EndUserGroupCoordinate\\": \\"on\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"on\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"您的云电脑正在被录屏\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 1000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"ResourceRegionId\\": \\"center\\",\\n \\"DomainList\\": \\"off\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"ResetDesktop\\": \\"null\\",\\n \\"FileTransfer\\": \\"null\\",\\n \\"DeviceConnectHint\\": \\"\\",\\n \\"ResolutionModel\\": \\"\\",\\n \\"ResolutionWidth\\": 0,\\n \\"ResolutionHeight\\": 0,\\n \\"FileMigrate\\": \\"\\",\\n \\"WuyingKeeper\\": \\"\\",\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"AutoReconnect\\": \\"off\\",\\n \\"MobileWuyingKeeper\\": \\"off\\",\\n \\"MobileSafeMenu\\": \\"off\\",\\n \\"MobileWyAssistant\\": \\"off\\",\\n \\"ExternalDrive\\": \\"\\",\\n \\"ClientCreateSnapshot\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"DiskOverload\\": \\"\\",\\n \\"CpuOverload\\": \\"\\",\\n \\"MemoryOverload\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"RecordEventLevels\\": [\\n {\\n \\"EventType\\": \\"\\",\\n \\"EventLevel\\": \\"\\"\\n }\\n ],\\n \\"RecordEventFileExts\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6kb60RyIe8hZIdhSybWz5t4\\n 2CB27899-306D-56E9-A8F1-AD83D9FEDF3B\\n \\n pg-8whrmp8dewbdv****\\n on\\n sg-new-02\\n CUSTOM\\n off\\n AVAILABLE\\n off\\n \\n ON\\n windows\\n \\n \\n ON\\n linux\\n \\n \\n ON\\n macos\\n \\n \\n OFF\\n ios\\n \\n \\n OFF\\n android\\n \\n \\n ON\\n html5\\n \\n off\\n off\\n 1\\n off\\n medium\\n on\\n off\\n \\n","errorExample":""}]', - 'title' => 'DescribePolicyGroups', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ClonePolicyGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the destination cloud computer policy that you want to clone.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer policy that you want to create.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'testPolicyGroupName', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'PolicyGroupId' => [ - 'description' => 'The ID of the new cloud computer policy.'."\n", - 'type' => 'string', - 'example' => 'pg-7jcaznnx6go6n****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidPolicyGroup.Status', - 'errorMessage' => 'The target policy group is being created. Please try again later.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-7jcaznnx6go6n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ClonePolicyGroup', - 'summary' => 'Clones an existing policy to quickly create a policy.', - ], - 'CreateConfigGroup' => [ - 'summary' => 'Creates a configuration group. A configuration group stores the setup details for scheduled tasks on cloud computers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cn-shanghai' => 'cn-shanghai', - ], - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ScheduledTask', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ScheduledTask', - 'maxLength' => 500, - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The group type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Timer: a scheduled task group.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Timer' => '', - ], - 'example' => 'Timer', - 'enum' => [ - 'Timer', - ], - ], - ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - ], - [ - 'name' => 'ConfigTimers', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The scheduled task groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduled task group.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimerType' => [ - 'description' => 'The scheduled task type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* NoConnect: scheduled disconnection upon specified operation (OperationType).'."\n" - .'* TimerBoot: scheduled start.'."\n" - .'* TimerReset: scheduled reset.'."\n" - .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" - .'* NoOperationHibernate: scheduled hibernation upon inactivity.'."\n" - .'* TimerShutdown: scheduled shutdown.'."\n" - .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" - .'* TimerReboot: scheduled restart.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'NoConnect' => '', - 'TimerBoot' => '', - 'TimerReset' => '', - 'NoOperationShutdown' => '', - 'NoOperationHibernate' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], - 'example' => 'TIMER_BOOT', - ], - 'CronExpression' => [ - 'description' => 'The cron expression specified in the scheduled task.'."\n" - ."\n" - .'> The time must be in UTC. For example, for 24:00 (UTC+8), you must set the value to 0 0 16 ? \\* 1,2,3,4,5,6,7'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 0 16 ? * 1,2,3,4,5,6,7', - ], - 'Interval' => [ - 'description' => 'The interval at which the scheduled task is executed. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Enforce' => [ - 'description' => 'Specifies whether to forcefully execute the scheduled task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ResetType' => [ - 'description' => 'The reset option.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESET_TYPE_SYSTEM: resets only the system disk.'."\n" - .'* RESET_TYPE_USER_DISK: resets only the data disk.'."\n" - .'* RESET_TYPE_BOTH: resets the system and data disks.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '', - 'RESET_TYPE_USER_DISK' => '', - 'RESET_TYPE_BOTH' => '', - ], - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'description' => 'Specifies whether to allow end users to configure the scheduled task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'OperationType' => [ - 'description' => 'The type of the scheduled operation. If you set TimerType to NoConnect, you can specify this parameter.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hibernate: scheduled hibernation.'."\n" - .'* Shutdown: scheduled shutdown.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hibernate' => '', - 'Shutdown' => '', - ], - 'example' => 'Shutdown', - ], - 'TriggerType' => [ - 'description' => 'The method to trigger the scheduled task upon inactivity.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Advanced: intelligent detection.'."\n" - .'* Standard: standard detection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Advanced' => '', - 'Standard' => '', - ], - 'example' => 'Standard', - ], - 'ProcessWhitelist' => [ - 'description' => 'The process whitelist. If whitelisted processes are running, the scheduled task does not take effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'chrome', - ], - 'required' => false, - 'maxItems' => 30, - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'SegmentTimers' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationType' => [ - 'type' => 'string', - ], - 'StartCronExpression' => [ - 'type' => 'string', - ], - 'EndCronExpression' => [ - 'type' => 'string', - ], - 'Interval' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TriggerType' => [ - 'type' => 'string', - ], - 'ProcessWhitelist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'maxItems' => 30, - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TimerOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Timezone' => [ - 'type' => 'string', - ], - 'Enforce' => [ - 'type' => 'boolean', - ], - 'ResetType' => [ - 'type' => 'string', - ], - 'ImageId' => [ - 'title' => '变更镜像定时任务使用，指定需要变更的镜像ID', - 'type' => 'string', - 'example' => 'm-5b0vjqbiqu010XXXXXX', - ], - 'LockScreenTime' => [ - 'title' => '无操作锁屏功能使用，指定锁屏时间点，非AD桌面不能使用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1800', - ], - 'AppointmentTimer' => [ - 'title' => '定点执行定时任务使用，指定后可以按照指定时间点执行定时任务', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1764660600967', - ], - ], - ], - 'maxItems' => 10, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The object that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EE9472BC-0B5D-5458-85CD-C52BDD******', - ], - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ccg-0ctwi5zbswtql****', - ], - 'Message' => [ - 'description' => 'The creation result of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'TestCode%sTestCode%sTestCode%s', - 'errorMessage' => 'TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE9472BC-0B5D-5458-85CD-C52BDD******\\",\\n \\"GroupId\\": \\"ccg-0ctwi5zbswtql****\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', - 'title' => 'CreateConfigGroup', - ], - 'ModifyConfigGroup' => [ - 'summary' => 'Modifies the basic information of a configuration group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cg-i1ruuudp92qpj****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ScheduledTask', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ScheduledTask', - 'maxLength' => 500, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'cg-i1ruuudp92qpj****', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"GroupId\\": \\"cg-i1ruuudp92qpj****\\"\\n}","type":"json"}]', - 'title' => 'ModifyConfigGroup', - ], - 'DeleteConfigGroup' => [ - 'summary' => 'Deletes a configuration group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cn-shanghai' => 'cn-shanghai', - ], - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the configuration groups that you want to delete.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the configuration group that you want to delete.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0cpaegmjioo7*****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]', - 'title' => 'DeleteConfigGroup', - ], - 'BindConfigGroup' => [ - 'summary' => 'Binds a configuration group to resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ccg-0chlk9b65lj8z****', - ], - ], - [ - 'name' => 'ResourceInfos', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resources to which you want to bind the configuration group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource to which you want to bind the configuration group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-1bo4xotjvwyon****', - ], - 'ResourceRegionId' => [ - 'description' => 'The region ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESOURCE_GROUP: the resource group'."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESOURCE_GROUP' => '', - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'ProductType' => [ - 'description' => 'The service type of the resource.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 500, - 'minItems' => 1, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******', - ], - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ccg-0chlk9b65lj****', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"GroupId\\": \\"ccg-0chlk9b65lj****\\"\\n}","type":"json"}]', - 'title' => 'BindConfigGroup', - ], - 'UnbindConfigGroup' => [ - 'summary' => 'Unbinds a configuration group from resources.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'systemTags' => [ - 'operationType' => 'list', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Timer: the scheduled task type.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'Timer' => '', - ], - 'example' => 'Timer', - ], - ], - [ - 'name' => 'ResourceInfos', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resources from which you want to unbind the configuration group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource from which you want to unbind the configuration group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ctwj0bk3l5nz****', - ], - 'ResourceRegionId' => [ - 'description' => 'The region ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-chengdu', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESOURCE_GROUP: the resource group.'."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESOURCE_GROUP' => '', - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'ProductType' => [ - 'description' => 'The service type of the resource.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 500, - 'minItems' => 1, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'AD0FF13D-FC7D-56AD-934F-91C8487*****', - ], - 'GroupIds' => [ - 'description' => 'The IDs of the configuration groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ccg-0cfaiedov605c****', - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AD0FF13D-FC7D-56AD-934F-91C8487*****\\",\\n \\"GroupIds\\": [\\n \\"ccg-0cfaiedov605c****\\"\\n ]\\n}","type":"json"}]', - 'title' => 'UnbindConfigGroup', - ], - 'DescribeConfigGroup' => [ - 'summary' => 'Queries configuration groups.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cg-i1ruuudp92qpj****', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ScheduledTask', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Timer: the scheduled task type.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Timer' => '', - ], - 'example' => 'Timer', - ], - ], - [ - 'name' => 'ProductType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - ], - [ - 'name' => 'Statuses', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The status of the configuration groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The state of the configuration group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AVAILABLE: The configuration group is available.'."\n" - .'* UNAVAILABLE: The configuration group is deleted.'."\n" - .'* DELETING: The configuration group is being deleted.'."\n" - .'* UPDATING: The configuration group is being modified.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AVAILABLE' => '', - 'UNAVAILABLE' => '', - 'DELETING' => '', - 'UPDATING' => '', - ], - 'example' => 'AVAILABLE', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the configuration groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0cwz8naid24v*****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Data' => [ - 'description' => 'The configuration groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ccg-0cid8v30an12****', - ], - 'Name' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ScheduledTask', - ], - 'Description' => [ - 'description' => 'The description of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'ScheduledTask', - ], - 'Type' => [ - 'description' => 'The type of the configuration group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Timer: the scheduled task type.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Timer' => '', - ], - 'example' => 'Timer', - ], - 'ProductType' => [ - 'description' => 'The service type of the configuration group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'Status' => [ - 'description' => 'The state of the configuration group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AVAILABLE: The configuration group is available.'."\n" - .'* UNAVAILABLE: The configuration group is deleted.'."\n" - .'* DELETING: The configuration group is being deleted.'."\n" - .'* UPDATING: The configuration group is being modified.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AVAILABLE' => '', - 'UNAVAILABLE' => '', - 'DELETING' => '', - 'UPDATING' => '', - ], - 'example' => 'AVAILABLE', - ], - 'BindCount' => [ - 'description' => 'The number of resources that are bound to the configuration group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'BindCountMap' => [ - 'description' => 'The number of bound cloud computers.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The number of bound resources.'."\n", - 'example' => '10', - ], - ], - 'IsUpdate' => [ - 'title' => '系统定时任务检查使用，当前定时任务不支持修改', - 'type' => 'boolean', - ], - 'IsBind' => [ - 'title' => '系统定时任务检查使用，当前定时任务不支持解绑和绑定', - 'type' => 'boolean', - ], - 'InnerTimerName' => [ - 'title' => '前端展示使用，系统定时任务名称映射code', - 'type' => 'string', - 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE', - ], - 'InnerTimerDesc' => [ - 'title' => '前端展示使用，系统定时任务描述使用code', - 'type' => 'string', - 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": [\\n {\\n \\"GroupId\\": \\"ccg-0cid8v30an12****\\",\\n \\"Name\\": \\"定时任务\\",\\n \\"Description\\": \\"定时任务信息\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCount\\": 4,\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsUpdate\\": true,\\n \\"IsBind\\": true,\\n \\"InnerTimerName\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE\\",\\n \\"InnerTimerDesc\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 20\\n}","type":"json"}]', - 'title' => 'DescribeConfigGroup', - ], - 'ModifyTimerGroup' => [ - 'summary' => 'Modifies a scheduled task configuration group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cg-i1ruuudp92qpj****', - ], - ], - [ - 'name' => 'ConfigTimers', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The scheduled tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduled task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* NoConnect: scheduled disconnection upon specified operation (OperationType).'."\n" - .'* TimerBoot: scheduled start.'."\n" - .'* TimerReset: scheduled reset.'."\n" - .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" - .'* NoOperationHibernate: scheduled hibernation upon inactivity.'."\n" - .'* TimerShutdown: scheduled shutdown.'."\n" - .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" - .'* TimerReboot: Restarts the cloud computers on schedule.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'NoConnect' => '', - 'TimerBoot' => '', - 'TimerReset' => '', - 'NoOperationShutdown' => '', - 'NoOperationHibernate' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], - 'example' => 'TIMER_BOOT', - ], - 'CronExpression' => [ - 'description' => 'The cron expression specified in the scheduled task.'."\n" - ."\n" - .'> The time must be in UTC. For example, if your local time is 24:00 (UTC+8), you must set the value to 0 0 16 ? \\* 1,2,3,4,5,6,7.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n", - ], - 'Interval' => [ - 'description' => 'The interval at which the scheduled task is executed. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'Enforce' => [ - 'description' => 'Specifies whether to forcibly execute the scheduled task. A value of true specifies the scheduled task will run forcefully, ignoring the cloud computer and connection status.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'ResetType' => [ - 'description' => 'The reset option.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* RESET_TYPE_SYSTEM: resets the system disk.'."\n" - .'* RESET_TYPE_USER_DISK: resets the data disk.'."\n" - .'* RESET_TYPE_BOTH: resets the system disk and data disk.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '', - 'RESET_TYPE_USER_DISK' => '', - 'RESET_TYPE_BOTH' => '', - ], - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'description' => 'Specifies whether to allow end users to configure the scheduled task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'OperationType' => [ - 'description' => 'The type of the scheduled operation. If you set TimerType to NoConnect, you can specify this parameter.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hibernate: scheduled hibernation.'."\n" - .'* Shutdown: scheduled shutdown.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Hibernate' => '', - 'Shutdown' => '', - ], - 'example' => 'Shutdown', - ], - 'TriggerType' => [ - 'description' => 'The method to trigger the scheduled task upon inactivity.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Advanced: intelligent detection.'."\n" - .'* Standard: standard detection.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Advanced' => '', - 'Standard' => '', - ], - 'example' => 'Standard', - ], - 'ProcessWhitelist' => [ - 'description' => 'The process whitelist. If whitelisted processes are running, the scheduled task does not take effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The process name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'chrome', - ], - 'required' => false, - 'maxItems' => 30, - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'SegmentTimers' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationType' => [ - 'type' => 'string', - 'required' => false, - ], - 'StartCronExpression' => [ - 'type' => 'string', - 'required' => false, - ], - 'EndCronExpression' => [ - 'type' => 'string', - 'required' => false, - ], - 'Interval' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'TriggerType' => [ - 'type' => 'string', - 'required' => false, - ], - 'ProcessWhitelist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, - 'maxItems' => 30, - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'TimerOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - ], - 'Timezone' => [ - 'type' => 'string', - 'required' => false, - ], - 'Enforce' => [ - 'type' => 'boolean', - 'required' => false, - ], - 'ResetType' => [ - 'type' => 'string', - 'required' => false, - ], - 'ImageId' => [ - 'title' => '变更镜像定时任务使用，指定需要变更的镜像ID', - 'type' => 'string', - 'example' => 'm-5b0vjqbiqu010XXXXXX', - ], - 'LockScreenTime' => [ - 'title' => '无操作锁屏功能使用，指定锁屏时间点，非AD桌面不能使用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1800', - ], - 'AppointmentTimer' => [ - 'title' => '定点执行定时任务使用，指定后可以按照指定时间点执行定时任务', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1764660600967', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the configuration group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'cg-i1ruuudp92qpj****', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'OperationTooFrequent', - 'errorMessage' => 'The operation is too frequent, please try again later.', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"GroupId\\": \\"cg-i1ruuudp92qpj****\\"\\n}","type":"json"}]', - 'title' => 'ModifyTimerGroup', + 'createdAt' => '2025-12-23T14:11:36.000Z', + 'description' => '', ], - 'DescribeTimerGroup' => [ - 'summary' => 'Queries a scheduled task configuration group.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-shanghai`.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cn-shanghai' => 'cn-shanghai', - ], - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cg-hs3i1w39o68ma****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Data' => [ - 'description' => 'The configuration group.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupId' => [ - 'description' => 'The ID of the configuration group.'."\n", - 'type' => 'string', - 'example' => 'cg-75aazkg2tnqb2*****', - ], - 'Name' => [ - 'description' => 'The name of the configuration group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The description of the configuration group.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => 'The type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Timer: the scheduled task type.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Timer' => '', - ], - 'example' => 'Timer', - ], - 'ProductType' => [ - 'description' => 'The service type of the configuration group.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* CLOUD_DESKTOP: the cloud computer service.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'ConfigTimers' => [ - 'description' => 'The scheduled tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduled task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* NoConnect: scheduled disconnection upon specified operation (OperationType).'."\n" - .'* TimerBoot: scheduled start.'."\n" - .'* TimerReset: scheduled reset.'."\n" - .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" - .'* NoOperationHibernate: scheduled hibernation upon inactivity.'."\n" - .'* TimerShutdown: scheduled shutdown.'."\n" - .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" - .'* TimerReboot: scheduled restart.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'NoConnect' => '', - 'TimerBoot' => '', - 'TimerReset' => '', - 'NoOperationShutdown' => '', - 'NoOperationHibernate' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], - 'example' => 'TimerBoot', - ], - 'CronExpression' => [ - 'description' => 'The CRON expression for the scheduled task.'."\n", - 'type' => 'string', - 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n", - ], - 'Interval' => [ - 'description' => 'The interval at which the scheduled task is executed. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Enforce' => [ - 'description' => 'Specifies whether to forcibly execute the scheduled task. A value of true specifies the scheduled task will run forcefully, ignoring the cloud computer and connection status.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ResetType' => [ - 'description' => 'The reset operation of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESET_TYPE_SYSTEM: resets the system disk.'."\n" - .'* RESET_TYPE_USER_DISK: resets the data disk.'."\n" - .'* RESET_TYPE_BOTH: resets the system disk and data disk.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '', - 'RESET_TYPE_USER_DISK' => '', - 'RESET_TYPE_BOTH' => '', - ], - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'description' => 'Indicates whether end users can configure scheduled tasks.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'OperationType' => [ - 'description' => 'The type of the scheduled disconnection task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hibernate: scheduled hibernation.'."\n" - .'* Shutdown: scheduled shutdown.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Hibernate' => '', - 'Shutdown' => '', - ], - 'example' => 'Shutdown', - ], - 'TriggerType' => [ - 'description' => 'The method to trigger the scheduled task upon inactivity.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Advanced: intelligent detection.'."\n" - .'* Standard: standard detection.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Advanced' => '', - 'Standard' => '', - ], - 'example' => 'Standard', - ], - 'ProcessWhitelist' => [ - 'description' => 'The process whitelist. If whitelisted processes are running, the scheduled task upon inactivity does not take effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the process.'."\n", - 'type' => 'string', - 'example' => 'chrome', - ], - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'SegmentTimers' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartCronExpression' => [ - 'type' => 'string', - ], - 'EndCronExpression' => [ - 'type' => 'string', - ], - 'OperationType' => [ - 'type' => 'string', - ], - 'Interval' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TriggerType' => [ - 'type' => 'string', - ], - 'ProcessWhitelist' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'NotificationTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'TimerOrder' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Timezone' => [ - 'type' => 'string', - ], - 'Enforce' => [ - 'type' => 'boolean', - ], - 'ResetType' => [ - 'type' => 'string', - ], - 'ImageId' => [ - 'title' => '变更镜像定时任务使用，指定需要变更的镜像ID', - 'type' => 'string', - 'example' => 'm-5b0vjqbiqu010XXXXXX', - ], - 'LockScreenTime' => [ - 'title' => '无操作锁屏功能使用，指定锁屏时间点，非AD桌面不能使用', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1800', - ], - 'AppointmentTimer' => [ - 'title' => '定点执行定时任务使用，指定后可以按照指定时间点执行定时任务', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1764660600967', - ], - ], - ], - ], - ], - ], - ], - 'BindCount' => [ - 'description' => 'The number of resources that are bound to the configuration group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'Status' => [ - 'description' => 'The state of the configuration group.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AVAILABLE: The configuration group is available.'."\n" - .'* UNAVAILABLE: The configuration group is deleted.'."\n" - .'* DELETING: The configuration group is being deleted.'."\n" - .'* UPDATING: The configuration group is being modified.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AVAILABLE' => '', - 'UNAVAILABLE' => '', - 'DELETING' => '', - 'UPDATING' => '', - ], - 'example' => 'AVAILABLE', - ], - 'BindCountMap' => [ - 'description' => 'The number of bound resources.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'integer', - 'format' => 'int32', - 'description' => 'The number of bound resource.'."\n", - 'example' => '10', - ], - ], - 'IsBind' => [ - 'title' => '系统定时任务检查使用，当前定时任务不支持解绑和绑定', - 'type' => 'boolean', - ], - 'IsUpdate' => [ - 'title' => '系统定时任务检查使用，当前定时任务不支持修改', - 'type' => 'boolean', - ], - 'InnerTimerName' => [ - 'title' => '前端展示使用，系统定时任务名称映射code', - 'type' => 'string', - 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE', - ], - 'InnerTimerDesc' => [ - 'title' => '前端展示使用，系统定时任务描述使用code', - 'type' => 'string', - 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC', - ], - ], - ], - ], - ], - ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"cg-75aazkg2tnqb2*****\\",\\n \\"Name\\": \\"定时任务\\",\\n \\"Description\\": \\"定时任务\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"ConfigTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 0 16 ? * 1,2,3,4,5,6,7\\\\n\\",\\n \\"Interval\\": 10,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"Shutdown\\",\\n \\"TriggerType\\": \\"Standard\\",\\n \\"ProcessWhitelist\\": [\\n \\"chrome\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"SegmentTimers\\": [\\n {\\n \\"StartCronExpression\\": \\"\\",\\n \\"EndCronExpression\\": \\"\\",\\n \\"OperationType\\": \\"\\",\\n \\"Interval\\": 0,\\n \\"TriggerType\\": \\"\\",\\n \\"ProcessWhitelist\\": [\\n \\"\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"TimerOrder\\": 0,\\n \\"Timezone\\": \\"\\",\\n \\"Enforce\\": true,\\n \\"ResetType\\": \\"\\",\\n \\"ImageId\\": \\"m-5b0vjqbiqu010XXXXXX\\",\\n \\"LockScreenTime\\": 1800,\\n \\"AppointmentTimer\\": 1764660600967\\n }\\n ]\\n }\\n ],\\n \\"BindCount\\": 50,\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsBind\\": true,\\n \\"IsUpdate\\": true,\\n \\"InnerTimerName\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE\\",\\n \\"InnerTimerDesc\\": \\"INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeTimerGroup', + 'createdAt' => '2025-12-23T02:20:09.000Z', + 'description' => '', ], - 'DescribeGlobalTimerBatches' => [ - 'summary' => 'Queries the batch information in the execution history of scheduled tasks and returns the summary task execution results.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'TimerType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'SearchRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-i1ruuudp92qpj****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******', - ], - 'Count' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NextToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'Results' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BatchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ccg-0cvfvf6u1enx1****', - ], - 'TimerType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'TimerBoot', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2023-08-03T08:27:29Z', - ], - 'SucceedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FailedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'SkippedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RunningCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCenterPolicy'], + ['description' => 'Request parameters changed', 'api' => 'ModifyCenterPolicy'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"SucceedCount\\": 0,\\n \\"FailedCount\\": 0,\\n \\"SkippedCount\\": 0,\\n \\"RunningCount\\": 0\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeGlobalTimerBatches', + 'createdAt' => '2025-12-10T02:26:31.000Z', + 'description' => '', ], - 'DescribeGlobalTimerRecords' => [ - 'summary' => 'Queries the execution records of scheduled tasks on cloud computers.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'TimerTypes', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The scheduled tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* TimerBoot: scheduled start.'."\n" - .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" - .'* NoOperationHibernate: scheduled hibernation upon inactivity.'."\n" - .'* NoConnectHibernate: scheduled hibernation upon disconnection.'."\n" - .'* TimerShutdown: scheduled shutdown.'."\n" - .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" - .'* TimerReboot: scheduled restart.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'NoConnectShutdown' => '', - 'TimerBoot' => '', - 'NoOperationShutdown' => '', - 'NoOperationHibernate' => '', - 'NoConnectHibernate' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], - 'example' => 'TimerBoot', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - ], - [ - 'name' => 'SearchRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'BatchId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the batch in which the scheduled task is executed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-****', - ], - ], - [ - 'name' => 'TimerResult', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution result of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CONNECTED_NOT_RUN: The cloud computer is connected, but the scheduled task is not executed.'."\n" - .'* PAUSED: The scheduled task is suspended.'."\n" - .'* COMPLETED: The scheduled task is executed.'."\n" - .'* FAILED: The scheduled task failed to be executed.'."\n" - .'* RUNNING: The scheduled task is being executed.'."\n" - .'* TERMINATED: The scheduled task is stopped.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CONNECTED_NOT_RUN' => '', - 'PAUSED' => '', - 'COMPLETED' => '', - 'FAILED' => '', - 'RUNNING' => '', - 'TERMINATED' => '', - ], - 'example' => 'RUNNING', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the scheduled task group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ccg-0cvfvf6u1enx1****', - ], - ], - [ - 'name' => 'ResultCategory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the execution result. You can specify this parameter to filter the execution results.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FAILED: The execution is successful.'."\n" - .'* FAILED: The execution failed.'."\n" - .'* RUNNING: The execution is in progress.'."\n" - .'* SKIPPED: The execution is skipped.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'SUCCEED' => '', - 'FAILED' => '', - 'RUNNING' => '', - 'SKIPPED' => '', - ], - 'example' => 'SUCCEED', - ], - ], - [ - 'name' => 'DesktopIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-84mztzatmipf2****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Retryable', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], - ], - [ - 'name' => 'DisplayResultName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCenterPolicy'], + ['description' => 'Request parameters changed', 'api' => 'DescribeCenterPolicyList'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyCenterPolicy'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****', - ], - 'Count' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Results' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The execution results.'."\n", - 'type' => 'object', - 'properties' => [ - 'BatchId' => [ - 'description' => 'The ID of the batch in which the scheduled task is executed.'."\n", - 'type' => 'string', - 'example' => 'ccg-0cvfvf6u1enx1****', - ], - 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n", - 'type' => 'string', - 'example' => 'TimerBoot', - ], - 'TimerResult' => [ - 'description' => 'The execution result of the scheduled task.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'CreateTime' => [ - 'description' => 'The time when the execution record was created.'."\n", - 'type' => 'string', - 'example' => '2023-08-03T08:27:29Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the scheduled task ended.'."\n", - 'type' => 'string', - 'example' => '2025-01-21T02:00:45Z', - ], - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-0c951fy9arnk9****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'DesktopName', - ], - 'TimerGroupId' => [ - 'description' => 'The ID of the scheduled task group.'."\n", - 'type' => 'string', - 'example' => 'ccg-xxxx', - ], - 'ActionType' => [ - 'type' => 'string', - ], - 'Context' => [ - 'type' => 'string', - ], - 'DisplayResultName' => [ - 'type' => 'string', - ], - 'Retryable' => [ - 'type' => 'boolean', - ], - 'TimerRecordId' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2025-12-08T03:21:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktopRecords'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'createdAt' => '2025-12-01T06:53:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCenterPolicy'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyCenterPolicy'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"Count\\": 2,\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"TimerResult\\": \\"RUNNING\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"FinishTime\\": \\"2025-01-21T02:00:45Z\\",\\n \\"DesktopId\\": \\"ecd-0c951fy9arnk9****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DesktopName\\": \\"DesktopName\\",\\n \\"TimerGroupId\\": \\"ccg-xxxx\\",\\n \\"ActionType\\": \\"REBOOT\\",\\n \\"Context\\": \\"{}\\",\\n \\"DisplayResultName\\": \\"\\",\\n \\"Retryable\\": true,\\n \\"TimerRecordId\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeGlobalTimerRecords', + 'createdAt' => '2025-11-24T08:36:46.000Z', + 'description' => '', ], - 'DeleteVirtualMFADevice' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeModificationPrice'], + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-11-04T08:22:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCdsFile'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-11-03T09:39:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCdsFile'], ], - 'systemTags' => [ - 'operationType' => 'delete', + 'createdAt' => '2025-11-03T08:20:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCenterPolicy'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyCenterPolicy'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SerialNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" - ."\n" - .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device that is bound by AD users.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', - ], - ], + 'createdAt' => '2025-10-27T02:27:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSimpleOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'Request parameters changed', 'api' => 'ModifyOfficeSiteAttribute'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2025-10-24T06:35:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroupSessions'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopSessions'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\r\\n","errorExample":""}]', - 'title' => 'DeleteVirtualMFADevice', - 'summary' => 'Removes a virtual multi-factor authentication (MFA) device that is associated with an Active Directory (AD) account.', - 'description' => 'If an MFA device is deleted, the device is unbound, reset, and disabled. When an Active Directory (AD) user wants to connect to the cloud desktop that is bound to the MFA device, the AD user must bind a new MFA device.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2025-10-17T12:22:53.000Z', + 'description' => '', ], - 'DescribeVirtualMFADevices' => [ - 'summary' => 'Queries the virtual multi-factor authentication (MFA) devices that are associated with Active Directory (AD) accounts.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeSnapshots'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-04-10T09:28:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-04-10T02:57:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateImage'], + ['description' => 'Request parameters changed', 'api' => 'RebuildDesktops'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2025-04-09T09:55:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Response parameters changed', 'api' => 'DescribeUsersInGroup'], + ['description' => 'Response parameters changed', 'api' => 'ListDirectoryUsers'], + ['description' => 'Response parameters changed', 'api' => 'ListOfficeSiteUsers'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 500. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '100', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-269345****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The names of the AD users.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the AD user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], - 'required' => false, - 'example' => 'testuser', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], + 'createdAt' => '2025-04-09T06:40:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateConfigGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeTimerGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyTimerGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403', - ], - 'VirtualMFADevices' => [ - 'description' => 'Details of the virtual MFA devices.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SerialNumber' => [ - 'description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n", - 'type' => 'string', - 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', - ], - 'GmtUnlock' => [ - 'description' => 'The time when a locked virtual MFA device was automatically unlocked. The time follows the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-12-21T15:21:28Z', - ], - 'EndUserId' => [ - 'description' => 'The name of the AD user who uses the virtual MFA device.'."\n", - 'type' => 'string', - 'example' => 'usertest', - ], - 'ConsecutiveFails' => [ - 'description' => 'The number of consecutive failures to bind the virtual MFA device, or the number of failures on the verification of the virtual MFA device.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-269345****', - ], - 'status' => [ - 'description' => 'The status of the virtual MFA device.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* LOCKED'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* UNBOUND'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* NORMAL'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'LOCKED' => '', - 'UNBOUND' => '', - 'NORMAL' => '', - ], - 'example' => 'NORMAL', - ], - 'DirectoryId' => [ - 'description' => '> This parameter is in invitational preview and is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'GmtEnabled' => [ - 'description' => 'The time when the virtual MFA device was started. The time follows the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T14:52:28Z', - ], - 'AdUser' => [ - 'type' => 'object', - 'properties' => [ - 'EndUser' => [ - 'type' => 'string', - ], - 'DisplayName' => [ - 'type' => 'string', - ], - 'DisplayNameNew' => [ - 'type' => 'string', - ], - 'UserPrincipalName' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2025-03-27T02:08:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddUserToDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeUsersInGroup'], + ['description' => 'Request parameters changed', 'api' => 'RemoveUserFromDesktopGroup'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as\\",\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\",\\n \\"VirtualMFADevices\\": [\\n {\\n \\"SerialNumber\\": \\"a25f297f-f2e1-4a44-bbf1-5f48a6e5****\\",\\n \\"GmtUnlock\\": \\"2020-12-21T15:21:28Z\\",\\n \\"EndUserId\\": \\"usertest\\",\\n \\"ConsecutiveFails\\": 1,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-269345****\\",\\n \\"status\\": \\"NORMAL\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"GmtEnabled\\": \\"2020-12-20T14:52:28Z\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 2020-12-20T14:52:28Z\\n cn-hangzhou+dir-269345****\\n usertest\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n a25f297f-f2e1-4a44-bbf1-5f48a6e5****\\n 1\\n 2020-12-21T15:21:28Z\\n NORMAL\\n\\nFB550AAB-FB36-4A91-93F6-F4374AF65403\\nAAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as\\n","errorExample":""}]', - 'title' => 'DescribeVirtualMFADevices', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2025-03-24T03:52:22.000Z', + 'description' => '', ], - 'UnlockVirtualMFADevice' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'RebootDesktops'], + ['description' => 'Request parameters changed', 'api' => 'StopDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-03-18T06:41:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-03-18T03:50:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SerialNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" - ."\n" - .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device bound to Active Directory (AD) users.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', - ], - ], + 'createdAt' => '2025-03-17T06:50:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePolicyGroups'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2025-03-03T16:22:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopsInGroup'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\r\\n","errorExample":""}]', - 'title' => 'UnlockVirtualMFADevice', - 'summary' => 'Unlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2025-02-27T02:51:44.000Z', + 'description' => '', ], - 'LockVirtualMFADevice' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateSimpleOfficeSite'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-02-25T06:02:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopTypes'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-02-25T03:27:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyOfficeSiteDnsInfo'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'SerialNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number of the virtual MFA device, which is a unique identifier.'."\n" - ."\n" - .'You can call the [DescribeVirtualMFADevices](~~206210~~) operation to query the serial number of the virtual MFA device bound to AD users.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****', - ], - ], + 'createdAt' => '2025-02-18T08:37:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2025-02-17T12:03:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'RenewNetworkPackages'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'LockVirtualMFADevice', - 'summary' => 'Locks a multi-factor authentication (MFA) device that is in the NORMAL state.', - 'description' => 'After a virtual MFA device is locked, its status changes to LOCKED. The Active Directory (AD) user who uses the virtual MFA device is unable to pass MFA and is therefore unable to log on to the client. You can call the [UnlockVirtualMFADevice](~~206212~~) operation to unlock the device.'."\n", + 'createdAt' => '2025-02-14T06:20:51.000Z', + 'description' => '', ], - 'DescribeFotaTasks' => [ - 'summary' => 'Queries a list of update tasks.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-02-14T04:04:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2025-02-11T09:33:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Valid values: 1 to 100'."\n" - .'* Default value: 20'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. If the NextToken parameter is empty, no next page exists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'TaskUid', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the image update tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aot-c4khwrp9ocml4****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'UserStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to automatically push the image update task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Running: automatically pushes the image update task.'."\n" - .'* Pending: does not automatically push the image update task.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Running' => '', - 'Pending' => '', - ], - 'example' => 'Pending', - ], - ], - [ - 'name' => 'FotaStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'To be hidden.', - ], - ], - [ - 'name' => 'Lang', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the image version to update.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en: English.'."\n" - .'* zh: Simplified Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], - ], + 'createdAt' => '2025-01-24T02:43:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopTypes'], + ], + 'createdAt' => '2025-01-24T01:26:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeAclEntries'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2025-01-20T07:28:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeRecordings'], + ], + 'createdAt' => '2025-01-16T11:30:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], + ], + 'createdAt' => '2025-01-15T03:19:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApplyAutoSnapshotPolicy'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSnapshots'], + ], + 'createdAt' => '2025-01-15T02:18:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeClientEvents'], + ], + 'createdAt' => '2025-01-11T09:28:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ], + 'createdAt' => '2025-01-10T07:46:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ], + 'createdAt' => '2024-12-19T08:53:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeNASFileSystems'], + ], + 'createdAt' => '2024-12-19T08:11:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopSessions'], + ], + 'createdAt' => '2024-12-09T12:04:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'FotaTasks' => [ - 'description' => 'Details about the image update task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details about the image update task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskUid' => [ - 'description' => 'The ID of the image upgrade task.'."\n", - 'type' => 'string', - 'example' => 'aot-c4khwrp9ocml4****', - ], - 'FotaProject' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'To be hidden.', - ], - 'AppVersion' => [ - 'description' => 'The image version. You can call the [DescribeImages](~~188895~~) operation to obtain the value of this parameter.'."\n", - 'type' => 'string', - 'example' => '0.0.1-D-20220513.143129', - ], - 'Status' => [ - 'description' => 'Indicates whether the image update task is automatically pushed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Running: automatically pushes the image update task.'."\n" - .'* Pending: does not automatically push the image update task.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Running' => '', - 'Pending' => '', - ], - 'example' => 'valid', - ], - 'PublishTime' => [ - 'description' => 'The time when the image version available for update was published.'."\n", - 'type' => 'string', - 'example' => '2022-05-31T04:28:48Z', - ], - 'PendingDesktopCount' => [ - 'description' => 'The number of cloud computers whose images can be updated to this version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ReleaseNote' => [ - 'description' => 'The description of the image version available for update.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Size' => [ - 'description' => 'The size of the update package. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '568533470', - ], - 'PendingCustomImageCount' => [ - 'description' => 'The number of custom images that can be updated to this version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Code' => [ - 'description' => 'The returned message. If the request was successful, a `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned error message. This parameter is not returned if the Code value is a `success` message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - ], - ], - ], + 'createdAt' => '2024-12-06T03:15:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopSpec'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FotaTasks\\": [\\n {\\n \\"TaskUid\\": \\"aot-c4khwrp9ocml4****\\",\\n \\"FotaProject\\": \\"To be hidden.\\",\\n \\"AppVersion\\": \\"0.0.1-D-20220513.143129\\",\\n \\"Status\\": \\"valid\\",\\n \\"PublishTime\\": \\"2022-05-31T04:28:48Z\\",\\n \\"PendingDesktopCount\\": 1,\\n \\"ReleaseNote\\": \\"test\\",\\n \\"Size\\": 568533470,\\n \\"PendingCustomImageCount\\": 1\\n }\\n ],\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The parameter is not specified.\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\"\\n}","type":"json"}]', - 'title' => 'DescribeFotaTasks', + 'createdAt' => '2024-12-02T07:41:23.000Z', + 'description' => '', ], - 'DescribeFotaPendingDesktops' => [ - 'summary' => 'Queries information about the cloud computers whose images can be and are pending to be updated to the specified version.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeCloudDriveGroups'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-12-02T02:37:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'MigrateDesktops'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-11-20T09:59:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetConnectionTicket'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2024-11-13T06:38:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopTypes'], + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], + ['description' => 'Request parameters changed', 'api' => 'UploadImage'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Valid values: 1 to 100.'."\n" - .'* Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '500', - 'minimum' => '0', - 'example' => '20', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'TaskUid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aot-c4khwrp9ocml4****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the office network. You can call the [DescribeOfficeSites](~~216071~~) operation to obtain the value of this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - [ - 'name' => 'DesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testName', - ], - ], + 'createdAt' => '2024-11-09T02:22:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyCloudDrivePermission'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'FotaPendingDesktops' => [ - 'description' => 'The cloud computers whose images can be and are pending to be updated to the version specified in `TaskUid`.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ecd-bvdtu3jn97o1r****', - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'TestDesktop', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-815419****', - ], - 'FotaProject' => [ - 'description' => '> This parameter is not publicly available.'."\n", - 'type' => 'string', - 'example' => 'To be hidden', - ], - 'CurrentAppVersion' => [ - 'description' => 'The current version of the image used by the cloud computer.'."\n", - 'type' => 'string', - 'example' => '0.0.1-D-20220513.143129', - ], - 'Status' => [ - 'description' => 'The status of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: The cloud computer is being created.'."\n" - .'* 1: The cloud computer is being started.'."\n" - .'* 2: The cloud computer is running.'."\n" - .'* 3: The cloud computer is being stopped.'."\n" - .'* 5: The cloud computer is stopped.'."\n" - .'* 6: The cloud computer expires.'."\n" - .'* 7: The cloud computer is deleted.'."\n" - .'* 9: Failed to create the cloud computer.', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - '', - '', - 5 => '', - '', - '', - 9 => '', - ], - 'example' => '2', - ], - 'Sessions' => [ - 'description' => 'The connected sessions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the end user that connects to the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'end user id', - ], - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'description' => 'The response code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], + 'createdAt' => '2024-11-04T09:17:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeRenewalPrice'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FotaPendingDesktops\\": [\\n {\\n \\"DesktopId\\": \\"ecd-bvdtu3jn97o1r****\\",\\n \\"DesktopName\\": \\"demo-computer\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-428216****\\",\\n \\"FotaProject\\": \\"windows\\",\\n \\"CurrentAppVersion\\": \\"0.0.1-D-20220513.143129\\",\\n \\"Status\\": 2,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\"\\n}","type":"json"}]', - 'title' => 'DescribeFotaPendingDesktops', + 'createdAt' => '2024-11-01T02:06:14.000Z', + 'description' => '', ], - 'UpdateFotaTask' => [ - 'summary' => 'Enables or disables the auto-push feature for an image update task.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-10-29T05:29:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-10-23T08:48:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2024-09-27T09:48:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopTypes'], + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TaskUid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the image update task. You can call the [DescribeFotaTasks](~~437001~~) operation to obtain the value of this parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aot-c4khwrp9ocml4****', - ], - ], - [ - 'name' => 'UserStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to automatically push the image update task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Running: automatically pushes the image update task.'."\n" - .'* Pending: does not automatically push the image update task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Running' => '', - 'Pending' => '', - ], - 'example' => 'Pending', - ], - ], + 'createdAt' => '2024-09-27T07:36:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'VerifyCen'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2024-09-23T07:05:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAutoSnapshotPolicy'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'UpdateFotaTask', - 'description' => 'You can call this operation to manage each image update task. This operation is valid only when the auto-update switch in the image update module for global image updates is turned off. If the auto-update switch is turned on, the switches for each image update task are always turned on. If you want to turn on or off the auto-update switch, go to the Elastic Desktop Service console and choose **Operations > Image Updates** in the left-side navigation pane.', + 'createdAt' => '2024-09-12T07:13:05.000Z', + 'description' => '', ], - 'ApproveFotaUpdate' => [ - 'summary' => 'Allows you to upgrade images.', - 'methods' => [ - 'get', - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListDirectoryUsers'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-09-06T14:20:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopSessions'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-08-21T01:36:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + 'createdAt' => '2024-08-15T02:55:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeInvocations'], + ['description' => 'Request parameters changed', 'api' => 'RunCommand'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by Elastic Desktop Service.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-138dsptkrt00u****', - ], - ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'Mirror version.', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.1-D-20220513.143129', - ], - ], + 'createdAt' => '2024-08-13T06:30:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2024-08-09T10:00:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ApproveFotaUpdate', - 'description' => 'The cloud computers for which you want to allow image updates must be in the Running state.'."\n", + 'createdAt' => '2024-08-05T08:34:36.000Z', + 'description' => '', ], - 'SetOfficeSiteSsoStatus' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-08-05T02:53:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2024-07-31T10:04:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2024-07-25T11:11:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeCloudDriveGroups'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - [ - 'name' => 'EnableSso', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SSO.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* false'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'boolean', - 'required' => true, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - ], + 'createdAt' => '2024-07-23T12:38:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CancelAutoSnapshotPolicy'], + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeAutoSnapshotPolicy'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2024-07-22T02:12:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeBundles'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopTypes'], + ], + 'createdAt' => '2024-07-19T04:02:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2024-07-19T01:53:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2024-07-10T12:27:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RenewDesktops'], + ], + 'createdAt' => '2024-07-09T03:34:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopSessions'], + ], + 'createdAt' => '2024-07-08T12:44:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2024-07-04T13:59:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2024-07-01T02:35:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopSessions'], + ], + 'createdAt' => '2024-07-01T02:32:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDirectories'], + ['description' => 'Request parameters changed', 'api' => 'ModifyADConnectorOfficeSite'], + ], + 'createdAt' => '2024-06-26T07:32:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'MigrateDesktops'], + ], + 'createdAt' => '2024-06-19T06:03:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyDesktopSpec'], + ['description' => 'Request parameters changed', 'api' => 'RenewDesktops'], + ], + 'createdAt' => '2024-06-17T13:20:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RebuildDesktops'], + ], + 'createdAt' => '2024-06-17T13:00:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2024-06-17T11:57:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopGroupInfo'], + ], + 'createdAt' => '2024-06-14T11:08:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'Request parameters changed', 'api' => 'MigrateDesktops'], + ], + 'createdAt' => '2024-06-01T13:42:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RenewDesktops'], + ], + 'createdAt' => '2024-06-01T11:49:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopInfo'], + ], + 'createdAt' => '2024-05-07T04:25:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ['description' => 'Request parameters changed', 'api' => 'RenewDesktops'], + ], + 'createdAt' => '2024-04-29T13:58:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2024-04-29T06:51:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateCloudDriveService'], + ], + 'createdAt' => '2024-04-19T03:12:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopSessions'], + ], + 'createdAt' => '2024-04-15T06:39:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddDevices'], + ['description' => 'Request parameters changed', 'api' => 'DescribeFotaPendingDesktops'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFotaTask'], + ], + 'createdAt' => '2024-03-25T11:44:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ResetDesktops'], + ], + 'createdAt' => '2024-03-13T02:48:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateCloudDriveService'], + ], + 'createdAt' => '2024-03-12T12:16:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateSnapshot'], + ], + 'createdAt' => '2024-02-05T08:10:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2024-01-26T09:20:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2024-01-05T03:28:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopInfo'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]', - 'title' => 'SetOfficeSiteSsoStatus', - 'summary' => 'Enables or disables single sign-on (SSO) for an office network.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2024-01-04T05:05:37.000Z', + 'description' => '', ], - 'SetIdpMetadata' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopSpec'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-12-12T02:44:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCloudDriveService'], + ['description' => 'Response parameters changed', 'api' => 'DescribeCloudDriveGroups'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-12-11T14:21:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeFotaTasks'], ], - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2023-12-06T02:38:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeFotaTasks'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID. This parameter is the same as `OfficeSiteId`. We recommend that you use `OfficeSiteId` to replace `DirectoryId`. You can specify only `DirectoryId` or `OfficeSiteId`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-400695****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-400695****', - ], - ], - [ - 'name' => 'IdpMetadata', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata of the IdP.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '<EntityDescriptor ID********Descriptor>', - ], - ], + 'createdAt' => '2023-11-23T06:18:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'IdpEntityId' => [ - 'description' => 'The entity ID obtained after the IdP metadata file is parsed.'."\n", - 'type' => 'string', - 'example' => 'http://test****.cn/adfs/services/trust', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-11-21T14:37:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateDesktops'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IdpEntityId\\": \\"http://test****.cn/adfs/services/trust\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F369A091-002F-49C8-AD55-02A776297C7B\\n http://test****.cn/adfs/services/trust\\n","errorExample":""}]', - 'title' => 'SetIdpMetadata', - 'summary' => 'Uploads the metadata of a Security Assertion Markup Language (SAML) 2.0-based identity provider (IdP).', - 'description' => 'You can call this operation only for workspaces of the Active Directory (AD) and convenience account types.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-11-15T13:06:50.000Z', + 'description' => '', ], - 'SetDirectorySsoStatus' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-11-15T12:07:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyOfficeSiteAttribute'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-11-15T09:36:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSimpleOfficeSite'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The AD directory ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-h95efs1mbukd9****', - ], - ], - [ - 'name' => 'EnableSso', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable SSO. Valid values:'."\n" - ."\n" - .'* true: enables SSO.'."\n" - .'* false: disables SSO.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - ], + 'createdAt' => '2023-11-15T08:55:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeNetworkPackages'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-10-26T06:49:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CompleteCdsFile'], + ['description' => 'Request parameters changed', 'api' => 'CopyCdsFile'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n AF5539DC-F0CE-4F04-A8BC-50B65F86FE61\\r\\n","errorExample":""}]', - 'title' => 'SetDirectorySsoStatus', - 'summary' => 'Enables or disables the single sign-on (SSO) feature for an Active Directory (AD) account-based office network.', - 'description' => 'This operation is supported only for AD directories, not for RAM directories.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-09-25T12:03:34.000Z', + 'description' => '', ], - 'GetOfficeSiteSsoStatus' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCdsFile'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-09-25T11:13:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-09-22T09:14:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-09-20T03:02:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], + 'createdAt' => '2023-09-11T08:23:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateDesktopGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The object that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'SsoStatus' => [ - 'description' => 'Indicates whether SSO is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-09-05T03:59:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddFilePermission'], + ['description' => 'Request parameters changed', 'api' => 'CreateCdsFileShareLink'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteCdsFile'], + ['description' => 'Request parameters changed', 'api' => 'ListCdsFiles'], + ['description' => 'Request parameters changed', 'api' => 'ListFilePermission'], + ['description' => 'Request parameters changed', 'api' => 'ModifyCdsFile'], + ['description' => 'Request parameters changed', 'api' => 'MoveCdsFile'], + ['description' => 'Request parameters changed', 'api' => 'RemoveFilePermission'], + ], + 'createdAt' => '2023-08-29T02:56:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopTypes'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"SsoStatus\\": false,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9C013BF3-BA83-400E-85DF-861804F0948A\\n false\\n","errorExample":""}]', - 'title' => 'GetOfficeSiteSsoStatus', - 'summary' => 'Queries whether single sign-on (SSO) is enabled for an office network.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-08-01T01:54:49.000Z', + 'description' => '', ], - 'GetSpMetadata' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-07-31T09:51:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopChargeType'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-07-19T09:19:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeFotaPendingDesktops'], ], - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-07-14T09:45:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID. This parameter is the same as `OfficeSiteId`. We recommend that you use `OfficeSiteId` to replace `DirectoryId`. You can specify only `DirectoryId` or `OfficeSiteId`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-400695****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-400695****', - ], - ], + 'createdAt' => '2023-07-12T03:57:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'SpMetadata' => [ - 'description' => 'The metadata of the SP.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-07-03T09:44:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeCloudDriveUsers'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"SpMetadata\\": \\"\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n <?xml version=************/md:EntityDescriptor>\\n D3506372-0840-466F-9E73-98D58432D6A7\\n","errorExample":""}]', - 'title' => 'GetSpMetadata', - 'summary' => 'Obtains the metadata of a Security Assertion Markup Language (SAML) 2.0-based service provider (SP).', - 'description' => 'You can call this operation only for workspaces of the Active Directory (AD) and convenience account types.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-06-30T08:55:56.000Z', + 'description' => '', ], - 'StopInvocation' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeCloudDriveGroups'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-06-27T02:27:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DescribeDesktopsInGroup'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-06-19T11:40:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateImage'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeImages'], ], - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2023-06-13T12:35:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'InvokeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the execution.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 't-7d2a745b412b4601b2d47f6a768d****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of cloud desktop N. Valid values of N: 1 to 50.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of cloud desktop N.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - 'maxItems' => 50, - ], - ], + 'createdAt' => '2023-06-13T08:13:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeBundles'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-06-10T09:39:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F5F82BA8-92FE-49E4-AEB9-9010CE7329F3\\r\\n","errorExample":""}]', - 'title' => 'StopInvocation', - 'summary' => 'Stop a process that executes the Cloud Assistant script in one or more cloud computers.', - 'description' => 'When you stop a one-time execution of a command, the command continues to run on the cloud desktops where it has started to run, and will not run on the cloud desktops where it has not started to run.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-05-24T02:48:46.000Z', + 'description' => '', ], - 'DescribeInvocations' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-05-24T02:38:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Response parameters changed', 'api' => 'DescribeInvocations'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-05-18T06:09:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CopyCdsFile'], + ['description' => 'Request parameters changed', 'api' => 'ListCdsFiles'], ], - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-05-16T11:00:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'DescribeDesktops'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'InvokeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution ID of the command. You can obtain the value by calling the [RunCommand](~~RunCommand~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 't-hz0jdfwd9f****', - ], - ], - [ - 'name' => 'CommandType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The command type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RunPowerShellScript: the PowerShell command.'."\n" - .'* RunBatScript: the Bat command.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RunPowerShellScript' => '', - 'RunBatScript' => '', - ], - 'example' => 'RunPowerShellScript', - ], - ], - [ - 'name' => 'InvokeStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The execution status of the command. The value of this parameter is determined by the execution states of the command on all participating cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Finished: The command execution completes on all cloud computers. Alternatively, the command execution is manually stopped on some cloud computers while it completes on the others.'."\n" - .'* Stopped: The command execution stops.'."\n" - .'* Failed: The command execution failed on all cloud computers.'."\n" - .'* Running: Once there is a command execution in progress, the execution status defaults to Running.'."\n" - .'* PartialFailed: If the command execution failed on part of the cloud computers, the execution status is considered partially failed.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Finished' => '', - 'Stopped' => '', - 'Failed' => '', - 'Running' => '', - 'PartialFailed' => '', - ], - 'example' => 'Finished', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID. If you specify a cloud computer, all command execution records of the cloud computer are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - ], - [ - 'name' => 'IncludeOutput', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return command outputs in the response.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'ContentEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => 'The encoding method of the command content and outputs.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Base64 (default): returns the Base64-encoded command content and command outputs.'."\n" - .'* PlainText: returns the original command content and outputs in plain text.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Base64' => '', - 'PlainText' => '', - ], - 'example' => 'PlainText', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Valid values: 1 to 50.'."\n" - .'* Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '50', - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query token. Set the value to the NextToken value that is returned from the last call to the previous DescribeInvocations operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - ], - [ - 'name' => 'DesktopIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs.'."\n" - ."\n" - .'> The `DesktopId` parameter will be deprecated. We recommend using the DesktopIds parameter to specify cloud computer IDs instead.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-84mztzatmipf2****', - ], - 'required' => false, - 'maxItems' => 500, - ], - ], - [ - 'name' => 'IncludeInvokeDesktops', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the execution results of the remote command on all cloud computers when executed across multiple cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], + 'createdAt' => '2023-05-06T07:42:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeBundles'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'The query token that is returned from this call.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], - 'Invocations' => [ - 'description' => 'The command execution records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The command execution record.'."\n", - 'type' => 'object', - 'properties' => [ - 'InvokeId' => [ - 'description' => 'The ID of the execution.'."\n", - 'type' => 'string', - 'example' => 't-hz0jdfwd9f****', - ], - 'CommandContent' => [ - 'description' => 'The Base64-encoded command content.'."\n", - 'type' => 'string', - 'example' => 'cnBtIC1xYSB8IGdyZXAgdnNm****', - ], - 'CommandType' => [ - 'description' => 'The type of the command.'."\n", - 'type' => 'string', - 'example' => 'RunPowerShellScript', - ], - 'InvocationStatus' => [ - 'description' => 'The overall execution status of the command. The value of this parameter depends on the execution status of the command on all the involved cloud computers. Valid values:'."\n" - ."\n" - .'* Pending: The command is being verified or sent. If the execution status is Pending on at least one cloud computer, the overall status is considered Pending.'."\n" - ."\n" - .'* Running: The command is being executed on cloud computers. If the execution status is Running on at least one cloud computer, the overall status is considered Running.'."\n" - ."\n" - .'* Success: If the execution status is Success on at least one cloud computer and either Success or Stopped on all other cloud computers, the overall status is considered Success.'."\n" - ."\n" - .'* Failed: If the execution status is Stopped or Failed on all cloud computers, the overall status is considered Failed. If any execution status on cloud computers matches one of the following values, Failed is returned.'."\n" - ."\n" - .' * Invalid: The command is invalid.'."\n" - .' * Aborted: The command failed to be sent.'."\n" - .' * Failed: The command is executed, but the exit code is not 0.'."\n" - .' * Timeout: The command execution timed out.'."\n" - .' * Error: An error occurred when the command is being executed.'."\n" - ."\n" - .'* Stopping: The command execution is being stopped. If the execution status is Stopping on at least one cloud computer, the overall status is considered Stopping.'."\n" - ."\n" - .'* Stopped: The command execution stops. If the execution status is Stopped on at least one cloud computer, the overall status is considered Stopped. If any execution status on cloud computers matches one of the following values, Stopped is returned.'."\n" - ."\n" - .' * Cancelled: The command execution is canceled.'."\n" - .' * Terminated: The command execution is terminated.'."\n" - ."\n" - .'* PartialFailed: The command execution succeeded on some cloud computers but failed on others. If the execution status on any cloud computer is Success, Failed, or Stopped, the overall status is considered PartialFailed.'."\n", - 'type' => 'string', - 'example' => 'Pending', - ], - 'CreationTime' => [ - 'description' => 'The time when the execution task is created.'."\n", - 'type' => 'string', - 'example' => '2020-12-19T09:15:46Z', - ], - 'EndUserId' => [ - 'description' => 'The ID of the end user.', - 'type' => 'string', - 'example' => 'User1', - ], - 'InvokeDesktops' => [ - 'description' => 'The cloud computers on which the command is executed.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer on which the command is executed.'."\n", - 'type' => 'object', - 'properties' => [ - 'InvocationStatus' => [ - 'description' => 'The execution progress of the command on a single cloud computer.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Output' => [ - 'description' => 'The command output.'."\n" - ."\n" - .'* When the `IncludeOutput` parameter is set to false, the output is not returned.'."\n" - .'* When the `ContentEncoding` parameter is set to Base64, the output is returned as a Base64-encoded string.'."\n", - 'type' => 'string', - 'example' => 'OutPutTestmsg', - ], - 'CreationTime' => [ - 'description' => 'The time when the command execution was performed.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T06:15:54Z', - ], - 'UpdateTime' => [ - 'description' => 'The time when the execution status was updated.'."\n", - 'type' => 'string', - 'example' => '2020-12-25T06:15:56Z', - ], - 'Repeats' => [ - 'description' => 'The number of times the command has been executed on the cloud computer.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - 'Dropped' => [ - 'description' => 'The size of the text that is truncated and discarded when the Output value exceeds 24 KB in size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StartTime' => [ - 'description' => 'The start time of the command execution.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T06:15:55Z', - ], - 'StopTime' => [ - 'description' => 'The stop time of the command execution (StopInvocatio).'."\n", - 'type' => 'string', - 'example' => '2020-12-25T09:15:47Z', - ], - 'FinishTime' => [ - 'description' => 'The time when the command execution ended.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T06:15:56Z', - ], - 'ExitCode' => [ - 'description' => 'The exit code of the execution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ErrorCode' => [ - 'description' => 'The code explaining why the command failed to be sent or executed. Valid values:'."\n" - ."\n" - .'* Null: The command is executed successfully.'."\n" - .'* InstanceNotExists: The specified cloud computer does not exist or is released.'."\n" - .'* InstanceReleased: The cloud computer is released during the execution.'."\n" - .'* InstanceNotRunning: The cloud computer is not running during the execution.'."\n" - .'* CommandNotApplicable: The command cannot be executed on the specified cloud computer.'."\n" - .'* ClientNotRunning: The Cloud Assistant agent is not running.'."\n" - .'* ClientNotResponse: The Cloud Assistant agent does not respond.'."\n" - .'* ClientIsUpgrading: The Cloud Assistant agent is being updated.'."\n" - .'* ClientNeedUpgrade: The Cloud Assistant agent needs to be updated.'."\n" - .'* DeliveryTimeout: The command sending times out.'."\n" - .'* ExecutionTimeout: The command execution times out.'."\n" - .'* ExecutionException: An exception occurs when the command is being executed.'."\n" - .'* ExecutionInterrupted: The command execution is interrupted.'."\n" - .'* ExitCodeNonzero: The command execution completes, but the exit code is not 0.'."\n", - 'type' => 'string', - 'example' => 'InstanceNotExists', - ], - 'ErrorInfo' => [ - 'description' => 'The message explaining why the command failed to be sent or executed. Valid values:'."\n" - ."\n" - .'* Null: The command is executed successfully.'."\n" - .'* the specified instance does not exists: The specified cloud computer does not exist or is released.'."\n" - .'* the instance has released when create task: The cloud computer is released during the execution.'."\n" - .'* the instance is not running when create task: The cloud computer is not running during the execution.'."\n" - .'* the command is not applicable: The command cannot be executed on the specified cloud computer.'."\n" - .'* the aliyun service is not running on the instance: The Cloud Assistant agent is not running.'."\n" - .'* the aliyun service in the instance does not response: The Cloud Assistant agent does not respond.'."\n" - .'* the aliyun service in the instance is upgrading now: The Cloud Assistant agent is being updated.'."\n" - .'* the aliyun service in the instance need upgrade: The Cloud Assistant agent needs to be updated.'."\n" - .'* the command delivery has been timeout: The command sending times out.'."\n" - .'* the command execution has been timeout: The command execution times out.'."\n" - .'* the command execution got an exception: An exception occurs when the command is being executed.'."\n" - .'* the command execution has been interrupted: The command execution is interrupted.'."\n" - .'* the command execution exit code is not zero: The command execution completes, but the exit code is not 0.'."\n", - 'type' => 'string', - 'example' => 'The specified instance does not exist.', - ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'demo1234', - ], - ], - ], - ], - 'InvokeDesktopCount' => [ - 'description' => 'The total number of cloud computers on which the command is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InvokeDesktopSucceedCount' => [ - 'description' => 'The total number of cloud computers on which the command execution succeeds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2023-04-27T14:08:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateCdsFile'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Invocations\\": [\\n {\\n \\"InvokeId\\": \\"t-hz0jdfwd9f****\\",\\n \\"CommandContent\\": \\"cnBtIC1xYSB8IGdyZXAgdnNm****\\",\\n \\"CommandType\\": \\"RunPowerShellScript\\",\\n \\"InvocationStatus\\": \\"Pending\\",\\n \\"CreationTime\\": \\"2020-12-19T09:15:46Z\\",\\n \\"EndUserId\\": \\"User1\\",\\n \\"InvokeDesktops\\": [\\n {\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"Output\\": \\"OutPutTestmsg\\",\\n \\"CreationTime\\": \\"2020-12-20T06:15:54Z\\",\\n \\"UpdateTime\\": \\"2020-12-25T06:15:56Z\\",\\n \\"Repeats\\": 0,\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\",\\n \\"Dropped\\": 0,\\n \\"StartTime\\": \\"2020-12-20T06:15:55Z\\",\\n \\"StopTime\\": \\"2020-12-25T09:15:47Z\\",\\n \\"FinishTime\\": \\"2020-12-20T06:15:56Z\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorCode\\": \\"InstanceNotExists\\",\\n \\"ErrorInfo\\": \\"The specified instance does not exist.\\",\\n \\"DesktopName\\": \\"demo1234\\"\\n }\\n ],\\n \\"InvokeDesktopCount\\": 1,\\n \\"InvokeDesktopSucceedCount\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 2020-12-19T09:15:46Z\\n cnBtIC1xYSB8IGdyZXAgdnNm****\\n Pending\\n RunPowerShellScript\\n t-hz0jdfwd9f****\\n \\n \\n \\n 0\\n Success\\n the specified instance does not exists\\n 0\\n 2020-12-20T06:15:55Z\\n ecd-7w78ozhjcwa3u****\\n 0\\n 2020-12-20T06:15:56Z\\n OutPutTestmsg\\n 2020-12-25T06:15:56Z\\n 2020-12-20T06:15:54Z\\n InstanceNotExists\\n 2020-12-25T09:15:47Z\\n \\n \\n","errorExample":""}]', - 'title' => 'DescribeInvocations', - 'description' => '* After you run a command, it may not succeed. You can call this operation to query the execution result.'."\n" - .'* You can query the information about execution in the last two weeks. A maximum of 100,000 lines of execution information can be retained.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-04-26T07:15:13.000Z', + 'description' => '', ], - 'RunCommand' => [ - 'summary' => 'Runs a PowerShell or batch (.bat) command on one or more Windows cloud computers.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'RebuildDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-04-25T03:54:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-04-24T09:37:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2023-04-24T07:40:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ConfigADConnectorTrust'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the O\\&M command. Valid values:'."\n" - ."\n" - .'* RunBatScript'."\n" - .'* RunPowerShellScript'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'RunPowerShellScript', - ], - ], - [ - 'name' => 'CommandContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the command. The command content can be plaintext or Base64-encoded.\\'."\n" - .'The Base64-encoded command content cannot exceed 16 KB in size.'."\n" - ."\n" - .'> If the command content is Base64-encoded, you must set the ContentEncoding parameter to Base64.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ipconfig', - ], - ], - [ - 'name' => 'Timeout', - 'in' => 'query', - 'schema' => [ - 'description' => 'The timeout period for the command to run. Unit: seconds. Default value: 60.\\'."\n" - .'A timeout error occurs if the command cannot be run because the process slows down or because a specific module or the Cloud Assistant client does not exist. When a timeout error occurs, the command process is forcibly terminated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3600', - ], - ], - [ - 'name' => 'ContentEncoding', - 'in' => 'query', - 'schema' => [ - 'description' => 'The encoding mode of the command content. Valid values:'."\n" - ."\n" - .'* PlainText: The command content is not encoded.'."\n" - .'* Base64: The command content is Base64-encoded.'."\n" - ."\n" - .'Default value: PlainText. If the specified value of this parameter is invalid, PlainText is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Base64', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The ID of cloud desktop N. Valid values of N: 1 to 50.\\'."\n" - .'If multiple cloud desktops are specified and the command execution succeeds on at least one of the cloud desktops, the operation is considered successful. If multiple cloud desktops are specified and the command execution fails on all the cloud desktops, verify the value of the parameter and try again.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - 'required' => true, - 'maxItems' => 300, - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The ID of the end user. If you specify a value, you run the command as the end user that is granted specific permissions. Note: The end user has sessions on a cloud computer. That is, when the cloud computer is started, the end user logs on to an Alibaba Cloud Workspace client and connects to the cloud computer, and the cloud computer is not preempted by another end user during the connection. This parameter is not available for Linux cloud computers.', - 'type' => 'string', - 'required' => false, - 'example' => 'User1', - ], - ], - [ - 'name' => 'CommandRole', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], - ], + 'createdAt' => '2023-04-19T03:15:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'TagResources'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The object that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'InvokeId' => [ - 'description' => 'The ID of the command execution.'."\n", - 'type' => 'string', - 'example' => 't-hz01qgsqj2n****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2023-04-17T08:21:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListOfficeSiteOverview'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeId\\": \\"t-hz01qgsqj2n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'RunCommand', - 'description' => 'You can use the RunCommand operation to run scripts only on Windows cloud desktops.'."\n", + 'createdAt' => '2023-04-13T07:46:23.000Z', + 'description' => '', ], - 'ListTagResources' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateCdsFile'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-04-10T12:50:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateCdsFile'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-04-03T07:01:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyCloudDriveGroups'], ], - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-03-31T10:38:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALIYUN::GWS::INSTANCE: cloud computer.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ALIYUN::GWS::INSTANCE' => '', - ], - 'example' => 'ALIYUN::GWS::INSTANCE', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs, which are cloud computer IDs. You can specify 1 to 50 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID, which is the cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - ], - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - 'maxItems' => 50, - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag value of the resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag keys. You can specify 1 to 20 tag keys.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag values. You can specify 1 to 20 tag values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], - ], + 'createdAt' => '2023-03-28T10:13:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeFotaTasks'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of response.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C', - ], - 'TagResources' => [ - 'description' => 'The resources and their tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TagValue' => [ - 'description' => 'The tag values.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - 'ResourceType' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALIYUN::GWS::INSTANCE: cloud computer.', - 'type' => 'string', - 'enumValueTitles' => [ - 'ALIYUN::GWS::INSTANCE' => '', - ], - 'example' => 'ALIYUN::GWS::INSTANCE', - ], - 'ResourceId' => [ - 'description' => 'The resource ID, which is the cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-ia2zw38bi6cm7****', - ], - 'TagKey' => [ - 'description' => 'The tag keys.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2023-03-28T04:47:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeSnapshots'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"design\\",\\n \\"ResourceType\\": \\"ALIYUN::GWS::INSTANCE\\",\\n \\"ResourceId\\": \\"ecd-ia2zw38bi6cm7****\\",\\n \\"TagKey\\": \\"department\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n \\n ecd-ia2zw38bi6cm7****\\n TestKey\\n ALIYUN::GWS::INSTANCE\\n TestValue\\n \\n","errorExample":""}]', - 'title' => 'ListTagResources', - 'summary' => 'Queries the tags of cloud computers.', - 'description' => '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`.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-03-24T08:25:54.000Z', + 'description' => '', ], - 'TagResources' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAutoSnapshotPolicy'], + ['description' => 'Request parameters changed', 'api' => 'ModifyAutoSnapshotPolicy'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-03-24T08:25:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyOfficeSiteAttribute'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-03-24T08:24:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], ], - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2023-03-24T08:22:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDesktops'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALIYUN::GWS::INSTANCE: cloud computer.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ALIYUN::GWS::INSTANCE' => 'ALIYUN::GWS::INSTANCE', - ], - 'example' => 'ALIYUN::GWS::INSTANCE', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs, which are cloud computer IDs. You can specify 1 to 50 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID, which is the cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - ], - 'required' => true, - 'example' => 'ecd-ia2zw38bi6cm7****', - 'maxItems' => 100, - ], - ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to add to the cloud computers. You can specify 1 to 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag keys. The tag key cannot be an empty string. The tag key can be up to 128 characters in length. It cannot start with `acs:` or `aliyun` and cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag values. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `acs:` and cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 20, - ], - ], + 'createdAt' => '2023-03-24T08:22:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteImages'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeBundles'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2023-03-24T08:21:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'SetDesktopGroupTimer'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'SetDesktopGroupTimerStatus'], + ], + 'createdAt' => '2023-01-11T08:21:57.000Z', + 'description' => '更新SetDesktopGroupTimer和SetDesktopGroupTimerStatus返回值', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeBundles'], + ], + 'createdAt' => '2023-01-05T11:09:40.000Z', + 'description' => '增加sessionType字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopsInGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeImages'], + ], + 'createdAt' => '2023-01-04T02:47:28.000Z', + 'description' => '查询镜像接口增加镜像信息', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListUserAdOrganizationUnits'], + ], + 'createdAt' => '2022-12-14T07:35:29.000Z', + 'description' => '1、列举OU支持分页查找；2、支持导入用户的校验', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeClientEvents'], + ], + 'createdAt' => '2022-12-08T05:12:14.000Z', + 'description' => '添加autoCleanUserData字段，支持自动清理用户残留数据', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateNetworkPackage'], + ['description' => 'Response parameters changed', 'api' => 'DescribeNetworkPackages'], + ], + 'createdAt' => '2022-11-30T03:34:19.000Z', + 'description' => '后付费按带宽网络包', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyDesktopsPolicyGroup'], + ], + 'createdAt' => '2022-11-25T01:43:13.000Z', + 'description' => '预检查参数供内部使用，不开放', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSnapshot'], + ], + 'createdAt' => '2022-11-22T06:32:19.000Z', + 'description' => '新增云盘文件修改、删除，文件夹共享相关API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExportClientEvents'], + ], + 'createdAt' => '2022-11-22T03:46:31.000Z', + 'description' => '数据导出支持英文表头', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2022-11-22T01:57:20.000Z', + 'description' => '策略创建与修改', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Response parameters changed', 'api' => 'GetDesktopGroupDetail'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopsPolicyGroup'], + ], + 'createdAt' => '2022-11-22T01:56:45.000Z', + 'description' => '多策略支持', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAutoSnapshotPolicy'], + ], + 'createdAt' => '2022-11-17T09:23:19.000Z', + 'description' => '修改快照策略创建时间的后端字段名称', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorDirectory'], + ['description' => 'Request parameters changed', 'api' => 'CreateRAMDirectory'], + ], + 'createdAt' => '2022-11-14T06:22:52.000Z', + 'description' => '参数变更', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2022-11-04T13:39:38.000Z', + 'description' => '新增录屏音频录制选项', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeNASFileSystems'], + ], + 'createdAt' => '2022-10-27T01:46:26.000Z', + 'description' => '暂时隐藏domainId', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeNASFileSystems'], + ], + 'createdAt' => '2022-10-27T01:33:16.000Z', + 'description' => '桌面组支持UPM', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeInvocations'], + ], + 'createdAt' => '2022-10-18T15:10:21.000Z', + 'description' => 'DescribeInvocations接口增加DesktopIds参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ModifyDiskSpec'], + ], + 'createdAt' => '2022-10-17T02:12:23.000Z', + 'description' => '变更ESSD云盘性能等级', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopsInGroup'], + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopListInfo'], + ], + 'createdAt' => '2022-10-14T06:27:52.000Z', + 'description' => '限制ExportDesktopListInfo和DescribeDesktopsInGroup的分页查询最大数量为100', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-10-14T02:36:33.000Z', + 'description' => '文档更新', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2022-10-08T02:11:23.000Z', + 'description' => '基于会话生命周期的录屏设计能力以及文件阅览时长设置', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDesktopMetricList'], + ], + 'createdAt' => '2022-10-08T02:08:14.000Z', + 'description' => '监控二期会话操作，应用程序查询扩展', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeInvocations'], + ['description' => 'Request parameters changed', 'api' => 'RunCommand'], + ], + 'createdAt' => '2022-09-29T06:07:42.000Z', + 'description' => 'ASP桌面新增会话级别命令下发', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetConnectionTicket'], + ], + 'createdAt' => '2022-09-28T12:18:05.000Z', + 'description' => '新增应用自启动功能', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ], + 'createdAt' => '2022-09-23T08:24:33.000Z', + 'description' => 'CreateDesktopGroup接口的PolicyGroupId的修改为必填参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeImages'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2022-09-22T06:08:51.000Z', + 'description' => '将fotachannel改为私有参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ApplyCoordinatePrivilege'], + ['description' => 'OpenAPI offline', 'api' => 'ApplyCoordinatePrivilege'], + ['description' => 'OpenAPI offline', 'api' => 'RevokeCoordinatePrivilege'], + ['description' => 'OpenAPI offline', 'api' => 'RevokeCoordinatePrivilege'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]', - 'title' => 'TagResources', - 'summary' => 'Adds tags to cloud computers. This allows you to filter and manage cloud computers by tag.', - 'description' => 'If TagKey is specified, the new TagValue value overrides the original TagValue value.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-09-16T02:36:15.000Z', + 'description' => '增加远程协助的键鼠控制功能', ], - 'UntagResources' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-09-13T02:35:45.000Z', + 'description' => 'DescribeBundle add Platform parameter', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeCustomizedListHeaders'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyCustomizedListHeaders'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-09-09T06:35:01.000Z', + 'description' => '增加用户自定义桌面列表表头的API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateImage'], ], - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2022-09-06T06:31:49.000Z', + 'description' => '用户操作日志接口：DescribeClientEvents、ExportClientEvents，增加了组合EventType，可以在query参数中添加："EventTypes.1":"GET_CONNECTION_TICKET","EventTypes.2":"DESKTOP_START"等来查询多个EventType类型的操作事件，快来试试吧~', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAndBindNasFileSystem'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALIYUN::GWS::INSTANCE: cloud computer.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ALIYUN::GWS::INSTANCE' => 'ALIYUN::GWS::INSTANCE', - ], - 'example' => 'ALIYUN::GWS::INSTANCE', - ], - ], - [ - 'name' => 'All', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to unbind all tags from the resource. This parameter takes effect only when TagKey.N is not specified. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => true, - 'example' => 'false', - ], - ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs, which are cloud computer IDs. You can specify 1 to 50 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The resource ID, which is the cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-ia2zw38bi6cm7****', - ], - 'required' => true, - 'example' => 'ecd-ia2zw38bi6cm7****', - 'maxItems' => 50, - ], - ], - [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag keys. You can specify 1 to 20 tag keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'required' => false, - 'example' => 'TestKey', - 'maxItems' => 20, - ], - ], + 'createdAt' => '2022-09-05T12:56:50.000Z', + 'description' => '增加UPM相关的接口参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2022-09-05T11:20:37.000Z', + 'description' => '策略添加防截屏， 自定义录屏策略', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDrive'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDrive'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDrives'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]', - 'title' => 'UntagResources', - 'summary' => '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.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-08-31T07:12:00.000Z', + 'description' => '发布存储服务drive相关API', ], - 'DescribeClientEvents' => [ - 'summary' => 'Queries the operation logs of end users. For example, the logs record the events that end users start and stop cloud desktops, and disconnect desktop sessions.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-08-24T14:48:40.000Z', + 'description' => 'CreateDesktopGroup接口的ChargeType设置为必填参数。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSnapshots'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-19T06:40:16.000Z', + 'description' => 'DescribeSnapshots接口增加协议类型返回字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopsInGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetDesktopGroupDetail'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2022-08-19T03:29:10.000Z', + 'description' => '为自动开关机功能，增加桌面组接口相关的入参和出参', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopsInGroup'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The information about the end user that connects to the cloud desktop from the Elastic Desktop Service (EDS) client. The information can be a Resource Access Management (RAM) user ID or an Active Directory (AD) username. If you do not specify a value for this parameter, the events of all end users in the specified region are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '28961708130834****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud desktop ID. If you do not specify a value for this parameter, events of all cloud desktops in the specified region are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-8fupvkhg0aayu****', - ], - ], - [ - 'name' => 'DesktopIp', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address of the cloud desktop. If you do not specify a value for this parameter, the events of all cloud desktops in the specified region are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10.10.*.*', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is not available to the public.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the cloud desktop belongs. If you do not specify a value for this parameter, the events of all workspaces in the specified region are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the events that you want to query. If you specify multiple values for the EventTypes parameter, the events of all specified types are returned. If you do not specify values for the EventTypes and EventType parameters, all events of end users in the specified region are returned.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DESKTOP_STOP: End users stop the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* GET_LITE_CONNECTION_TICKET: End users obtain the credential for reconnecting to the cloud desktop upon disconnection.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_DISCONNECT: End users disconnect desktop sessions.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* GET_CONNECTION_TICKET: End users request to connect to the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CLIENT_LOGIN: End users log on to the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_REBOOT: End users restart the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_CONNECT: End users establish desktop sessions.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_START: End users start the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP_STOP' => '', - 'GET_LITE_CONNECTION_TICKET' => '', - 'DESKTOP_DISCONNECT' => '', - 'GET_CONNECTION_TICKET' => '', - 'CLIENT_LOGIN' => '', - 'DESKTOP_REBOOT' => '', - 'DESKTOP_CONNECT' => '', - 'DESKTOP_START' => '', - ], - 'example' => 'DESKTOP_DISCONNECT', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.\\'."\n" - .'If you do not specify a value for this parameter, all events that occurred before the point in time that you specify for `EndTime` are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-11-30T06:32:31Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.\\'."\n" - .'If you do not specify a value for this parameter, the current time is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-11-31T06:32:31Z', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.\\'."\n" - .'Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - ], - [ - 'name' => 'OfficeSiteName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'DesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud desktop name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'EventTypes', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The array of event types that you want to query. You can specify multiple event types. The response contains all or specified types of events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the events that you want to query.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DESKTOP_STOP: End users stop the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* GET_LITE_CONNECTION_TICKET: End users obtain the credential for reconnecting to the cloud desktop upon disconnection.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_DISCONNECT: End users disconnect desktop sessions.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* GET_CONNECTION_TICKET: End users request to connect to the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* CLIENT_LOGIN: End users log on to the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_REBOOT: End users restart the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_CONNECT: End users establish desktop sessions.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* DESKTOP_START: End users start the cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP_STOP' => '', - 'GET_LITE_CONNECTION_TICKET' => '', - 'DESKTOP_DISCONNECT' => '', - 'GET_CONNECTION_TICKET' => '', - 'CLIENT_LOGIN' => '', - 'DESKTOP_REBOOT' => '', - 'DESKTOP_CONNECT' => '', - 'DESKTOP_START' => '', - ], - 'example' => 'DESKTOP_START', - ], - 'required' => false, - 'docRequired' => true, - 'maxItems' => 50, - 'minItems' => 0, - ], - ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'FillHardwareInfo', - 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], - ], + 'createdAt' => '2022-08-17T08:47:41.000Z', + 'description' => 'DescribeDesktopsInGroup 增加出参：MemberEniIp 和 PrimaryEniIp', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteCloudDriveUsers'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeCloudDrivePermissions'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyCloudDrivePermission'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '28A40F12-F340-442B-A35F-46EF6A03227B', - ], - 'Events' => [ - 'description' => 'The user events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user event.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the event. If you set the EventType parameter to `DESKTOP_DISCONNECT` or `GET_CONNECTION_TICKET`, this parameter is returned. Valid values:'."\n" - ."\n" - .'* 200\\. The value indicates that the request is successful.'."\n" - .'* An error message. The value indicates that the request failed. Example: FailedToGetConnectionTicket.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'BytesReceived' => [ - 'description' => 'The number of bytes that are received.'."\n", - 'type' => 'string', - 'example' => '8665', - ], - 'DesktopIp' => [ - 'description' => 'The IP address of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => '10.10.*.*', - ], - 'EventTime' => [ - 'description' => 'The time when the event occurred.'."\n", - 'type' => 'string', - 'example' => '2020-11-30T06:32:31Z', - ], - 'BytesSend' => [ - 'description' => 'The number of bytes that are sent.'."\n", - 'type' => 'string', - 'example' => '2345', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the workspace to which the cloud desktop belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', - ], - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account with which the event is associated.'."\n", - 'type' => 'string', - 'example' => '112259558861****', - ], - 'DesktopId' => [ - 'description' => 'The cloud desktop ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-8fupvkhg0aayu****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'EventId' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => '5651188b-3070-d1cc-5311-75753d59****', - ], - 'DirectoryType' => [ - 'description' => 'The directory type.'."\n", - 'type' => 'string', - 'example' => 'RAM', - ], - 'EventType' => [ - 'description' => 'The event type. Valid values:'."\n", - 'type' => 'string', - 'example' => 'DESKTOP_DISCONNECT', - ], - 'EndUserId' => [ - 'description' => 'The information about the end user that connects to the cloud desktop from the EDS client. The information can be a RAM user ID or an AD username.'."\n", - 'type' => 'string', - 'example' => '28961708130834****', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client.'."\n", - 'type' => 'string', - 'example' => '100.68.*.*', - ], - 'ClientOS' => [ - 'description' => 'The OS that the client runs.'."\n", - 'type' => 'string', - 'example' => 'Darwin 17.7.0 x64', - ], - 'OfficeSiteType' => [ - 'description' => 'The account type of the workspace.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SIMPLE: convenience account'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* AD_CONNECTOR: enterprise AD account'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SIMPLE' => '', - 'AD_CONNECTOR' => '', - ], - 'example' => 'SIMPLE', - ], - 'DirectoryId' => [ - 'description' => 'The ID of the directory to which the cloud desktop belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****', - ], - 'ClientVersion' => [ - 'description' => 'The client version.'."\n", - 'type' => 'string', - 'example' => '1.0.4 202012021700', - ], - 'OfficeSiteName' => [ - 'description' => 'The workspace name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DesktopName' => [ - 'description' => 'The cloud desktop name.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DesktopGroupId' => [ - 'description' => 'The desktop group ID.'."\n", - 'type' => 'string', - 'example' => 'dg-kadkdfaf****', - ], - 'DesktopGroupName' => [ - 'description' => 'The desktop group name.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'Description' => [ - 'description' => 'The description.', - 'type' => 'string', - 'example' => 'test', - ], - 'TerminalInfo' => [ - 'type' => 'object', - 'properties' => [ - 'ProductName' => [ - 'type' => 'string', - ], - 'SerialNumber' => [ - 'type' => 'string', - ], - 'Model' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-08-17T02:00:13.000Z', + 'description' => '无影云盘支持个人账户的设置', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03227B\\",\\n \\"Events\\": [\\n {\\n \\"Status\\": \\"200\\",\\n \\"BytesReceived\\": \\"8665\\",\\n \\"DesktopIp\\": \\"10.10.XX.XX\\",\\n \\"EventTime\\": \\"2020-11-30T06:32:31Z\\",\\n \\"BytesSend\\": \\"2345\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"AliUid\\": \\"112259558861****\\",\\n \\"DesktopId\\": \\"ecd-8fupvkhg0aayu****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EventId\\": \\"5651188b-3070-d1cc-5311-75753d59****\\",\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"EventType\\": \\"DESKTOP_DISCONNECT\\",\\n \\"EndUserId\\": \\"28961708130834****\\",\\n \\"ClientIp\\": \\"100.68.*.*\\",\\n \\"ClientOS\\": \\"Darwin 17.7.0 x64\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"ClientVersion\\": \\"1.0.4 202012021700\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"DesktopName\\": \\"test\\",\\n \\"DesktopGroupId\\": \\"dg-kadkdfaf****\\",\\n \\"DesktopGroupName\\": \\"testName\\",\\n \\"Description\\": \\"test\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"Model\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n 28A40F12-F340-442B-A35F-46EF6A03227B\\n \\n 200\\n 8665\\n 10.10.*.*\\n 2020-11-30T06:32:31Z\\n 2345\\n cn-hangzhou+dir-bh77qa8nmjot4****\\n 112259558861****\\n ecd-8fupvkhg0aayu****\\n cn-hangzhou\\n 5651188b-3070-d1cc-5311-75753d59****\\n RAM\\n DESKTOP_DISCONNECT\\n 28961708130834****\\n 100.68.*.*\\n Darwin 17.7.0 x64\\n SIMPLE\\n cn-hangzhou+dir-bh77qa8nmjot4****\\n 1.0.4 202012021700\\n test\\n test\\n dg-kadkdfaf****\\n testName\\n \\n","errorExample":""}]', - 'title' => 'DescribeClientEvents', - 'description' => 'You can audit the operation logs of regular users to improve security. The operation logs record events such as desktop startup, shutdown, and session disconnection.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-08-11T07:30:38.000Z', + 'description' => '更改桌面组，添加最大空闲时间和最大链接时间', ], - 'ExportClientEvents' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'GetDesktopGroupDetail'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-08-11T06:39:10.000Z', + 'description' => '增加空闲时间和最大连接时间，版本号', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'GetDesktopGroupDetail'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-08-11T02:45:02.000Z', + 'description' => '配合多 session 自动伸缩需求，在桌面组相关的创建，修改和查询等 4 个接口中增加自动伸缩参数 RatioThreshold', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeUsersInGroup'], + ], + 'createdAt' => '2022-08-10T09:10:03.000Z', + 'description' => '在 DescribeUsersInGroup 接口中增加出参 userDesktopId，向前兼容', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ], + 'createdAt' => '2022-08-08T08:04:15.000Z', + 'description' => '新增UserCommands字段，可以在新建桌面后执行自定义脚本命令。', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeUsersPassword'], + ], + 'createdAt' => '2022-08-04T10:24:20.000Z', + 'description' => '管理员支持获取登陆密码', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-08-04T09:52:45.000Z', + 'description' => 'DescribeDesktops 恢复取消限制', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-08-04T09:35:20.000Z', + 'description' => 'describeDesktops 查询数量集限制500', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeRegions'], + ], + 'createdAt' => '2022-08-02T02:03:06.000Z', + 'description' => 'describeRegions增加参数language and localName', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeNetworkPackages'], + ], + 'createdAt' => '2022-07-28T02:07:35.000Z', + 'description' => '网络包返回工作区类型', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the endpoint user.', - 'type' => 'string', - 'required' => false, - 'example' => 'user01', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - ], - [ - 'name' => 'DesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testName', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - [ - 'name' => 'OfficeSiteName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the event that you want to query. If you provide multiple values for EventTypes, the response will include events of all the specified types. If you provide no values for EventTypes and EventType, the response will include all events in the designated region.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DESKTOP_STOP: the shutdown event.'."\n" - .'* GET_LITE_CONNECTION_TICKET: the event of retrieving the connection ticket.'."\n" - .'* DESKTOP_DISCONNECT: the session disconnection event.'."\n" - .'* CLIENT_LOGIN: the user logon event.'."\n" - .'* GET_CONNECTION_TICKET: the connection credential retrieval event.'."\n" - .'* DESKTOP_REBOOT: the restart event.'."\n" - .'* DESKTOP_CONNECT: the session establishment event.'."\n" - .'* DESKTOP_START: the start event.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP_STOP' => '', - 'GET_LITE_CONNECTION_TICKET' => '', - 'DESKTOP_DISCONNECT' => '', - 'CLIENT_LOGIN' => '', - 'GET_CONNECTION_TICKET' => '', - 'DESKTOP_REBOOT' => '', - 'DESKTOP_CONNECT' => '', - 'DESKTOP_START' => '', - ], - 'example' => 'CLIENT_LOGIN', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'If you do not specify a value for this parameter, all events that occurred before the point in time that you specify for `EndTime` are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-03-23T04:10:21Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.'."\n" - ."\n" - .'If you do not specify a value for this parameter, the current time is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-03-23T07:11:01Z', - ], - ], - [ - 'name' => 'EventTypes', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The types of the events that you want to query. You can include multiple event types, and the response will return events matching the specified types or all events if none are specified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event that you want to query.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DESKTOP_STOP: the shutdown event.'."\n" - .'* GET_LITE_CONNECTION_TICKET: the event of retrieving the connection ticket.'."\n" - .'* DESKTOP_DISCONNECT: the session disconnection event.'."\n" - .'* CLIENT_LOGIN: the user logon event.'."\n" - .'* GET_CONNECTION_TICKET: the connection credential retrieval event.'."\n" - .'* DESKTOP_REBOOT: the restart event.'."\n" - .'* DESKTOP_CONNECT: the session establishment event.'."\n" - .'* DESKTOP_START: the start event.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP_STOP' => '', - 'GET_LITE_CONNECTION_TICKET' => '', - 'DESKTOP_DISCONNECT' => '', - 'CLIENT_LOGIN' => '', - 'GET_CONNECTION_TICKET' => '', - 'DESKTOP_REBOOT' => '', - 'DESKTOP_CONNECT' => '', - 'DESKTOP_START' => '', - ], - 'example' => 'CLIENT_LOGIN', - ], - 'required' => false, - 'maxItems' => 50, - 'minItems' => 0, - ], - ], - [ - 'name' => 'LangType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language displayed on the frontend page. The backend uses this setting to define the language of exported files.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* zh-CN: Simplified Chinese.'."\n" - .'* en-GB: British English.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'zh-CN' => '', - 'en-GB' => '', - ], - 'example' => 'zh-CN', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'* Maximum value: 5000.'."\n" - .'* Default value: 5000.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], - ], + 'createdAt' => '2022-07-19T03:54:59.000Z', + 'description' => '新增录屏文件过期时间设置和查询参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateNetworkPackage'], + ['description' => 'Request parameters changed', 'api' => 'ModifyNetworkPackageBandwidth'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Url' => [ - 'description' => 'The download URL of the exported files.'."\n", - 'type' => 'string', - 'example' => 'https://cn-shanghai-servicemanager.oss-cn-shanghai.aliyuncs.com/A0_CLIENT_EVENT/EDS_Events%20List_20220519234611_w5HuD83KGs.csv?Expires=1652975773&OSSAccessKeyId=****&Signature=4erMG*********k%3D', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2022-07-14T07:58:43.000Z', + 'description' => '带宽售卖下限调整', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"https://cn-shanghai-servicemanager.oss-cn-shanghai.aliyuncs.com/A0_CLIENT_EVENT/EDS_Events%20List_20220519234611_w5HuD83KGs.csv?Expires=1652975773&OSSAccessKeyId=****&Signature=4erMG*********k%3D\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ExportClientEvents', - 'summary' => 'Exports events that occur on a cloud desktop from an Alibaba Cloud Workspace client.', + 'createdAt' => '2022-07-12T07:03:51.000Z', + 'description' => '允许自动伸缩策略中的最大桌面数设置为 0', ], - 'DescribeRecordings' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopListInfo'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-07-07T06:28:42.000Z', + 'description' => 'describeDesktops 和 ExportDesktopListInfo 接口入参新增tag字段，用户可以通过tag来进行筛选桌面', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SetOfficeSiteSsoStatus'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-07-07T06:15:19.000Z', + 'description' => '隐藏部分参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApplyCoordinationForMonitoring'], ], - 'systemTags' => [ - 'operationType' => 'list', + 'createdAt' => '2022-07-07T03:54:52.000Z', + 'description' => '添加了远程协助接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeInvocations'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], - ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The maximum number of entries per page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****', - ], - ], - [ - 'name' => 'PolicyGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pg-gx2x1dhsmthe9****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID. If this parameter is not specified, the screen recording files on all cloud computers in the designated region will be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-hlh41mk78dugw****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the query. Specify the time in the `YYYYMMDDhhmmss` format. The time must be in UTC+8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20230424000000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the query. Specify the time in the `YYYYMMDDhhmmss` format. The time must be in UTC+8.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20230424004441', - ], - ], - [ - 'name' => 'NeedSignedUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return a URL.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false (default)'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - ], - [ - 'name' => 'SignedUrlExpireMinutes', - 'in' => 'query', - 'schema' => [ - 'description' => 'The validity period of the returned URL. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'StandardStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the query. Specify the time in the ISO 8601 standard in the `yyyy-mm-ddthh:mm:ssz` format. The time must be in UTC+0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-27T02:20:10Z', - ], - ], - [ - 'name' => 'StandardEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the query. Specify the time in the ISO 8601 standard in the `yyyy-mm-ddthh:mm:ssz` format. The time must be in UTC+0.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-27T02:30:10Z', - ], - ], + 'createdAt' => '2022-06-30T12:11:48.000Z', + 'description' => '新增EndUserId，支持用户态命令执行，查询', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nbCQ7ar+fECeh1IuWQXi39R5eoJ68zWp99mTAKRRNRhw==', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '327CFE78-1C0D-51AC-A9C6-BCEDF0DD44D6', - ], - 'Recordings' => [ - 'description' => 'The screen recording files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The screen recording file.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the recording.'."\n", - 'type' => 'string', - 'example' => '2023-04-10T07:26:06Z', - ], - 'FilePath' => [ - 'description' => 'The file path.'."\n", - 'type' => 'string', - 'example' => 'pg-4w5nk44zo5yl129dd/1mk78dugw344.mp4', - ], - 'StartTime' => [ - 'description' => 'The start time of the recording.'."\n", - 'type' => 'string', - 'example' => '2023-04-10T07:26:06Z', - ], - 'RecordingType' => [ - 'description' => 'The type of event that triggers the recording.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* byaction_cmd_ft: triggered by copy-paste or file transfer events.'."\n" - .'* period: triggered at scheduled intervals.'."\n" - .'* session: triggered by session lifecycle monitoring.'."\n" - .'* byaction_commands: triggered by copy-paste only.'."\n" - .'* alltime: continuous recording.'."\n" - .'* byaction_file_transfer: triggered by file transfer only.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'byaction_cmd_ft' => '', - 'period' => '', - 'session' => '', - 'byaction_commands' => '', - 'alltime' => '', - 'byaction_file_transfer' => '', - ], - 'example' => 'alltime', - ], - 'RecordingSize' => [ - 'description' => 'The size of the screen recording file. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1742845', - ], - 'DesktopId' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-10v0vuvm616sk****', - ], - 'EndUserIds' => [ - 'description' => 'The end user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - ], - 'PolicyGroupId' => [ - 'description' => 'The policy ID.'."\n", - 'type' => 'string', - 'example' => 'pg-6dn811rzrwh9ws4z6', - ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'DemoComputer', - ], - 'SignedUrl' => [ - 'description' => 'The download URL of the screen recording file.'."\n", - 'type' => 'string', - 'example' => 'https://eds-recording-bucket-cn-hangzhou-137187566615****.oss-cn-hangzhou.aliyuncs.com/pg-28l5tdjd33txz****/ecd-e0so9m9u6chf1****_gftest001_alltime_s0_****.mp4?Expires=171256****&OSSAccessKeyId=STS.NSwQo6S****&Signature=****4WyAA', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2022-06-30T06:10:19.000Z', + 'description' => '新增网络重定向策略', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeUsersInGroup'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nbCQ7ar+fECeh1IuWQXi39R5eoJ68zWp99mTAKRRNRhw==\\",\\n \\"RequestId\\": \\"327CFE78-1C0D-51AC-A9C6-BCEDF0DD44D6\\",\\n \\"Recordings\\": [\\n {\\n \\"EndTime\\": \\"2023-04-10T07:26:06Z\\",\\n \\"FilePath\\": \\"pg-4w5nk44zo5yl1****/1mk78dugw344.mp4\\",\\n \\"StartTime\\": \\"2023-04-10T07:26:06Z\\",\\n \\"RecordingType\\": \\"alltime\\",\\n \\"RecordingSize\\": 1742845,\\n \\"DesktopId\\": \\"ecd-10v0vuvm616sk****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"PolicyGroupId\\": \\"pg-6dn811rzrwh9w****\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"SignedUrl\\": \\"https://eds-recording-bucket-cn-hangzhou-137187566615****.oss-cn-hangzhou.aliyuncs.com/pg-28l5tdjd33txz****/ecd-e0so9m9u6chf1****_gftest001_alltime_s0_****.mp4?Expires=171256****&OSSAccessKeyId=STS.****&Signature=****4WyAA\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRecordings', - 'summary' => 'Queries the details of screen recording files.', + 'createdAt' => '2022-06-17T03:46:00.000Z', + 'description' => 'DescribeUsersInGroup接口支持按姓名过滤', ], - 'DescribeRecordFile' => [ - 'summary' => 'Queries the screen recording files in all regions.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeVulList'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-06-16T09:19:13.000Z', + 'description' => 'Progress，DesktopGroupId 字段设置成不可见', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeConvertQuota'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-06-10T06:56:57.000Z', + 'description' => '内部接口，不对外', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + 'createdAt' => '2022-06-08T02:37:36.000Z', + 'description' => '无需展示', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Alice', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '20251218175715', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '20251218205715', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'RecordType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'alltime', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'startTime', - ], - ], - [ - 'name' => 'OrderSort', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'asc', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '100', - 'example' => '20', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Task7', - ], - ], + 'createdAt' => '2022-06-07T11:38:11.000Z', + 'description' => '修改桌面组相关的POP API的流控配置，可能被频繁调用的设置为单用户每分钟6000次，其他的设置为单用户每分钟600次。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2022-06-07T11:37:56.000Z', + 'description' => 'ModifyPolicyGroup 和 CreatePolicyGroup 设置 水印自定义字段为私有', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeVirtualMFADevices'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'RequestId', - 'type' => 'string', - 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'RecordFiles' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RecordExpire' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1774656000000', - ], - 'RecordType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'period', - ], - 'EndUserId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Alice', - ], - 'RecordEndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-18T06:02:25Z', - ], - 'RecordStartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-12-18T06:02:25Z', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Task3', - ], - 'DesktopId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ecd-7yulhw1g1attet7d2', - ], - 'FileSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '139', - ], - 'EventDetails' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EventTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'EventType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'UserInput', - ], - 'EventName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '{\\n\\t\\"messageInfo\\" : \\"mouse_move\\",\\n\\t\\"messageType\\" : \\"UserInput\\"\\n}\\n"', - ], - ], - ], - ], - 'DesktopName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'fvt-ecd', - ], - 'PolicyId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'pg-**', - ], - 'RegionId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ResourceGroupId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'rg-f3s3dgt8dtb0vlqc8', - ], - 'ResourceGroupName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'resource', - ], - ], - ], - ], - ], - ], - ], + 'createdAt' => '2022-06-07T11:37:03.000Z', + 'description' => '优化api文档', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopGroupInfo'], + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopListInfo'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\",\\n \\"TotalCount\\": 2,\\n \\"RecordFiles\\": [\\n {\\n \\"Status\\": 1,\\n \\"RecordExpire\\": 1774656000000,\\n \\"RecordType\\": 0,\\n \\"EndUserId\\": \\"Alice\\",\\n \\"RecordEndTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"RecordStartTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"FileName\\": \\"Task3\\",\\n \\"DesktopId\\": \\"ecd-7yulhw1g1attet7d2\\",\\n \\"FileSize\\": 139,\\n \\"EventDetails\\": [\\n {\\n \\"EventTime\\": 60,\\n \\"EventType\\": \\"UserInput\\",\\n \\"EventName\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageInfo\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"mouse_move\\\\\\\\\\\\\\",\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageType\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"UserInput\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\\\n\\\\\\"\\"\\n }\\n ],\\n \\"DesktopName\\": \\"fvt-ecd\\",\\n \\"PolicyId\\": \\"pg-**\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"resource\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRecordFile', + 'createdAt' => '2022-06-02T09:00:10.000Z', + 'description' => '设置DirectoryId私有，并更新文档中两个字段的必填属性', ], - 'DescribeGlobalDesktopRecords' => [ - 'summary' => 'Queries the basic information of all cloud computers and the corresponding usage duration records.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UploadImage'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2022-06-01T06:40:29.000Z', + 'description' => '增加可选的安全防护能力', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeVulList'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-05-31T09:55:37.000Z', + 'description' => '返回体增加Progress字段和desktopGroupId字段，Progress用于漏洞操作进度展示，desktopGroupId用于控制桌面组桌面跳转能力', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopTypes'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'createdAt' => '2022-05-31T07:08:04.000Z', + 'description' => '不对外开放的字段，无需变更文档', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AssociateNetworkPackage'], + ['description' => 'OpenAPI offline', 'api' => 'DissociateNetworkPackage'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'* China (Shanghai)'."\n" - .'* Singapore'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time. Supported formats:'."\n" - ."\n" - .'* Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-03-23T04:10:21Z', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time. The interval between the start time and end time can be up to 30 days. Supported formats:'."\n" - ."\n" - .'* Format: YYYY-MM-DDThh:mm:ssZ.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-31T06:56:45Z', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the current page.\\'."\n" - .'Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The cloud computer IDs. You can specify 1 to 100 office network IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'DesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DemoComputer', - ], - ], - [ - 'name' => 'SubPayType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The way to purchase cloud computers. Valid values:'."\n" - ."\n" - .'* prePaid: The monthly purchase is unlimited.'."\n" - .'* postPaid: pay-as-you-go'."\n" - .'* monthPackage: monthly duration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'monthPackage', - ], - ], - [ - 'name' => 'Scope', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query range. This parameter is empty by default. Optional values are:'."\n" - ."\n" - .'* ADVANCED: indicates that statistics such as the connection duration are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ADVANCED', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting field. If this parameter is not provided, results are sorted by creation time in descending order. Valid values:'."\n" - ."\n" - .'* uptime: indicates that the cloud computers are sorted by startup duration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'uptime', - ], - ], - [ - 'name' => 'SortType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sorting method. Default value: ascending. Valid value:'."\n" - ."\n" - .'* Asc: ascending order'."\n" - .'* Desc: descending.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestUser', - ], - ], - [ - 'name' => 'DesktopType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of the specifications supported by the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eds.enterprise_office.2c4g', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-3mtuc28rx95lx****', - ], - ], - [ - 'name' => 'DesktopStatusList', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '需要包含的云电脑状态列表', - 'type' => 'array', - 'items' => [ - 'title' => '需要包含的云电脑状态', - 'type' => 'string', - ], - 'maxItems' => 20, - ], - ], - [ - 'name' => 'ExcludeDesktopStatusList', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '需要排除的云电脑状态列表', - 'type' => 'array', - 'items' => [ - 'title' => '需要排除的云电脑状态', - 'type' => 'string', - ], - 'maxItems' => 20, - ], - ], + 'createdAt' => '2022-05-30T01:27:20.000Z', + 'description' => '网络包增加解绑/绑定操作', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ResetDesktops'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Sessions' => [ - 'description' => 'The session details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the session.'."\n", - 'type' => 'object', - 'properties' => [ - 'Platform' => [ - 'description' => 'The specific model of the operating system.'."\n", - 'type' => 'string', - 'example' => 'Windows 10', - ], - 'StatusChangeTime' => [ - 'description' => 'The time when the status of the cloud computer was changed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1760583xxxx', - ], - 'Memory' => [ - 'description' => 'The memory of the cloud computer. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'DemoComputer', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'SubPayType' => [ - 'description' => 'The billing method of the cloud computer. Valid values:'."\n" - ."\n" - .'* prePaid: The monthly purchase is unlimited.'."\n" - .'* postPaid: pay-as-you-go'."\n" - .'* monthPackage: monthly duration.'."\n", - 'type' => 'string', - 'example' => 'monthPackage', - ], - 'EndUserId' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'TestUser', - ], - 'OsType' => [ - 'description' => 'The OS type. Valid values:'."\n" - ."\n" - .'* Windows'."\n" - .'* Linux'."\n", - 'type' => 'string', - 'example' => 'Linux', - ], - 'SessionIdleTime' => [ - 'description' => 'The idle duration of the session. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'OfficeSiteName' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'example' => 'TestOfficeSite', - ], - 'ConnectionStatus' => [ - 'description' => 'The connection status of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => 'Connected', - ], - 'Sessions' => [ - 'description' => 'The session details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'End user information.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'TestUser', - ], - 'EstablishmentTime' => [ - 'description' => 'The time when the session was created.'."\n", - 'type' => 'string', - 'example' => '2022-08-31T06:56:45Z', - ], - ], - ], - ], - 'DesktopId' => [ - 'description' => 'The cloud computer IDs.'."\n", - 'type' => 'string', - 'example' => 'ecd-g6t1ukbaea****', - ], - 'EndUserIds' => [ - 'description' => 'The list of assigned terminal user IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'TestUser', - ], - ], - 'ResourceGroups' => [ - 'description' => 'The name of the enterprise resource group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the enterprise resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the enterprise resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-f3s3dgt8dtb0vlqc8', - ], - 'ResourceGroupName' => [ - 'description' => 'The queried resource group name.'."\n", - 'type' => 'string', - 'example' => 'dms_test', - ], - ], - ], - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-8904****', - ], - 'UpTime' => [ - 'description' => 'The startup duration of the cloud computer. Unit: seconds'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '86400', - ], - 'ProtocolType' => [ - 'description' => 'Protocol type.'."\n" - ."\n" - .'* HDX'."\n" - .'* ASP'."\n", - 'type' => 'string', - 'example' => 'ASP', - ], - 'GpuSpec' => [ - 'description' => 'The size of the GPU memory.'."\n", - 'type' => 'string', - 'example' => '8GiB', - ], - 'LatestConnectionTime' => [ - 'description' => 'The duration of the last connection to the cloud computer. Unit: seconds'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalConnectionTime' => [ - 'description' => 'The total connection duration. Unit: seconds'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '240', - ], - 'RegionId' => [ - 'description' => 'The ID of the region where the instance resides.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'dg-iaqu3bi2xtie****', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'DemoCCGroup', - ], - 'DesktopStatus' => [ - 'title' => '桌面状态', - 'description' => '桌面状态', - 'type' => 'string', - 'example' => 'Running', - ], - 'OfficeSiteType' => [ - 'title' => '办公网络类型', - 'type' => 'string', - 'example' => 'Simple', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2022-05-26T11:38:47.000Z', + 'description' => '新增重置云桌面接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeFlowStatistic'], + ], + 'createdAt' => '2022-05-26T08:06:00.000Z', + 'description' => '桌面粒度流量统计接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeRefundPrice'], + ], + 'createdAt' => '2022-05-26T07:17:47.000Z', + 'description' => '内部使用 不展示', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CancelCopyImage'], + ['description' => 'OpenAPI offline', 'api' => 'CopyImage'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeImagePermission'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyImagePermission'], + ], + 'createdAt' => '2022-05-26T07:14:08.000Z', + 'description' => '复制与共享镜像功能发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeBundles'], + ], + 'createdAt' => '2022-05-23T06:55:52.000Z', + 'description' => '模版磁盘加密参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDesktopSavingPlan'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopTypes'], + ['description' => 'Request parameters changed', 'api' => 'DescribeHardwareTerminals'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeSavingPlanPrice'], + ], + 'createdAt' => '2022-05-23T06:03:31.000Z', + 'description' => '无影接入节省计划', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeUsersInGroup'], + ], + 'createdAt' => '2022-05-23T04:53:13.000Z', + 'description' => '获取桌面组授权用户接口返回用户的一些附加信息', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckServiceLinkedRoleForDeleting'], + ['description' => 'Request parameters changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'CreateDesktops'], + ['description' => 'OpenAPI offline', 'api' => 'CreateDiskEncryptionService'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Response parameters changed', 'api' => 'DescribeImages'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeKmsKeys'], + ['description' => 'Response parameters changed', 'api' => 'DescribeSnapshots'], + ], + 'createdAt' => '2022-05-23T04:53:01.000Z', + 'description' => '无影云桌面增加磁盘加密功能', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeUserConnectionRecords'], + ], + 'createdAt' => '2022-05-13T03:57:56.000Z', + 'description' => '获取用户连接记录接口支持一系列的过滤条件。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopGroupInfo'], + ['description' => 'Request parameters changed', 'api' => 'ExportDesktopListInfo'], + ], + 'createdAt' => '2022-05-13T03:23:37.000Z', + 'description' => '1、导出云桌面和桌面组列表支持中英文切换；2、桌面组导出列表增加新的资源配置项', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeImageModifiedRecords'], + ], + 'createdAt' => '2022-05-13T03:11:16.000Z', + 'description' => '新增无影云桌面镜像变更记录查询的OpenApi，无影云桌面镜像变更记录功能可以在云桌面详情镜像名称后点击变更记录按钮查看。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateNASFileSystem'], + ['description' => 'Response parameters changed', 'api' => 'DescribeNASFileSystems'], + ], + 'createdAt' => '2022-05-11T06:01:31.000Z', + 'description' => '增加nas加密参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopGroup'], + ], + 'createdAt' => '2022-04-29T03:16:27.000Z', + 'description' => '修改桌面组 新增classify字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-04-24T10:10:39.000Z', + 'description' => '去掉无用参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeRecordings'], + ['description' => 'OpenAPI offline', 'api' => 'DownloadRecordings'], + ], + 'createdAt' => '2022-04-24T08:17:11.000Z', + 'description' => '录屏审计-下载、查询', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2022-04-24T08:17:03.000Z', + 'description' => '桌面策略中新增录屏相关的策略', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeFrontVulPatchList'], + ['description' => 'Request parameters changed', 'api' => 'HandleSecurityEvents'], + ['description' => 'Request parameters changed', 'api' => 'ModifyOperateVul'], + ], + 'createdAt' => '2022-04-24T08:16:59.000Z', + 'description' => '云桌面安全相关接口Bug修复：HandleSecurityEvents, ModifyOperateVul, DescribeFrontVulPatchList将一些必选参数做强限制，之前不填会报Internal error，实际是不支持为空', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-04-22T02:14:27.000Z', + 'description' => '在DescribeDesktops接口返回中添加Platform字段，用于显示操作系统的平台详情。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeBundles'], + ], + 'createdAt' => '2022-04-21T14:09:30.000Z', + 'description' => '支持显示多 session 镜像，目前处于白名单阶段，不对外开放', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddUserToDesktopGroup'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeUsersInGroup'], + ['description' => 'Request parameters changed', 'api' => 'ModifyUserToDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'RemoveUserFromDesktopGroup'], + ], + 'createdAt' => '2022-04-13T08:15:24.000Z', + 'description' => '桌面组授权用户时，用户数量从100扩展到10000；查询桌面组授权用户接口增加入参QueryUserDetail，控制是否获取用户详情。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyUserToDesktopGroup'], + ], + 'createdAt' => '2022-03-23T11:46:06.000Z', + 'description' => 'ModifyUserToDesktopGroup接口限制OldEndUserIds和NewEndUserIds最大数量为100', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddUserToDesktopGroup'], + ['description' => 'Request parameters changed', 'api' => 'RemoveUserFromDesktopGroup'], + ], + 'createdAt' => '2022-03-23T11:33:15.000Z', + 'description' => 'AddUserToDesktopGroup和RemoveUserFromDesktopGroup限制EndUserIds和DesktopGroupIds的最大值为100', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'AddUserToDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeClientEvents'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'RemoveUserFromDesktopGroup'], + ], + 'createdAt' => '2022-03-23T09:10:18.000Z', + 'description' => '获取桌面组列表接口：DescribeDesktopGroups，增加入参EndUserIds、ExcludedEndUserIds增加桌面组用户授权：AddUserToDesktopGroup，增加入参DesktopGroupIds移除桌面组用户授权：RemoveUserFromDesktopGroup，增加入参DesktopGroupIds获取用户日志：DescribeClientEvents，增加出参DesktopGroupId、DesktopGroupName', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDesktopGroupDetail'], + ], + 'createdAt' => '2022-03-21T03:14:22.000Z', + 'description' => 'GetDesktopGroupDetail接口的出参desktops的类型由数组改成object。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-03-18T09:11:43.000Z', + 'description' => 'DescribeDesktops支持返回PerformanceLevel参数，用于显示essd的存储性能级别。', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ApproveFotaUpdate'], + ['description' => 'OpenAPI offline', 'api' => 'CreateUserTags'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteUserTags'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeFotaPendingDesktops'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeFotaTasks'], + ['description' => 'Response parameters changed', 'api' => 'DescribeImages'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateFotaTask'], + ], + 'createdAt' => '2022-03-15T14:45:11.000Z', + 'description' => '增加镜像升级API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ConfigADConnectorUser'], + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorDirectory'], + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDirectories'], + ['description' => 'Response parameters changed', 'api' => 'ListDirectoryUsers'], + ['description' => 'Response parameters changed', 'api' => 'ListOfficeSiteUsers'], + ['description' => 'Request parameters changed', 'api' => 'ModifyADConnectorDirectory'], + ['description' => 'Request parameters changed', 'api' => 'ModifyADConnectorOfficeSite'], + ], + 'createdAt' => '2022-03-14T08:03:47.000Z', + 'description' => '支持ASP AD工作区', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], + ], + 'createdAt' => '2022-03-03T09:12:51.000Z', + 'description' => '在DescribeBundles接口的输出中，添加SessionType字段，表明是单session还是多session镜像，如果没有返回改字段，则表明为默认的单session镜像', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2022-03-02T08:14:42.000Z', + 'description' => '工作区增加VPC类型字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListOfficeSiteOverview'], + ], + 'createdAt' => '2022-03-02T08:09:22.000Z', + 'description' => '工作区增加VPC类型字段', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DisableDesktopsInGroup'], + ], + 'createdAt' => '2022-03-02T07:13:32.000Z', + 'description' => '新增接口，允许将桌面置为 disable', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UploadImage'], + ], + 'createdAt' => '2022-02-24T10:11:53.000Z', + 'description' => 'UploadImage接口：支持用户上传自定义镜像CreateUserOssPath：私有接口，在资源账号中创建用户oss bucket并授权DescribeUserOssPath：私有接口，展示用户可用的bucket', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'Request parameters changed', 'api' => 'SetOfficeSiteSsoStatus'], + ], + 'createdAt' => '2022-02-16T03:39:35.000Z', + 'description' => '工作区增加oauth协议的sso地址', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-02-07T02:43:14.000Z', + 'description' => '查询桌面增加创建进度', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ExportClientEvents'], + ], + 'createdAt' => '2022-01-20T05:17:25.000Z', + 'description' => '支持客户端日志导出', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-01-20T05:15:19.000Z', + 'description' => '桌面查询增加工作区名称查询，并返回桌面对应的模板名称模板查询返回镜像名称', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'RenewNetworkPackages'], + ], + 'createdAt' => '2022-01-19T15:22:59.000Z', + 'description' => '添加错误码映射', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSimpleOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'Request parameters changed', 'api' => 'ModifyOfficeSiteAttribute'], + ], + 'createdAt' => '2022-01-13T08:29:43.000Z', + 'description' => '工作区增加可信设备校验开关', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-01-06T02:39:25.000Z', + 'description' => 'DescribeDesktops接口返回GPU Category和GPU driver version', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2021-12-24T04:48:20.000Z', + 'description' => '添加返回工作区桌面数量', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetConnectionTicket'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Sessions\\": [\\n {\\n \\"Platform\\": \\"Windows 10\\",\\n \\"StatusChangeTime\\": 0,\\n \\"Memory\\": 4096,\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"Cpu\\": 2,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"EstablishmentTime\\": \\"2022-08-31T06:56:45Z\\"\\n }\\n ],\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"EndUserIds\\": [\\n \\"TestUser\\"\\n ],\\n \\"ResourceGroups\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"dms_test\\"\\n }\\n ],\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"UpTime\\": 86400,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"GpuSpec\\": \\"8GiB\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"OfficeSiteType\\": \\"Simple\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeGlobalDesktopRecords', - 'description' => '* Domestic site users query site selection Shanghai, international site users choose Singapore.'."\n" - .'* By default, you can query all cloud computers that are deleted or not deleted.'."\n" - .'* Deleted cloud computers can be queried only if the deletion time is less than three months.'."\n" - .'* Sort criteria cannot be shared with other criteria.'."\n", + 'createdAt' => '2021-12-23T06:22:07.000Z', + 'description' => '修复GetConnectionTicket定义', ], - 'AddDevices' => [ - 'summary' => 'Adds trusted devices.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyCloudDriveService'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2021-12-23T05:16:18.000Z', + 'description' => '内部变更，未面向客户。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktopTypes'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePrice'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-12-22T01:25:34.000Z', + 'description' => '增加预付费桌面降配次数限制', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryAccountLabel'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', + 'createdAt' => '2021-12-17T02:45:10.000Z', + 'description' => '查询用户是否已经实名', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateBandwidthResourcePackages'], + ['description' => 'Request parameters changed', 'api' => 'DescribeNetworkPackages'], + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeResourcePackageQuota'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DeviceIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the devices. You can specify up to 200 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The serial number (SN) of the hardware client or the UUID of the software client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5F52817BE267A43C608D245070D2****', - ], - 'required' => true, - 'maxItems' => 200, - ], - ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: hardware client.'."\n" - .'* 2: software client.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '2', - ], - ], + 'createdAt' => '2021-12-10T09:25:08.000Z', + 'description' => '带宽资源包', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopChargeType'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07****', - ], - 'Code' => [ - 'description' => 'The execution result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned error message. This parameter is not returned if the value of Code is `success`.'."\n", - 'type' => 'string', - 'example' => 'The parameter is not specified.', - ], - ], - ], - ], + 'createdAt' => '2021-12-10T01:51:26.000Z', + 'description' => '转换桌面付费类型支持使用优惠券', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrderForHardware'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A87DBB05-653A-5E4B-B72B-5F4A1E07****\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The parameter is not specified.\\"\\n}","type":"json"}]', - 'title' => 'AddDevices', - 'description' => 'Each device can be registered in only one Alibaba Cloud account. If you register a device that has been registered in another Alibaba Cloud account, an error is reported.'."\n", + 'createdAt' => '2021-12-10T01:45:21.000Z', + 'description' => '硬件终端售卖页面，支持用户选择优惠券的功能。', ], - 'DeleteDevices' => [ - 'summary' => 'Deletes trusted devices.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrderForHardware'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2021-12-10T01:41:52.000Z', + 'description' => '在售卖硬件终端的页面，支持用户使用优惠券的功能', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeDesktopsInGroup'], + ['description' => 'Response parameters changed', 'api' => 'ListOfficeSiteOverview'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-12-09T02:22:26.000Z', + 'description' => 'ListOfficeSiteOverview：可以同时返回云桌面和桌面组下的云桌面的数量；DescribeDesktopsInGroup：增加ManagementFlag出参。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreatePolicyGroup'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribePolicyGroups'], + ['description' => 'Request parameters changed', 'api' => 'ModifyPolicyGroup'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', + 'createdAt' => '2021-12-01T09:28:07.000Z', + 'description' => '策略支持GPU优化', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateNetworkPackage'], + ['description' => 'Request parameters changed', 'api' => 'DescribeModificationPrice'], + ['description' => 'Request parameters changed', 'api' => 'DescribeRenewalPrice'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopSpec'], + ['description' => 'Request parameters changed', 'api' => 'ModifyNetworkPackageBandwidth'], + ['description' => 'Request parameters changed', 'api' => 'RenewDesktops'], + ['description' => 'Request parameters changed', 'api' => 'RenewNetworkPackages'], + ], + 'createdAt' => '2021-11-26T04:06:00.000Z', + 'description' => '云桌面及网络包新购、续费、变配支持使用优惠券', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeImages'], + ['description' => 'Request parameters changed', 'api' => 'RebuildDesktops'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DeviceIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the devices. You can specify up to 200 IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The serial number (SN) of the hardware client or the UUID of the software client.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '5F52817BE267A43C608D245070D2****', - ], - 'required' => true, - 'maxItems' => 100, - ], - ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: hardware client.'."\n" - .'* 2: software client.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '2', - ], - ], - [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to forcefully delete the device if the device is bound to a user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: do not forcefully delete the device.'."\n" - .'* 1: forcefully delete the device.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', - ], - ], + 'createdAt' => '2021-11-26T03:28:00.000Z', + 'description' => '重建桌面支持传入指定镜像', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeBundles'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2AF861B4-0ECC-130C-B100-21A01E02****', - ], - ], - ], - ], + 'createdAt' => '2021-11-18T07:44:32.000Z', + 'description' => 'DescribeBundles模板查询返回创建时间', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ModifyNetworkPackageBandwidth'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AF861B4-0ECC-130C-B100-21A01E02****\\"\\n}","type":"json"}]', - 'title' => 'DeleteDevices', - 'description' => 'You can call the operation to manage client devices.'."\n", - 'requestParamsDescription' => 'The clientType and DeviceIds parameters are required.'."\n", - 'responseParamsDescription' => 'No other special parameters are available.'."\n", - 'extraInfo' => 'None.'."\n", + 'createdAt' => '2021-11-18T05:40:38.000Z', + 'description' => '包年包月按固定带宽网络支持升降配', ], - 'AttachEndUser' => [ - 'summary' => 'Binds a hardware client to a user.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListOfficeSiteOverview'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2021-11-18T05:40:32.000Z', + 'description' => 'ListOfficeSiteOverview增加入参QueryRange。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktopTypes'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-11-18T05:38:14.000Z', + 'description' => '桌面规格查询接口增加桌面id查询条件，返回的桌面规格会包含变配的兼容性状态检查的结果', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeModificationPrice'], + ['description' => 'Request parameters changed', 'api' => 'ModifyDesktopSpec'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2021-11-18T05:37:25.000Z', + 'description' => '1、变配询价支持网络；2、变配支持添加高性能等级的ESSD；', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeRenewalPrice'], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number (SN) of the hardware client.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '111810122200F0C24CF7F1BF-*05AY****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user that you want to bind to the hardware client.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'moli', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the convenient office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', - ], - ], - [ - 'name' => 'AdDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address of the Active Directory (AD) office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xn--0zw****', - ], - ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The account type of the user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AD: enterprise AD account.'."\n" - .'* SIMPLE: convenience account'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AD' => '', - 'SIMPLE' => '', - ], - 'example' => 'SIMPLE', - ], - ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: hardware client.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - ], - 'example' => '2', - ], - ], + 'createdAt' => '2021-11-04T10:26:01.000Z', + 'description' => 'DescribeRenewalPrice支持批量续费询价', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateDesktopGroup'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktopGroups'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetDesktopGroupDetail'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyDesktopGroup'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], + 'createdAt' => '2021-11-04T10:05:13.000Z', + 'description' => '增加桌面组 resetType 和 status 参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateCloudDriveService'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteCloudDriveServices'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeCloudDriveService'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyCloudDriveService'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'AttachEndUser', + 'createdAt' => '2021-10-28T14:33:50.000Z', + 'description' => 'sm增加pds网盘集成openapi', ], - 'DetachEndUser' => [ - 'summary' => 'Unbinds a hardware client from a user.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateBundle'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'DescribeBundles'], + ['description' => 'Request parameters changed', 'api' => 'DescribePrice'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2021-10-28T13:09:02.000Z', + 'description' => '支持创建高性能等级的ESSD', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDirectories'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ModifyOfficeSiteAttribute'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2021-10-28T11:55:45.000Z', + 'description' => '增加登录二次验证开关标识', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'DescribeImages'], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + 'createdAt' => '2021-10-28T11:24:31.000Z', + 'description' => '镜像查询API新增语言出入参', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AttachCen'], + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Request parameters changed', 'api' => 'CreateSimpleOfficeSite'], + ['description' => 'OpenAPI offline', 'api' => 'SendVerifyCode'], + ['description' => 'Request parameters changed', 'api' => 'VerifyCen'], ], - 'parameters' => [ - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The serial number (SN) of the hardware client.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'F9E52EDCCB2B****', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user that you want to unbind from the hardware client.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'moli', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the convenient office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', + 'createdAt' => '2021-10-28T07:30:21.000Z', + 'description' => '跨账号挂载CEN增加验证码', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUserTags'], + ], + 'createdAt' => '2021-10-27T04:22:46.000Z', + 'description' => '检查该用户是否设置了某些标签', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ModifyDesktopChargeType'], + ], + 'createdAt' => '2021-09-28T06:41:49.000Z', + 'description' => '按量付费云桌面支持转换为包年包月', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2021-09-28T06:39:25.000Z', + 'description' => 'DescribeDesktops接口增加DesktopGroupId入参，可以获取桌面组下的桌面的信息。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeDesktopGroups'], + ], + 'createdAt' => '2021-09-10T07:07:38.000Z', + 'description' => 'DescribeDesktopGroups 增加入参 PolicyGroupId，允许根据 PolicyGroupId 查询桌面组', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListDirectoryUsers'], + ['description' => 'Request parameters changed', 'api' => 'ListOfficeSiteUsers'], + ], + 'createdAt' => '2021-09-08T07:19:18.000Z', + 'description' => '列举AD用户的时候，支持先选择OU', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ModifyBundle'], + ], + 'createdAt' => '2021-08-23T10:39:38.000Z', + 'description' => '动态后端地址规则修改', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ConfigADConnectorTrust'], + ['description' => 'OpenAPI offline', 'api' => 'ConfigADConnectorUser'], + ['description' => 'Request parameters changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Response parameters changed', 'api' => 'DescribeDirectories'], + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ['description' => 'OpenAPI offline', 'api' => 'ListUserAdOrganizationUnits'], + ], + 'createdAt' => '2021-08-23T07:52:57.000Z', + 'description' => '新版AD工作区创建OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddUserToSecurityCenterWhiteList'], + ['description' => 'Error codes changed', 'api' => 'AttachCen'], + ['description' => 'Error codes changed', 'api' => 'CheckUserInSecurityCenterWhiteList'], + ['description' => 'Error codes changed', 'api' => 'CreateADConnectorDirectory'], + ['description' => 'Error codes changed', 'api' => 'CreateADConnectorOfficeSite'], + ['description' => 'Error codes changed', 'api' => 'CreateDesktopsLite'], + ['description' => 'Error codes changed', 'api' => 'CreateNetworkPackage'], + ['description' => 'Error codes changed', 'api' => 'CreateRAMDirectory'], + ['description' => 'Error codes changed', 'api' => 'CreateServiceLinkedRole'], + ['description' => 'Error codes changed', 'api' => 'CreateSimpleOfficeSite'], + ], + 'createdAt' => '2021-08-19T08:17:26.000Z', + 'description' => '统一动态后端地址规则', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateBundle'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeBundles'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyBundle'], + ], + 'createdAt' => '2021-08-06T04:03:20.000Z', + 'description' => '模板支持多语言', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreatePolicyGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DescribePolicyGroups'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyPolicyGroup'], + ], + 'createdAt' => '2021-04-19T11:08:15.000Z', + 'description' => 'api名称：SM：CreatePolicyGroup、ModifyPolicyGroup、DescribePolicyGroups 接口中新增了preemptLogin 和oreemptLoginUser 两个字段 ', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnlockVirtualMFADevice'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveFilePermission'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopsPolicyGroup'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSnapshots'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadImage'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktopGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerBatches'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddFilePermission'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchModifyEntitlement'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroupSessions'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachCen'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopTimer'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPackages'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNASFileSystem'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSimpleOfficeSite'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteOfficeSites'], + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDiskSpec'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateNetworkPackage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorTrust'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDrivePermission'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNetworkPackages'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeKmsKeys'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVirtualMFADevices'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyGroups'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorDirectory'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserEntitlement'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LockVirtualMFADevice'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOfficeSiteSsoStatus'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBundles'], + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorUser'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopName'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroups'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCdsFileShareLink'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordings'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPolicyGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorDirectory'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'], + ['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEcdReportTasks'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateImageProtocol'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInvocation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFotaTask'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveGroups'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSnapshot'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBundles'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetIdpMetadata'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddDevices'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeZones'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFileShareLink'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNASDefaultMountTarget'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCustomizedListHeaders'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachEndUser'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAclEntries'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserToDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDirectories'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyCen'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ActivateOfficeSite'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SendVerifyCode'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageEnabled'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetOfficeSiteSsoStatus'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFilePermission'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MoveCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGuestApplications'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOfficeSites'], + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopListInfo'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClientEvents'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDrives'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBundle'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerRecords'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsyncTask'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDesktops'], + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopGroupInfo'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeCoordinatePrivilege'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevices'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCdsFiles'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFileShareLink'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeModificationPrice'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewNetworkPackages'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRAMDirectory'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopSessions'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveGroups'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDesktopGroupDetail'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopChargeType'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyGroups'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDiskEncryptionService'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorOfficeSite'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDesktopsInGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportClientEvents'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteDnsInfo'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkPackage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteImages'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDirectoryUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImages'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimerStatus'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorOfficeSite'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyImage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaTasks'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopHostName'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateNetworkPackage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteCrossDesktopAccess'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCustomizedListHeaders'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopMaintenance'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachCen'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFlowStatistic'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveService'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateEcdReportTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrive'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCens'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebuildDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSpMetadata'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateImage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersPassword'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFlowMetric'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageAttribute'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveGroups'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaPendingDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNASFileSystems'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopsInGroup'], + ['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopSpec'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteMfaEnabled'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDrive'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'], + ['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersInGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDirectorySsoStatus'], + ['threshold' => '1000', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImageModifiedRecords'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ClonePolicyGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCoordinationForMonitoring'], + ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupScaleTimer'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinatePrivilege'], + ['threshold' => '500', 'countWindow' => 30, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCoordinateTicket'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNASFileSystems'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageBandwidth'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopTypes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HibernateDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAclEntries'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserConnectionRecords'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddUserToDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteOverview'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCdsFileShareLinks'], + ['threshold' => '160', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WakeupDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisconnectDesktopSessions'], + ['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBandwidthResourcePackages'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachEndUser'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordFile'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktops'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImagePermission'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRefundPrice'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCopyImage'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveUserFromDesktopGroup'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveUsers'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyEntitlement'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImagePermission'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopMetadata'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBundle'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetNASDefaultMountTarget'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoSnapshotPolicy'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDrivePermissions'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinationForMonitoring'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteAttribute'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopInfo'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktopRecords'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimer'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUserAdOrganizationUnits'], + ['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteCdsFile'], + ['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAndBindNasFileSystem'], + ], + ], + 'ram' => [ + 'productCode' => 'ECD', + 'productName' => 'Elastic Desktop Service', + 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateBundle', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateBundle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AdDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address of the Active Directory (AD) office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xn--0zw****', + ], + [ + 'apiName' => 'ModifyDesktopsPolicyGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopsPolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: hardware client.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - ], - 'example' => '2', + ], + [ + 'apiName' => 'DescribeQosRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeQosRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', + ], + [ + 'apiName' => 'DeleteDesktops', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'ModifyDesktopGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'DetachEndUser', - ], - 'DescribeDevices' => [ - 'summary' => 'Queries the list of trusted devices.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteCloudDriveGroups', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteCloudDriveGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'DeviceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the device. The serial number (SN) of the hardware client or the UUID of the software client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5F52817BE267A43C608D245070D2****'."\n", + [ + 'apiName' => 'CancelCopyImage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CancelCopyImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the bound user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'moli', + ], + [ + 'apiName' => 'ApplyCoordinatePrivilege', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ApplyCoordinatePrivilege', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the convenient office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', + ], + [ + 'apiName' => 'DeleteConfigGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DeleteConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AdDomain', - 'in' => 'query', - 'schema' => [ - 'description' => 'The address of the Active Directory (AD) office network.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xn--0zw****', + ], + [ + 'apiName' => 'ModifyUserToDesktopGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyUserToDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The account type of the user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AD: enterprise AD account.'."\n" - .'* SIMPLE: convenience account'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'AD' => '', - 'SIMPLE' => '', - ], - 'example' => 'SIMPLE', + ], + [ + 'apiName' => 'ModifyCloudDriveUsers', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCloudDriveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1: hardware client.'."\n" - .'* 2: software client.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 1 => '', - '', - ], - 'example' => '2', + ], + [ + 'apiName' => 'ModifyDesktopChargeType', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopChargeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ResetDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'QueryHistoryAvgMetricList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:QueryHistoryAvgMetricList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Region', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'CreateBandwidthResourcePackages', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateBandwidthResourcePackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****', - ], - 'Devices' => [ - 'description' => 'The information about devices that you queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the device that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'DeviceId' => [ - 'description' => 'The ID of the device. The serial number (SN) of the hardware client or the UUID of the software client.'."\n", - 'type' => 'string', - 'example' => '5F52817BE267A43C608D245070D2****'."\n", - ], - 'EndUserList' => [ - 'description' => 'The users who are bound to the device.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user who is bound to the device.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => 'moli', - ], - 'UserType' => [ - 'description' => 'The account type of the user.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AD: enterprise AD account.'."\n" - .'* SIMPLE: convenience account'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AD' => '', - 'SIMPLE' => '', - ], - 'example' => 'SIMPLE', - ], - 'DirectoryId' => [ - 'description' => 'The ID of the convenient office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'."\n", - ], - 'AdDomain' => [ - 'description' => 'The address of the AD office network.'."\n", - 'type' => 'string', - 'example' => 'xn--0zw****'."\n", - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeEcdReportTasks', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeEcdReportTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEFE642-A383-4A18-8939-FB7DE452****\\",\\n \\"Devices\\": [\\n {\\n \\"DeviceId\\": \\"5F52817BE267A43C608D245070D2****\\\\n\\",\\n \\"EndUserList\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"UserType\\": \\"SIMPLE\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\n\\",\\n \\"AdDomain\\": \\"xn--0zw****\\\\n\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDevices', - 'responseParamsDescription' => 'If no user is bound, \\[] is returned as the value of the endUserList parameter.'."\n", - ], - 'DescribeDesktopSessions' => [ - 'summary' => 'Queries the detailed session information of a cloud computer.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CopyCdsFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CopyCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryHistoryActiveUserCount', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:QueryHistoryActiveUserCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetDesktopGroupTimerStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetDesktopGroupTimerStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'DescribeImages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CancelAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:CancelAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-363353****', + ], + [ + 'apiName' => 'DescribePolicyGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribePolicyGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testUser', + ], + [ + 'apiName' => 'StopDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:StopDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SessionStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - .'* Disconnected'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', + ], + [ + 'apiName' => 'ModifyAclEntries', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyAclEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-28T02:31:43Z', + ], + [ + 'apiName' => 'ModifyBundle', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyBundle', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2023-02-13T02:51:43Z', + ], + [ + 'apiName' => 'GetAsyncTask', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:GetAsyncTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'SetDesktopMaintenance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetDesktopMaintenance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyOfficeSiteAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DeleteNASFileSystems', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteNASFileSystems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DesktopName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DemoComputer', + ], + [ + 'apiName' => 'DescribeDesktopGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SubPayType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The billing method of cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* duration: hourly plan (available for users in the whitelist)'."\n" - .'* postPaid: pay-as-you-go'."\n" - .'* monthPackage: monthly subscription (the 120-hour/250-hour computing plan)'."\n" - .'* prePaid: monthly subscription (the Unlimited computing plan)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'duration' => '', - 'postPaid' => '', - 'monthPackage' => '', - 'prePaid' => '', - ], - 'example' => 'monthPackage', + ], + [ + 'apiName' => 'UnlockVirtualMFADevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:UnlockVirtualMFADevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CheckOsSession', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on the switch to check session status of cloud computers.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'RemoveFilePermission', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:RemoveFilePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserIdFilter', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID. This parameter functions the same as the `EndUserId` parameter. You only need to include one of them in your request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', + ], + [ + 'apiName' => 'DescribeFotaPendingDesktops', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeFotaPendingDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + ], + [ + 'apiName' => 'ListTransferFileDownloadUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListTransferFileDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FillHardwareInfo', - 'in' => 'query', - 'schema' => [ - 'title' => '是否增加终端信息返回。', - 'type' => 'boolean', + ], + [ + 'apiName' => 'DescribeCloudDriveUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDriveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'title' => '返回信息的语言类型。', - 'type' => 'string', - 'example' => 'zh-CN', + ], + [ + 'apiName' => 'DeleteVirtualMFADevice', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteVirtualMFADevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '3EC4A6DB-EC8D-55B0-9038-543DE671****', - ], - 'Sessions' => [ - 'description' => 'Details of sessions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of the session.'."\n", - 'type' => 'object', - 'properties' => [ - 'SessionStatus' => [ - 'description' => 'The state of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - .'* Disconnected'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', - ], - 'EndUserId' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'example' => 'testUser', - ], - 'OfficeSiteId' => [ - 'description' => 'The ID of the office network.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-8904****', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client.'."\n", - 'type' => 'string', - 'example' => '172.21.XX.XX', - ], - 'ClientOS' => [ - 'description' => 'The client OS.'."\n", - 'type' => 'string', - 'example' => 'windows_\\"Windows10Enterprise\\"10.0(Build22000)', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'ecd-g6t1ukbaea****', - ], - 'DesktopName' => [ - 'description' => 'The name of the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'testDesktop', - ], - 'OfficeSiteName' => [ - 'description' => 'The name of the office network.'."\n", - 'type' => 'string', - 'example' => 'DemoOfficeSite', - ], - 'ClientVersion' => [ - 'description' => 'The client version.'."\n", - 'type' => 'string', - 'example' => '2.0.0-R-20221030.08****', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX'."\n" - .'* ASP'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'LatestConnectionTime' => [ - 'description' => 'The duration of the last connection to the cloud computer. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalConnectionTime' => [ - 'description' => 'The total connection duration. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '240', - ], - 'SessionStartTime' => [ - 'description' => 'The start time of the session.'."\n", - 'type' => 'string', - 'example' => '2023-01-28T02:31:43Z'."\n", - ], - 'SessionEndTime' => [ - 'description' => 'The end time of the session.'."\n", - 'type' => 'string', - 'example' => '2023-01-28T02:31:43Z', - ], - 'SessionIdleTime' => [ - 'description' => 'The idle duration of the session. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'OsType' => [ - 'description' => 'The OS.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - .'* Windows'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], - 'example' => 'Windows', - ], - 'EndUserApplyCoordinateTime' => [ - 'description' => 'The duration of the remote assistance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'SubPayType' => [ - 'description' => 'The billing method of cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* duration: hourly plan (available for users in the whitelist)'."\n" - .'* postPaid: pay-as-you-go'."\n" - .'* monthPackage: monthly subscription (120-hour computing plan and 250-hour computing plan)'."\n" - .'* prePaid: monthly subscription (Unlimited computing plan)'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'duration' => '', - 'postPaid' => '', - 'monthPackage' => '', - 'prePaid' => '', - ], - 'example' => 'monthPackage', - ], - 'OsSessionStatus' => [ - 'description' => 'Indicates whether the switch to check session status of cloud computers is turned on.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'TerminalInfo' => [ - 'title' => '终端设备信息描述。', - 'type' => 'object', - 'properties' => [ - 'ProductName' => [ - 'title' => '终端设备类型。', - 'type' => 'string', - 'example' => 'Mac', - ], - 'SerialNumber' => [ - 'title' => '终端设备序列号。', - 'type' => 'string', - 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****', - ], - 'Model' => [ - 'title' => '终端设备信息。', - 'type' => 'string', - 'example' => 'Mac', - ], - 'Uuid' => [ - 'title' => '登录设备的UUID。', - 'type' => 'string', - 'example' => 'EBFDC7773BEBAD418A9F89429652****', - ], - ], - ], - 'DirectoryType' => [ - 'title' => '办公网络类型', - 'type' => 'string', - 'example' => 'SIMPLE', - ], - 'ResourceGroups' => [ - 'title' => '资源组信息', - 'type' => 'array', - 'items' => [ - 'title' => '资源组', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源组ID', - 'type' => 'string', - 'example' => 'rg-8whrmo2gtsb8bxxxx', - ], - 'Name' => [ - 'title' => '资源组名称', - 'type' => 'string', - 'example' => 'RgTest', - ], - ], - ], - ], - 'AccountType' => [ - 'title' => '账号类型', - 'type' => 'string', - 'example' => 'SIMPLE', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'SetOfficeSiteSsoStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetOfficeSiteSsoStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeDesktopTypes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"3EC4A6DB-EC8D-55B0-9038-543DE671****\\",\\n \\"Sessions\\": [\\n {\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"ClientOS\\": \\"windows_\\\\\\\\\\\\\\"Windows10Enterprise\\\\\\\\\\\\\\"10.0(Build22000)\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ClientVersion\\": \\"2.0.0-R-20221030.08****\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"SessionStartTime\\": \\"2023-01-28T02:31:43Z\\\\n\\",\\n \\"SessionEndTime\\": \\"2023-01-28T02:31:43Z\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 120,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"OsSessionStatus\\": \\"true\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"Mac\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"ResourceGroups\\": [\\n {\\n \\"Id\\": \\"rg-8whrmo2gtsb8bxxxx\\",\\n \\"Name\\": \\"RgTest\\"\\n }\\n ],\\n \\"AccountType\\": \\"SIMPLE\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeDesktopSessions', - 'description' => 'You can only query data within the last 30 days.'."\n", - ], - 'DescribeDesktopGroupSessions' => [ - 'summary' => 'Queries cloud computer shares.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateEcdReportTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CreateEcdReportTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ExportDesktopListInfo', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ExportDesktopListInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'StartDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:StartDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'ModifyNASDefaultMountTarget', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyNASDefaultMountTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeClientEvents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeClientEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SessionStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Disconnected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', + ], + [ + 'apiName' => 'ConfigADConnectorUser', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ConfigADConnectorUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OwnType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: single-session'."\n" - .'* 1: multi-session', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '1', + ], + [ + 'apiName' => 'DescribeCustomizedListHeaders', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCustomizedListHeaders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID of the terminal that connects to the session.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xianqiu', + ], + [ + 'apiName' => 'DescribeZones', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeZones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"2022-08-31T06:56:45Z"', + ], + [ + 'apiName' => 'ApplyCoordinationForMonitoring', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ApplyCoordinationForMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"2022-08-31T06:56:45Z"', + ], + [ + 'apiName' => 'ModifyDesktopTimer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopTimer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DeleteBundles', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteBundles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"asdfdfsdfsdfds"', + ], + [ + 'apiName' => 'CloneCenterPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CloneCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FillTerminalInfo', - 'in' => 'query', - 'schema' => [ - 'title' => '是否补充终端信息。', - 'description' => 'Whether to supplement terminal information.'."\n", - 'type' => 'boolean', - 'required' => false, + ], + [ + 'apiName' => 'AddDevices', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:AddDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Language', - 'in' => 'query', - 'schema' => [ - 'title' => '返回信息语言类型。', - 'description' => 'The language of the response.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', + ], + [ + 'apiName' => 'DescribeDesktopInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DesktopGroupIds', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'title' => '共享桌面组ID列表。', - 'description' => 'The IDs of shared desktop groups.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '共享桌面组ID。', - 'description' => 'The ID of the shared desktop group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dg-4oyi32wmrctgx****', - ], - 'required' => false, + ], + [ + 'apiName' => 'QueryHistoryMetricDistribution', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:QueryHistoryMetricDistribution', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CopyImage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CopyImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DesktopGroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '共享桌面名称。', - 'description' => 'The name of the shared desktop.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-4oyi32wmrctgx****', + ], + [ + 'apiName' => 'ResetNASDefaultMountTarget', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetNASDefaultMountTarget', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Returns an object.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D0920845-7359-59FC-9899-B****', - ], - 'TotalCount' => [ - 'description' => 'The total number of sessions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'Sessions' => [ - 'description' => 'The sessions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The session details.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The user ID of the terminal that connects to the session.'."\n", - 'type' => 'string', - 'example' => 'xianqiu', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the shared cloud computer.'."\n", - 'type' => 'string', - 'example' => 'dg-iaqu3bi2xtie****', - ], - 'DesktopGroupName' => [ - 'description' => 'The name of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-8904****', - ], - 'OfficeSiteName' => [ - 'description' => 'The office network name.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'OwnType' => [ - 'description' => 'The type of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0: single-session'."\n" - .'* 1: multi-session', - 'type' => 'integer', - 'format' => 'int32', - 'enumValueTitles' => [ - '', - '', - ], - 'example' => '0', - ], - 'SessionStatus' => [ - 'description' => 'The state of the session.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Disconnected'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => '', - 'Disconnected' => '', - ], - 'example' => 'Connected', - ], - 'DesktopId' => [ - 'description' => 'If the session status is Connected, it indicates the ID of the cloud computer that is currently connected. If the session status is Disconnected, it indicates the ID of the cloud computer that was last connected.'."\n", - 'type' => 'string', - 'example' => 'ecd-g6t1ukbaea****', - ], - 'ClientOS' => [ - 'description' => 'The operating system of the client.'."\n", - 'type' => 'string', - 'example' => 'windows_\\"Windows10Enterprise\\"10.0(Build22000)', - ], - 'ClientVersion' => [ - 'description' => 'The version of the client.'."\n", - 'type' => 'string', - 'example' => '2.0.0-R-20221030.08****', - ], - 'ClientIp' => [ - 'description' => 'The IP address of the client.'."\n", - 'type' => 'string', - 'example' => '172.21.XX.XX', - ], - 'LatestConnectionTime' => [ - 'description' => 'The duration of the most recent session. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'TotalConnectionDuration' => [ - 'description' => 'The total duration of the sessions. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'SessionIdleTime' => [ - 'description' => 'The idle duration of the cloud computer. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120', - ], - 'ProtocolType' => [ - 'description' => 'The protocol type supported by the rule.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* High-definition Experience (HDX).'."\n" - .'* ASP.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], - 'example' => 'ASP', - ], - 'LastSessionStartTime' => [ - 'description' => 'The start time of the most recent connection.'."\n", - 'type' => 'string', - 'example' => '2022-08-31 06:56:45', - ], - 'LastSessionEndTime' => [ - 'description' => 'The end time of the most recent connection.'."\n", - 'type' => 'string', - 'example' => '2022-08-31 06:56:45', - ], - 'OsType' => [ - 'description' => 'The operating system type of the cloud computer.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* linux.'."\n" - .'* Windows.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'linux' => '', - 'windows' => '', - ], - 'example' => 'Windows', - ], - 'EndUserApplyCoordinateTime' => [ - 'description' => 'The point in time when the end user applies for administrator assistance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1678794261000', - ], - 'TerminalInfo' => [ - 'title' => '终端信息。', - 'description' => 'Terminal Info'."\n", - 'type' => 'object', - 'properties' => [ - 'ProductName' => [ - 'title' => '终端类型。', - 'description' => 'The terminal type.'."\n", - 'type' => 'string', - 'example' => 'Mac', - ], - 'SerialNumber' => [ - 'title' => '终端序列号', - 'description' => 'Terminal Serial Number'."\n", - 'type' => 'string', - 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****', - ], - 'Model' => [ - 'title' => '终端设备类型。', - 'description' => 'The type of the terminal.'."\n", - 'type' => 'string', - 'example' => 'wuying_mac_x86_64', - ], - 'Uuid' => [ - 'title' => '终端设备UUID。', - 'description' => 'The terminal UUID.'."\n", - 'type' => 'string', - 'example' => 'EBFDC7773BEBAD418A9F89429652****', - ], - ], - ], - 'DirectoryType' => [ - 'title' => '办公网络类型', - 'description' => '办公网络类型', - 'type' => 'string', - 'example' => 'SIMPLE', - ], - 'AccountType' => [ - 'title' => '账号类型', - 'description' => '账号类型', - 'type' => 'string', - 'example' => 'SIMPLE', - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2', - ], - ], + [ + 'apiName' => 'DescribeModificationPrice', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeModificationPrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0920845-7359-59FC-9899-B****\\",\\n \\"TotalCount\\": 15,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\",\\n \\"OwnType\\": 0,\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"ClientOS\\": \\"windows\\",\\n \\"ClientVersion\\": \\"7.8.0\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionDuration\\": 120,\\n \\"SessionIdleTime\\": 120,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LastSessionStartTime\\": \\"2022-08-31 06:56:45\\",\\n \\"LastSessionEndTime\\": \\"2022-08-31 07:56:45\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 1678794261000,\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"wuying_mac_x86_64\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"AccountType\\": \\"SIMPLE\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2\\"\\n}","type":"json"}]', - 'title' => 'DescribeDesktopGroupSessions', - ], - 'DescribeSessionStatistic' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ApproveFotaUpdate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ApproveFotaUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeRecordFile', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeRecordFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai', + [ + 'apiName' => 'DescribePrice', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribePrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SearchRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies to search for session information by region ID. This parameter is used to filter desktop information of a specific region.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ModifyOfficeSiteCrossDesktopAccess', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteCrossDesktopAccess', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai+dir-259382****', + ], + [ + 'apiName' => 'CreateDiskEncryptionService', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CreateDiskEncryptionService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1679449506572', + ], + [ + 'apiName' => 'DescribeAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1677808889806', + ], + [ + 'apiName' => 'CreateADConnectorOfficeSite', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateADConnectorOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The query interval. Unit: seconds. Valid values:'."\n" - ."\n" - .'* 60'."\n" - .'* 120'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', + ], + [ + 'apiName' => 'DescribeInvocations', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeInvocations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of sessions returned.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C5528624-C6ED-5CA4-A4A2-7C30DBF2****', - ], - 'Statistic' => [ - 'description' => 'The statistics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1690164443508', - ], - 'Count' => [ - 'description' => 'The total number of sessions in the time range.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'GetCoordinateTicket', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:GetCoordinateTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"RequestId\\": \\"C5528624-C6ED-5CA4-A4A2-7C30DBF2****\\",\\n \\"Statistic\\": [\\n {\\n \\"TimePoint\\": 1690164443508,\\n \\"Count\\": 4\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeSessionStatistic', - 'summary' => 'Queries the session statistics of a region.', - 'description' => '* This is a central operation and can be called only by using services in the China (Shanghai) region.'."\n" - .'* You can query session statistics for the past hour.'."\n", - ], - 'DisconnectDesktopSessions' => [ - 'summary' => 'Disconnects cloud computer sessions.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'RebuildDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:RebuildDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateAndBindNasFileSystem', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateAndBindNasFileSystem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeResourceByCenterPolicyId', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeResourceByCenterPolicyId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ + [ + 'apiName' => 'ModifyNetworkPackageBandwidth', + 'description' => '', 'operationType' => 'update', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'ramAction' => [ + 'action' => 'ecd:ModifyNetworkPackageBandwidth', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Sessions', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The session details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'wy01', - ], - 'DesktopId' => [ - 'description' => 'The cloud desktop ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-90g15fkhsxxxn0unj', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 20, + ], + [ + 'apiName' => 'CreateRAMDirectory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateRAMDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PreCheck', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform precheck. If you perform precheck, the system does not disconnect from desktop sessions. Only the sessions that do not meet specific conditions are returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', + ], + [ + 'apiName' => 'ListOfficeSiteOverview', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListOfficeSiteOverview', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2507CFA8-FEAB-5208-98F5-5E028C50XXXX', - ], - 'InvalidSessions' => [ - 'description' => 'The list of invalid sessions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndUserId' => [ - 'description' => 'The end user ID.'."\n", - 'type' => 'string', - 'example' => 'wy01', - ], - 'DesktopId' => [ - 'description' => 'The cloud desktop ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-2jv6wugbkp65pxxxx', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeTemplates', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2507CFA8-FEAB-5208-98F5-5E028C50XXXX\\",\\n \\"InvalidSessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopId\\": \\"ecd-2jv6wugbkp65p****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DisconnectDesktopSessions', - ], - 'ApplyCoordinationForMonitoring' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeSessionStatistic', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeSessionStatistic', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DissociateNetworkPackage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DissociateNetworkPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListFilePermission', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ListFilePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](https://next.api.aliyun.com/document/ecd/2020-09-30/DescribeRegions) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'AddUserToDesktopGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:AddUserToDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Uuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The universally unique identifier (UUID) of the device.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '62f2f1f252f04e0e9d8bc****', + ], + [ + 'apiName' => 'DescribeDesktopGroupSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopGroupSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'InitiatorType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the initiator.'."\n" - ."\n" - .'Set the value to ADMIN_INITIATE.'."\n" - ."\n" - .'* The value ADMIN_INITIATE specifies that the administrator initiates the coordination request.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ADMIN_INITIATE' => '', - ], - 'example' => 'ADMIN_INITIATE', + ], + [ + 'apiName' => 'DeleteTemplates', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CoordinatePolicyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The coordination policy.'."\n" - ."\n" - .'Set the value to FULL_CONTROL.'."\n" - ."\n" - .'* The value FULL_CONTROL specifies that the cloud desktop is shared and remote access to the cloud desktop is allowed.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'FULL_CONTROL' => '', - ], - 'example' => 'FULL_CONTROL', + ], + [ + 'apiName' => 'DetachCen', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:DetachCen', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceCandidates', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of cloud desktops that run the collaboration task at the same time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ResourceType' => [ - 'description' => 'The resource type.'."\n" - ."\n" - .'Set the value to CLOUD_DESKTOP.'."\n" - ."\n" - .'* The value CLOUD_DESKTOP specifies that the resource is a cloud desktop.'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'CLOUD_DESKTOP' => '', - ], - 'example' => 'CLOUD_DESKTOP', - ], - 'ResourceRegionId' => [ - 'description' => 'The region where the resource resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - 'ResourceProperties' => [ - 'description' => 'The properties of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestProperty', - ], - 'OwnerEndUserId' => [ - 'description' => 'The ID of the current end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', - ], - 'ResourceId' => [ - 'description' => 'The ID of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-08zhejm3h7ilr****', - ], - 'ResourceName' => [ - 'description' => 'The name of the cloud desktop.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestDesktop', - ], - 'OwnerAliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the current cloud desktop belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '130247021517****', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DescribeOfficeSites', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeOfficeSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user who initiates the stream collaboration. If the initiator is the administrator, do not specify this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', + ], + [ + 'apiName' => 'RunCommand', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:RunCommand', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The information that is returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'CoordinateFlowModels' => [ - 'description' => 'The list of stream collaboration models.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CoordinateStatus' => [ - 'description' => 'The current status of the collaboration task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* COORDINATING: The collaboration task is being executed.'."\n" - ."\n" - .'* TERMINATING: The collaboration task is being terminated.'."\n" - ."\n" - .'* TERMINATED: The collaboration task is terminated.'."\n" - ."\n" - .'* PENDING: The collaboration task is pending to be executed.', - 'type' => 'string', - 'enumValueTitles' => [ - 'COORDINATING ' => '', - 'TERMINATING ' => '', - 'TERMINATED ' => '', - 'PENDING ' => '', - ], - 'example' => 'PENDING', - ], - 'InitiatorType' => [ - 'description' => 'The type of the initiator.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ADMIN_INITIATE_FORCE: The administrator forcibly initiates the collaboration request.'."\n" - ."\n" - .'* ADMIN_INITIATE: The administrator initiates the collaboration request.'."\n" - ."\n" - .'* COORDINATOR_INITIATE_FORCE: The coordinator forcibly initiates the collaboration request.', - 'type' => 'string', - 'enumValueTitles' => [ - 'ADMIN_INITIATE_FORCE' => '', - 'ADMIN_INITIATE' => '', - 'COORDINATOR_INITIATE_FORCE' => '', - ], - 'example' => 'COORDINATOR_INITIATE_FORCE', - ], - 'OwnerUserId' => [ - 'description' => 'The ID of the Alibaba Cloud account of the end user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'CoordinateTicket' => [ - 'description' => 'The ticket that is used to establish the Adaptive Streaming Protocol (ASP)-based connection.'."\n", - 'type' => 'string', - 'example' => '1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****', - ], - 'CoId' => [ - 'description' => 'The ID of the stream collaboration.'."\n", - 'type' => 'string', - 'example' => 'co-0sot77uale3****', - ], - 'ResourceId' => [ - 'description' => 'The ID of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => 'ecd-96vi03f9emqnl****', - ], - 'ResourceName' => [ - 'description' => 'The name of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => 'TestDesktop', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeConfigGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CoordinateFlowModels\\": [\\n {\\n \\"CoordinateStatus\\": \\"PENDING\\",\\n \\"InitiatorType\\": \\"COORDINATOR_INITIATE_FORCE\\",\\n \\"OwnerUserId\\": \\"alice\\",\\n \\"CoordinateTicket\\": \\"1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****\\",\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"ResourceId\\": \\"ecd-96vi03f9emqnl****\\",\\n \\"ResourceName\\": \\"DemoComputer\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ApplyCoordinationForMonitoring', - 'summary' => '(Administrator) initiates a remote assistance request to the end user. This operation is mainly used in administrator assistance scenarios and education scenarios.', - ], - 'GetCoordinateTicket' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteImages', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'StopInvocation', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:StopInvocation', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ModifyPolicyGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyPolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~436773~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyDesktopHostName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopHostName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CoId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the stream collaboration. You can obtain the value of this parameter based on the value of `Coid` that is returned by the `ApplyCoordinationForMonitoring` operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'co-0sot77uale3****', + ], + [ + 'apiName' => 'ModifyTimerGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:ModifyTimerGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer connection task. The first time you initiate the request, you do not need to specify the ID of the cloud computer connection task. If no ticket is returned after you initiate the first request, you must specify the value of taskId that is returned for the first request in the subsequent request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****', + ], + [ + 'apiName' => 'CreateCenterPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:CreateCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the convenience user account. If you initiate the request as an administrator, you do not need to specify this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Alice', + ], + [ + 'apiName' => 'ModifyCloudDrivePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCloudDrivePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the user.'."\n" - ."\n" - .'Set the value to TENANT_ADMIN.'."\n" - ."\n" - .'* The value of'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' TENANT_ADMIN'."\n" - ."\n" - .' '."\n" - ."\n" - .' specifies an administrator.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'TENANT_ADMIN' => '', - ], - 'example' => 'TENANT_ADMIN', + ], + [ + 'apiName' => 'RenewNetworkPackages', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:RenewNetworkPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'CoId' => [ - 'description' => 'The ID of the stream collaboration.'."\n", - 'type' => 'string', - 'example' => 'co-0sot77uale3****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'TaskStatus' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'Possible values:'."\n" - ."\n" - .'* Finished'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Failed'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .'* Running'."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n" - ."\n" - .' '."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => 'Finished', - 'Failed' => 'Failed', - 'Running' => 'Running', - ], - 'example' => 'Finished', - ], - 'TaskId' => [ - 'description' => 'The ID of the cloud computer connection task.'."\n", - 'type' => 'string', - 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****', - ], - 'Ticket' => [ - 'description' => 'The credentials of the stream collaboration.'."\n", - 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - ], - 'description' => '', + [ + 'apiName' => 'DescribeFotaTasks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeFotaTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Finished\\",\\n \\"TaskId\\": \\"39cc15e5-6998-4b9f-9b2c-7a4cc3e2****\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\"\\n}","type":"json"}]', - 'title' => 'GetCoordinateTicket', - 'summary' => 'Get the stream collaboration credentials for remote assistance or shared collaboration.', - ], - 'CancelCoordinationForMonitoring' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeCenterPolicyList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCenterPolicyList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateNetworkPackage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateNetworkPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~436773~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DetachEndUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:DetachEndUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CoIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of stream collaboration tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the stream collaboration task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'co-****', - ], - 'required' => true, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DescribeCloudDiskGroupDrives', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDiskGroupDrives', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the user.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* TENANT_ADMIN: administrator.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'TENANT_ADMIN' => '', - ], - 'example' => 'TENANT_ADMIN', + ], + [ + 'apiName' => 'RevokeCoordinatePrivilege', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:RevokeCoordinatePrivilege', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user that initiates stream collaboration. If the initiator is the administrator, skip this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alice', + ], + [ + 'apiName' => 'DescribeDesktopsInGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopsInGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'CreateCdsFile', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'CancelCoordinationForMonitoring', - 'summary' => 'Cancels a remote assistance request to the end user.', - ], - 'ApplyCoordinatePrivilege' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ModifyUserEntitlement', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyUserEntitlement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreateCloudDriveService', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCloudDriveService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteDirectories', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'VerifyCen', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:VerifyCen', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Uuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8b241d415da244a6936d6d6fa4f20f4d', + ], + [ + 'apiName' => 'ActivateOfficeSite', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ActivateOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zhangsan', + ], + [ + 'apiName' => 'ResetSnapshot', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ResetSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CoId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application for the coordinate permissions.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'co-fqsm6e8ee75w61fp9', + ], + [ + 'apiName' => 'DescribeRefundPrice', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeRefundPrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of user who requires the coordinate permissions.'."\n" - ."\n" - .'Valid value: TENANT_ADMIN.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TENANT_ADMIN', + ], + [ + 'apiName' => 'GetConnectionTicket', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetConnectionTicket', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C43EEAC3-84F8-5C1E-A067-4751C3D1422E', - ], - ], - 'description' => '', + [ + 'apiName' => 'ListUserAdOrganizationUnits', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListUserAdOrganizationUnits', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C43EEAC3-84F8-5C1E-A067-4751C3D1422E\\"\\n}","type":"json"}]', - 'title' => 'ApplyCoordinatePrivilege', - 'summary' => 'Applies for the coordinate permissions.', - ], - 'RevokeCoordinatePrivilege' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'MigrateDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:MigrateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'AttachEndUser', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:AttachEndUser', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SetDesktopGroupTimer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetDesktopGroupTimer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~196646~~) operation to query the most recent region list.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'UnbindConfigGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:UnbindConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Uuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, click **About** on the client logon page to view the identifier of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'C78CA9E99315687575DD2844C1F3****', + ], + [ + 'apiName' => 'RebootDesktops', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:RebootDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the end user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zhangsan', + ], + [ + 'apiName' => 'ModifyOfficeSiteMfaEnabled', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteMfaEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CoId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the stream coordination task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'co-fqsm6e8ee75w61fp9', + ], + [ + 'apiName' => 'LockVirtualMFADevice', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:LockVirtualMFADevice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'UserType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of user who requires the coordinate permissions.'."\n" - ."\n" - .'Set the value to TENANT_ADMIN. Only tenant administrators can be granted with the coordinate permissions.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TENANT_ADMIN', + ], + [ + 'apiName' => 'ListCdsFiles', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ListCdsFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'DeleteDevices', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'RevokeCoordinatePrivilege', - 'summary' => 'Revokes the coordinate permissions.', - ], - 'CreateBandwidthResourcePackages' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdateFotaTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:UpdateFotaTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CompleteCdsFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:CompleteCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDesktopMetadata', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'systemTags' => [ - 'operationType' => 'create', + [ + 'apiName' => 'DescribeGlobalTimerBatches', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeGlobalTimerBatches', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyImagePermission', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyImagePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PackageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the data transfer plan. Valid values: 10 to 1000. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '12000', - 'minimum' => '10', - 'example' => '100', + ], + [ + 'apiName' => 'DescribeImageModifiedRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeImageModifiedRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Amount', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the data transfer plans that you want to create at the same time. Valid values: 1 to 20. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '1', + ], + [ + 'apiName' => 'ModifyDesktopSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Period', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subscription duration. The valid values of this parameter vary based on the value of `PeriodUnit`.'."\n" - ."\n" - .'* If `PeriodUnit` is set to `Month`, the valid values of Period are 1, 3, and 6.'."\n" - .'* If `PeriodUnit` is set to `Year`, the valid value of Period is 1.'."\n" - ."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeTimerGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeTimerGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unit of the subscription duration.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Month (default)'."\n" - .'* Year'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'Month' => '', - 'Year' => '', - ], - 'example' => 'Month', + ], + [ + 'apiName' => 'CreateADConnectorDirectory', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateADConnectorDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AutoPay', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the auto-payment feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'ClonePolicyGroup', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ClonePolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PromotionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the promotional activity.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'youhuiquan_promotion_option_id_for_blank', + ], + [ + 'apiName' => 'ListTransferFiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListTransferFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The ID of the order.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24251717783****', - ], - 'RequestId' => [ - 'description' => 'The ID of a request.'."\n", - 'type' => 'string', - 'example' => 'AE7B699F-625C-587E-BC5F-1395CA969681', - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA969681\\"\\n}","type":"json"}]', - 'title' => 'CreateBandwidthResourcePackages', - 'summary' => 'Creates data transfer plans.', - ], - 'ListTransferFileDownloadUrl' => [ - 'summary' => 'Gets the download URL of the transferred file.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteOfficeSiteAccelerator', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteOfficeSiteAccelerator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'MigrateImageProtocol', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:MigrateImageProtocol', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateDesktops', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'GetDesktopGroupDetail', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据是客户端用户操作时产生，无法通过用例获取', - 'tenantRelevance' => 'tenant', + 'ramAction' => [ + 'action' => 'ecd:GetDesktopGroupDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trt-hffhi4nmqoi4****', + [ + 'apiName' => 'ModifyTemplateBaseInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyTemplateBaseInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FileIds', - 'in' => 'query', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'trf-i4pz8emx2k2fr****', - ], - 'required' => false, + ], + [ + 'apiName' => 'BatchModifyEntitlement', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:BatchModifyEntitlement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F1F01499-8F3D-5657-91AD-48177EB****', - ], - 'Urls' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FileId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'trf-i4pz8emx2k2fr****', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://xxsy-transfer.oss-cn-beijing.aliyuncs.com/xxxx', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'UPLOADING' => '', - 'DELETING' => '', - 'DELETED' => '', - 'UPLOADED' => '', - ], - 'example' => 'DELETED', - ], - 'FileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'document.txt', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyDiskSpec', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDiskSpec', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeKmsKeys', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeKmsKeys', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1F01499-8F3D-5657-91AD-48177EB****\\",\\n \\"Urls\\": [\\n {\\n \\"FileId\\": \\"trf-i4pz8emx2k2fr****\\",\\n \\"Url\\": \\"http://xxsy-transfer.oss-cn-beijing.aliyuncs.com/xxxx\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"FileName\\": \\"document.txt\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTransferFileDownloadUrl', - ], - 'ListTransferFiles' => [ - 'summary' => 'Queries the file information of a file transmission task.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateImage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyADConnectorOfficeSite', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyADConnectorOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeDevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ + [ + 'apiName' => 'DescribeCloudDiskGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDiskGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSnapshots', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '数据是客户端用户操作时产生，无法通过用例获取', - 'tenantRelevance' => 'tenant', + 'ramAction' => [ + 'action' => 'ecd:DescribeSnapshots', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the transmission task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'trt-03tdwg4tcuwdzv****', + [ + 'apiName' => 'CreateCloudDriveUsers', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCloudDriveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'MaxResults', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DescribeGuestApplications', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeGuestApplications', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0****', + ], + [ + 'apiName' => 'ModifyOfficeSiteDnsInfo', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteDnsInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'NextToken' => [ - 'description' => 'The returned value of `NextToken` is a pagination token, which can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a****', - ], - 'MaxResults' => [ - 'description' => 'The number of entries to return on each page.'."\n" - ."\n" - .'Maximum value: 100.'."\n" - ."\n" - .'Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Files' => [ - 'description' => 'The files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'trf-a213msf****', - ], - 'Name' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'IconUrl' => [ - 'description' => 'The URL of the file icon.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* For image file types (.png, .jpg, .jpeg, .gif, .webp, and .svg), the URL of the specific image is returned.'."\n" - ."\n" - .'* For other file types, the URL of the default image is returned.'."\n", - 'type' => 'string', - 'example' => 'https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****', - ], - 'Type' => [ - 'description' => 'The file type.'."\n", - 'type' => 'string', - 'example' => 'txt', - ], - 'Size' => [ - 'description' => 'The file size.'."\n", - 'type' => 'string', - 'example' => '10853079', - ], - 'Status' => [ - 'description' => 'The file status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DELETING'."\n" - .'* DELETED'."\n" - .'* UPLOADED'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DELETING' => '', - 'DELETED' => '', - 'UPLOADED' => '', - ], - 'example' => 'DELETED', - ], - 'OssFilePath' => [ - 'description' => 'The path of the object in the OSS bucket.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* A value is returned for this parameter only when the object is stored in a custom OSS bucket.'."\n", - 'type' => 'string', - 'example' => 'transfer/1244234/****', - ], - 'OssFileName' => [ - 'description' => 'The name of the object stored in OSS.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* A value is returned for this parameter only when the object is stored in a custom OSS bucket.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyCustomizedListHeaders', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCustomizedListHeaders', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 20,\\n \\"Files\\": [\\n {\\n \\"Id\\": \\"trf-a213msf****\\",\\n \\"Name\\": \\"测试文件\\",\\n \\"IconUrl\\": \\"https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****\\",\\n \\"Type\\": \\"txt\\",\\n \\"Size\\": \\"10853079\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"OssFilePath\\": \\"transfer/1244234/****\\",\\n \\"OssFileName\\": \\"测试文件_0982836423402342\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListTransferFiles', - ], - 'TransferTaskApprovalCallback' => [ - 'summary' => 'Queries the transmission and approval result for a submitted file.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteNetworkPackages', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteNetworkPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'RenewDesktops', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:RenewDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeUsersPassword', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUsersPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'systemTags' => [ + [ + 'apiName' => 'DescribeUserConnectionRecords', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUserConnectionRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeDesktops', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAclEntries', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeAclEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'HibernateDesktops', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:HibernateDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyImageAttribute', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'tenantRelevance' => 'tenant', + 'ramAction' => [ + 'action' => 'ecd:ModifyImageAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the transmission task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'trt-msndfksm18fs****', + [ + 'apiName' => 'CreateNASFileSystem', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateNASFileSystem', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Result', - 'in' => 'query', - 'schema' => [ - 'description' => 'The approval result.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Approved'."\n" - .'* Rejected'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Approved' => '', - 'Rejected' => '', - ], - 'example' => 'Approved', + ], + [ + 'apiName' => 'BindConfigGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:BindConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssBucketRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the OSS bucket storing the file resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'SetDesktopGroupScaleTimer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:SetDesktopGroupScaleTimer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'OssBucketName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the OSS bucket where the file resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ed****-17337752804***', + ], + [ + 'apiName' => 'RemoveUserFromDesktopGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:RemoveUserFromDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AE7B699F-625C-587E-BC5F-1395CA****', - ], - ], + [ + 'apiName' => 'CreateOfficeSiteAccelerator', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateOfficeSiteAccelerator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA****\\"\\n}","type":"json"}]', - 'title' => 'TransferTaskApprovalCallback', - ], - 'ListInstalledApps' => [ - 'summary' => 'Queries applications installed on a cloud computer.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'QueryHistoryUsageDurationRank', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:QueryHistoryUsageDurationRank', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateSimpleOfficeSite', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateSimpleOfficeSite', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListOfficeSiteUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListOfficeSiteUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'tenant', + [ + 'apiName' => 'ListDirectoryUsers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListDirectoryUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ecd-39clsqyxr****', + [ + 'apiName' => 'ListInstalledApps', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ListInstalledApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.\\'."\n" - .'Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', + ], + [ + 'apiName' => 'CreateQosRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateQosRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.\\'."\n" - .'Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CancelCdsFileShareLink', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CancelCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned information.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The unique ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], - 'Apps' => [ - 'description' => 'The information about the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The application details.'."\n", - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test_app', - ], - 'AppVersion' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'example' => '2.0.1', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeRecordings', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeRecordings', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 94,\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"test_app\\",\\n \\"AppVersion\\": \\"2.0.1\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListInstalledApps', - ], - 'DescribeEcdReportTasks' => [ - 'summary' => 'Queries data report export tasks.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteDesktopGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ModifyADConnectorDirectory', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyADConnectorDirectory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeOnlineUserCount', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeOnlineUserCount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'RenewDesktopGroup', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'tenantRelevance' => 'publicInformation', + 'ramAction' => [ + 'action' => 'ecd:RenewDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the report export task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ret-sfkdsjfi*****', + [ + 'apiName' => 'DeleteOfficeSites', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteOfficeSites', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the report.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* RESOURCE_REPORT'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'RESOURCE_REPORT' => '', - ], - 'example' => 'RESOURCE_REPORT', + ], + [ + 'apiName' => 'SendVerifyCode', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:SendVerifyCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sub-type of the report export task.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* DESKTOP: cloud computer'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DESKTOP' => '', - ], - 'example' => 'DESKTOP', + ], + [ + 'apiName' => 'DescribeCens', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeCens', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INIT: initializing'."\n" - .'* FAILED'."\n" - .'* RUNNING'."\n" - .'* EXPIRED'."\n" - .'* FINISHED'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task status.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - ], - 'required' => false, - 'enumValueTitles' => [ - 'INIT' => '', - 'FAILED' => '', - 'RUNNING' => '', - 'EXPIRED' => '', - 'FINISHED' => '', - ], - 'maxItems' => 100, + ], + [ + 'apiName' => 'DeleteSnapshot', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CreateCloudDriveGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateCloudDriveGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries returned per page. Maximum value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20。', + ], + [ + 'apiName' => 'ConfigADConnectorTrust', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ConfigADConnectorTrust', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'ExportTaskList' => [ - 'description' => 'The report export tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the report export task.'."\n", - 'type' => 'string', - 'example' => 'ret-asdfkjg*****', - ], - 'TaskType' => [ - 'description' => 'The type of the report.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* RESOURCE_REPORT'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'RESOURCE_REPORT' => '', - ], - 'example' => 'RESOURCE_REPORT', - ], - 'SubType' => [ - 'description' => 'The sub-type of the report export task.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* DESKTOP: cloud computer'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'DESKTOP' => '', - ], - 'example' => 'DESKTOP', - ], - 'ReportFileName' => [ - 'description' => 'The name of the report file.'."\n", - 'type' => 'string', - 'example' => 'TestFileName', - ], - 'Status' => [ - 'description' => 'The task status.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'Progress' => [ - 'description' => 'The progress of the report export task. Unit: %.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '80', - ], - 'GmtCreate' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '2025-07-14T07:46:49.000+00:00', - ], - 'GmtModified' => [ - 'description' => 'The time when the task was last modified.'."\n", - 'type' => 'string', - 'example' => '2025-07-14T07:46:49.000+00:00', - ], - 'DownloadUrl' => [ - 'description' => 'The download URL of the report file.'."\n", - 'type' => 'string', - 'example' => 'https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'ErrorMsg' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'No Data.', - ], - ], - 'description' => '', - ], - ], - ], + [ + 'apiName' => 'DeleteDrive', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteDrive', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ModifyCdsFileShareLink', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ModifyCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"ExportTaskList\\": [\\n {\\n \\"TaskId\\": \\"ret-asdfkjg*****\\",\\n \\"TaskType\\": \\"RESOURCE_REPORT\\",\\n \\"SubType\\": \\"DESKTOP\\",\\n \\"ReportFileName\\": \\"TestFileName\\",\\n \\"Status\\": \\"Running\\",\\n \\"Progress\\": 80,\\n \\"GmtCreate\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"DownloadUrl\\": \\"https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMsg\\": \\"No Data.\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeEcdReportTasks', - ], - 'CreateEcdReportTask' => [ - 'summary' => 'Creates a data report export task.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateTemplate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'AttachCen', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:AttachCen', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeCdsFileShareLinks', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeCdsFileShareLinks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + [ + 'apiName' => 'DescribeGlobalDesktopRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeGlobalDesktopRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the report task.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* RESOURCE_REPORT'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'RESOURCE_REPORT' => '', - ], - 'example' => 'RESOURCE_REPORT', + [ + 'apiName' => 'ExportClientEvents', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ExportClientEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sub-type of the report export task.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* DESKTOP: cloud computer'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - ' DESKTOP' => '', - ], - 'example' => ' DESKTOP', + ], + [ + 'apiName' => 'ModifyTemplate', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'FilterList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The filter conditions for filtering query results. The logical relationship between each filter condition is "and" (&). Each filter condition contains FilterKey and FilterValues, which indicate the key and value for the filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The filter condition object.'."\n", - 'type' => 'object', - 'properties' => [ - 'FilterKey' => [ - 'description' => 'The key of the filter condition for filtering query results. When SubType is set to:'."\n" - ."\n" - .'1. DESKTOP (indicating a cloud computer report), the following filter conditions are available:'."\n" - ."\n" - .'* KeyWord: cloud computer keyword (supports automatic recognition)'."\n" - .'* RegionId: region ID'."\n" - .'* DesktopId: cloud computer ID'."\n" - .'* DesktopName: cloud computer name (supports fuzzy matching)'."\n" - .'* OfficeSiteId: office network ID'."\n" - .'* OfficeSiteName: office network name (supports fuzzy matching)'."\n" - .'* Status: cloud computer status'."\n" - .'* DesktopType: desktop type'."\n" - .'* DesktopIP: cloud computer IP address'."\n" - .'* SubPayType: billing method'."\n" - .'* EndUserId: user name (supports fuzzy matching)'."\n" - .'* ExpireTime: expiration date and time, in the yyyy-MM-dd\'T\'HH:mm:ss\'Z\' format'."\n" - .'* IncludeAssignedUser: indicates whether the cloud computer is assigned to users or not'."\n" - .'* ResourceGroupId: resource group ID'."\n" - .'* PolicyId: policy ID'."\n" - .'* Tag:{Tag Key value}: cloud computer tag (To filter data using multiple tags, specify multiple filter condition objects.)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Tag:TestKey', - ], - 'FilterValues' => [ - 'description' => 'The value of the filter condition. Only the first value of the FilterValues parameter is used, if FilterKey is set to one of the following values:'."\n" - ."\n" - .'* KeyWord'."\n" - .'* DesktopName'."\n" - .'* OfficeSiteName'."\n" - .'* DesktopIP'."\n" - .'* EndUserId'."\n" - .'* ExpireTime'."\n" - .'* IncludeAssignedUser'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The specific value of the filter condition for filtering query results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'required' => false, - 'maxItems' => 200, - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, + ], + [ + 'apiName' => 'ApplyAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ApplyAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ReportFileName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the report file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', + ], + [ + 'apiName' => 'DescribeRegions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'LangType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the report. An enumerated type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* zh-CN (default): Chinese'."\n" - .'* en-GB: English'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'zh-CN' => '', - 'en-GB' => '', - ], - 'example' => 'zh-CN', + ], + [ + 'apiName' => 'MoveCdsFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:MoveCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Code' => [ - 'description' => 'The request result. If the request was successful, `success` is returned. If the request failed, an error message is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed. This parameter is not returned if the value of Code is success.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'TaskId' => [ - 'description' => 'The ID of the report export task.'."\n", - 'type' => 'string', - 'example' => 'ret-g67ip******', - ], - ], + [ + 'apiName' => 'SetDirectorySsoStatus', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:SetDirectorySsoStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ExportDesktopGroupInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ExportDesktopGroupInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"TaskId\\": \\"ret-g67ip******\\"\\n}","type":"json"}]', - 'title' => 'CreateEcdReportTask', - ], - 'CreateQosRule' => [ - 'summary' => 'Creates a Quality of Service (QoS) rule.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteCdsFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DeleteCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'WakeupDesktops', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:WakeupDesktops', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DownloadCdsFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DownloadCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', + [ + 'apiName' => 'DescribeRenewalPrice', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeRenewalPrice', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'NetworkPackageId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np-cfedn7r2pe48g****', + [ + 'apiName' => 'DeleteCloudDriveUsers', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteCloudDriveUsers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'QosRuleName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '', + ], + [ + 'apiName' => 'DescribeDesktopSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeDesktopSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Upload', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', + ], + [ + 'apiName' => 'ModifyQosEntries', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyQosEntries', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Download', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '5', + ], + [ + 'apiName' => 'ModifyCloudDriveGroups', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCloudDriveGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthDesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-sfasdfsddsat*****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DescribeCloudDriveGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDriveGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthAndroidId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cpn-asdsdfsdffsd*****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'GetOfficeSiteSsoStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:GetOfficeSiteSsoStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'QosRuleId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qos-5605u0gelk200****', - ], - ], + [ + 'apiName' => 'ModifyCdsFile', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:ModifyCdsFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\"\\n}","type":"json"}]', - 'title' => 'CreateQosRule', - ], - 'DeleteQosRules' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeDirectories', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeDirectories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ModifyNetworkPackageEnabled', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyNetworkPackageEnabled', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeImagePermission', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeImagePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'systemTags' => [ + [ + 'apiName' => 'TransferTaskApprovalCallback', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:TransferTaskApprovalCallback', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeVirtualMFADevices', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeVirtualMFADevices', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeletePolicyGroups', + 'description' => '', 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeletePolicyGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'QosRuleId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'qos-5605u0gelk200****', - ], - 'required' => true, - 'maxItems' => 100, + [ + 'apiName' => 'DisableDesktopsInGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:DisableDesktopsInGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******', - ], - ], + [ + 'apiName' => 'CreateDrive', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDrive', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\"\\n}","type":"json"}]', - 'title' => 'DeleteQosRules', - 'summary' => 'Deletes a traffic throttling rule from a QoS policy.', - ], - 'DescribeQosRules' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DeleteCenterPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DeleteCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyResourceCenterPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:ModifyResourceCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeCloudDrivePermissions', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeCloudDrivePermissions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteQosRules', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteQosRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'systemTags' => [ + [ + 'apiName' => 'UploadImage', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:UploadImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DisconnectDesktopSessions', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:DisconnectDesktopSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateSnapshot', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateSnapshot', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDesktopName', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyDesktopName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyConfigGroup', + 'description' => '', 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:ModifyConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'NetworkPackageId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'np-cxj99qb8d34vo****', + [ + 'apiName' => 'ModifyAutoSnapshotPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyAutoSnapshotPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'QosRuleName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'DescribeNASFileSystems', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeNASFileSystems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'QosRules' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'QosRuleId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'qos-chvkz5ekzgcb6bo0f', - ], - 'QosRuleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'test', - ], - 'NetworkPackageId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'np-5cjh3sqs1ty3s02xq', - ], - 'Upload' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'Download' => [ - 'description' => '', - 'type' => 'string', - 'example' => '10', - ], - 'DesktopCount' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], + [ + 'apiName' => 'DescribeFlowMetric', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeFlowMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QosRules\\": [\\n {\\n \\"QosRuleId\\": \\"qos-chvkz5ekzgcb6bo0f\\",\\n \\"QosRuleName\\": \\"test\\",\\n \\"NetworkPackageId\\": \\"np-5cjh3sqs1ty3s02xq\\",\\n \\"Upload\\": \\"10\\",\\n \\"Download\\": \\"10\\",\\n \\"DesktopCount\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeQosRules', - 'summary' => 'Queries Quality of Service (QoS) rules.', - ], - 'ModifyQosEntries' => [ - 'summary' => 'Modifies the resources that a Quality of Service (QoS) rule applies to.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'AddFilePermission', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:AddFilePermission', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListTagResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeUsersInGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeUsersInGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ + [ + 'apiName' => 'UntagResources', + 'description' => '', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'ecd:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'QosRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qos-5605u0gelk200****', + [ + 'apiName' => 'ModifyCenterPolicy', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyCenterPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthDesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-j45qtb0eh91yg****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'CreateConfigGroup', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:CreateConfigGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RevokeDesktopId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-j45qtb0eh91yg****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'ModifyOfficeSiteAccelerator', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyOfficeSiteAccelerator', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AuthAndroidId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cpn-asdsdfsdffsd*****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'DescribeGlobalTimerRecords', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'ecd:DescribeGlobalTimerRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RevokeAndroidId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cpn-asdsdfsdffsd*****', - ], - 'required' => false, - 'maxItems' => 100, + ], + [ + 'apiName' => 'CreateCdsFileShareLink', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CreateCdsFileShareLink', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyQosEntries', - ], - 'ModifyQosRule' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'DescribeNetworkPackages', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeNetworkPackages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeBundles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'ecd:DescribeBundles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CancelCoordinationForMonitoring', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:CancelCoordinationForMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', + [ + 'apiName' => 'CreateDesktopGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreateDesktopGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'QosRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'qos-5605u0gelk200****', + [ + 'apiName' => 'DescribeDrives', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:DescribeDrives', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'QosRuleName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + [ + 'apiName' => 'CreatePolicyGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'ecd:CreatePolicyGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Upload', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyEntitlement', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyEntitlement', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Download', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + ], + [ + 'apiName' => 'ModifyQosRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'ecd:ModifyQosRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], + [ + 'apiName' => 'AssociateNetworkPackage', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'ecd:AssociateNetworkPackage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ModifyQosRule', - 'summary' => 'Modifies a Quality of Service (QoS) rule.', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'ecd.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'ecd.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'ecd.me-east-1.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; -- cgit v1.2.3