summaryrefslogtreecommitdiff
path: root/data/en_us/ecd
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/ecd
downloadacs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz
acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip
Diffstat (limited to 'data/en_us/ecd')
-rw-r--r--data/en_us/ecd/2020-09-30/api-docs.php57758
-rw-r--r--data/en_us/ecd/2020-10-02/api-docs.php6223
-rw-r--r--data/en_us/ecd/2023-06-27/api-docs.php359
3 files changed, 64340 insertions, 0 deletions
diff --git a/data/en_us/ecd/2020-09-30/api-docs.php b/data/en_us/ecd/2020-09-30/api-docs.php
new file mode 100644
index 0000000..d789418
--- /dev/null
+++ b/data/en_us/ecd/2020-09-30/api-docs.php
@@ -0,0 +1,57758 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'ecd',
+ 'version' => '2020-09-30',
+ ],
+ 'directories' => [
+ [
+ 'id' => 394528,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeRegions',
+ 'DescribeZones',
+ ],
+ ],
+ [
+ 'id' => 394531,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribePrice',
+ 'DescribeRenewalPrice',
+ 'DescribeModificationPrice',
+ 'DescribeRefundPrice',
+ ],
+ ],
+ [
+ 'id' => 394536,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 394537,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListOfficeSiteOverview',
+ 'DescribeOfficeSites',
+ 'ModifyOfficeSiteAttribute',
+ 'ModifyOfficeSiteCrossDesktopAccess',
+ 'DeleteOfficeSites',
+ 'ModifyOfficeSiteDnsInfo',
+ ],
+ ],
+ [
+ 'id' => 394544,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateSimpleOfficeSite',
+ 'ActivateOfficeSite',
+ ],
+ ],
+ [
+ 'id' => 394547,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateADConnectorOfficeSite',
+ 'ListUserAdOrganizationUnits',
+ 'ListOfficeSiteUsers',
+ 'ModifyADConnectorOfficeSite',
+ 'ModifyOfficeSiteMfaEnabled',
+ 'ConfigADConnectorTrust',
+ 'ConfigADConnectorUser',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394555,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateADConnectorDirectory',
+ 'CreateRAMDirectory',
+ 'DescribeDirectories',
+ 'ListDirectoryUsers',
+ 'ModifyADConnectorDirectory',
+ 'DeleteDirectories',
+ ],
+ ],
+ [
+ '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',
+ 'DescribeDesktopMetadata',
+ ],
+ ],
+ [
+ 'id' => 394590,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeUsersPassword',
+ 'GetConnectionTicket',
+ 'DescribeGuestApplications',
+ 'ModifyUserEntitlement',
+ 'ModifyEntitlement',
+ 'BatchModifyEntitlement',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394597,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 394598,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDesktopGroup',
+ 'GetDesktopGroupDetail',
+ 'DescribeDesktopGroups',
+ 'ExportDesktopGroupInfo',
+ 'DescribeDesktopsInGroup',
+ 'DisableDesktopsInGroup',
+ 'ModifyDesktopGroup',
+ 'ResetDesktops',
+ 'SetDesktopGroupScaleTimer',
+ 'SetDesktopGroupTimer',
+ 'SetDesktopGroupTimerStatus',
+ 'RenewDesktopGroup',
+ 'DeleteDesktopGroup',
+ ],
+ ],
+ [
+ 'id' => 394612,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'AddUserToDesktopGroup',
+ 'DescribeUsersInGroup',
+ 'DescribeUserConnectionRecords',
+ 'ModifyUserToDesktopGroup',
+ 'RemoveUserFromDesktopGroup',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394618,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateNetworkPackage',
+ 'DescribeNetworkPackages',
+ 'DescribeFlowMetric',
+ 'DescribeFlowStatistic',
+ 'DescribeAclEntries',
+ 'ModifyAclEntries',
+ 'AssociateNetworkPackage',
+ 'DissociateNetworkPackage',
+ 'RenewNetworkPackages',
+ 'ModifyNetworkPackageBandwidth',
+ 'ModifyNetworkPackageEnabled',
+ 'DeleteNetworkPackages',
+ ],
+ ],
+ [
+ 'id' => 394631,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeCens',
+ 'VerifyCen',
+ 'SendVerifyCode',
+ 'AttachCen',
+ 'DetachCen',
+ ],
+ ],
+ [
+ 'id' => 394637,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateDrive',
+ 'DeleteDrive',
+ 'DescribeDrives',
+ [
+ 'id' => 394641,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 394642,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCloudDriveService',
+ ],
+ ],
+ [
+ 'id' => 394644,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeCloudDiskGroupDrives',
+ 'DescribeCloudDiskGroups',
+ 'CreateCloudDriveGroup',
+ 'DescribeCloudDriveGroups',
+ 'ModifyCloudDriveGroups',
+ 'DeleteCloudDriveGroups',
+ ],
+ ],
+ [
+ 'id' => 394651,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCloudDriveUsers',
+ 'DescribeCloudDriveUsers',
+ 'ModifyCloudDriveUsers',
+ 'DeleteCloudDriveUsers',
+ ],
+ ],
+ [
+ 'id' => 394656,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeCloudDrivePermissions',
+ 'ModifyCloudDrivePermission',
+ ],
+ ],
+ [
+ 'id' => 394659,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCdsFile',
+ 'CompleteCdsFile',
+ 'CopyCdsFile',
+ 'ListCdsFiles',
+ 'GetAsyncTask',
+ 'ModifyCdsFile',
+ 'MoveCdsFile',
+ 'DownloadCdsFile',
+ 'DeleteCdsFile',
+ ],
+ ],
+ [
+ 'id' => 394669,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateCdsFileShareLink',
+ 'DescribeCdsFileShareLinks',
+ 'ModifyCdsFileShareLink',
+ 'CancelCdsFileShareLink',
+ ],
+ ],
+ [
+ 'id' => 394674,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'AddFilePermission',
+ 'ListFilePermission',
+ 'RemoveFilePermission',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394678,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateAndBindNasFileSystem',
+ 'CreateNASFileSystem',
+ 'DescribeNASFileSystems',
+ 'ModifyNASDefaultMountTarget',
+ 'ResetNASDefaultMountTarget',
+ 'DeleteNASFileSystems',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394685,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateTemplate',
+ 'DescribeTemplates',
+ 'ModifyTemplate',
+ 'DeleteTemplates',
+ 'ModifyTemplateBaseInfo',
+ ],
+ ],
+ [
+ 'id' => 394691,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateBundle',
+ 'DescribeBundles',
+ 'ModifyBundle',
+ 'DeleteBundles',
+ ],
+ ],
+ [
+ 'id' => 394696,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateImage',
+ 'CopyImage',
+ 'UploadImage',
+ 'DescribeImages',
+ 'DescribeImageModifiedRecords',
+ 'DescribeImagePermission',
+ 'ModifyImageAttribute',
+ 'ModifyImagePermission',
+ 'MigrateImageProtocol',
+ 'DeleteImages',
+ 'CancelCopyImage',
+ ],
+ ],
+ [
+ 'id' => 394708,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 394709,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateSnapshot',
+ 'ResetSnapshot',
+ 'DescribeSnapshots',
+ 'DeleteSnapshot',
+ ],
+ ],
+ [
+ 'id' => 394714,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateAutoSnapshotPolicy',
+ 'DescribeAutoSnapshotPolicy',
+ 'ApplyAutoSnapshotPolicy',
+ 'ModifyAutoSnapshotPolicy',
+ 'CancelAutoSnapshotPolicy',
+ 'DeleteAutoSnapshotPolicy',
+ ],
+ ],
+ ],
+ ],
+ [
+ 'id' => 394721,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ [
+ 'id' => 394722,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DeleteCenterPolicy',
+ 'ModifyResourceCenterPolicy',
+ 'ModifyCenterPolicy',
+ 'DescribeResourceByCenterPolicyId',
+ 'DescribeCenterPolicyList',
+ 'CreateCenterPolicy',
+ 'CloneCenterPolicy',
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'id' => 394757,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'SetOfficeSiteSsoStatus',
+ 'SetIdpMetadata',
+ 'SetDirectorySsoStatus',
+ 'GetOfficeSiteSsoStatus',
+ 'GetSpMetadata',
+ ],
+ ],
+ [
+ 'id' => 394763,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'StopInvocation',
+ 'DescribeInvocations',
+ 'RunCommand',
+ ],
+ ],
+ [
+ 'id' => 394767,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListTagResources',
+ 'TagResources',
+ 'UntagResources',
+ ],
+ ],
+ [
+ 'id' => 394771,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeClientEvents',
+ 'ExportClientEvents',
+ 'DescribeRecordings',
+ 'DescribeRecordFile',
+ 'DescribeGlobalDesktopRecords',
+ ],
+ ],
+ [
+ 'id' => 394777,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'AddDevices',
+ 'DeleteDevices',
+ 'AttachEndUser',
+ 'DetachEndUser',
+ 'DescribeDevices',
+ ],
+ ],
+ [
+ 'id' => 394783,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeDesktopSessions',
+ 'DescribeDesktopGroupSessions',
+ 'DescribeSessionStatistic',
+ 'DisconnectDesktopSessions',
+ 'ApplyCoordinationForMonitoring',
+ 'GetCoordinateTicket',
+ 'CancelCoordinationForMonitoring',
+ 'ApplyCoordinatePrivilege',
+ 'RevokeCoordinatePrivilege',
+ ],
+ ],
+ [
+ 'id' => 394793,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateBandwidthResourcePackages',
+ ],
+ ],
+ [
+ 'id' => 394795,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListTransferFileDownloadUrl',
+ 'ListTransferFiles',
+ 'TransferTaskApprovalCallback',
+ ],
+ ],
+ [
+ 'id' => 394799,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'ListInstalledApps',
+ ],
+ ],
+ [
+ 'id' => 394801,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeEcdReportTasks',
+ 'CreateEcdReportTask',
+ ],
+ ],
+ [
+ 'id' => 394804,
+ 'title' => null,
+ 'type' => 'directory',
+ 'children' => [
+ 'CreateQosRule',
+ 'DeleteQosRules',
+ 'DescribeQosRules',
+ 'ModifyQosEntries',
+ 'ModifyQosRule',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'CdsFileShareLinkModel' => [
+ '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',
+ ],
+ 'Status' => [
+ 'title' => '',
+ 'description' => 'The status of the file sharing link.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* forbidden_disabled'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' : The file sharing link is canceled'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' after it'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' is not allowed.'."\n"
+ ."\n"
+ .'* forbidden'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' :'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' The file sharing link is not allowed'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' .'."\n"
+ ."\n"
+ .'* disabled'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' :'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' The file sharing link is canceled.'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* enabled'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' :'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' The file sharing link is valid.'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ ' forbidden_disabled' => '',
+ 'forbidden' => '',
+ ' disabled' => '',
+ 'enabled' => '',
+ ],
+ 'example' => 'disabled',
+ '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',
+ ],
+ ],
+ ],
+ 'FilePermissionMember' => [
+ 'title' => '',
+ 'description' => 'The object that you want to grant permissions.'."\n",
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleId' => [
+ 'title' => '',
+ 'description' => 'The role.'."\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.',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 'SystemFileEditorWithoutShareLink' => '',
+ 'SystemFileUploaderAndDownloaderWithShareLink' => '',
+ 'SystemFileDownloader' => '',
+ 'SystemFileEditorWithoutDelete' => '',
+ 'SystemFileOwner' => '',
+ 'SystemFileDownloaderWithShareLink' => '',
+ 'SystemFileUploaderAndViewer' => '',
+ 'SystemFileViewer' => '',
+ 'SystemFileEditor' => '',
+ 'SystemFileUploaderWithShareLink' => '',
+ 'SystemFileUploader' => '',
+ 'SystemFileUploaderAndDownloader' => '',
+ 'SystemFileMetaViewer' => '',
+ ],
+ 'example' => 'SystemFileEditor',
+ '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',
+ ],
+ 'CdsIdentity' => [
+ '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',
+ ],
+ 'Type' => [
+ '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' => '',
+ ],
+ 'example' => 'IT_User',
+ 'backendName' => 'type',
+ ],
+ ],
+ 'required' => true,
+ 'backendName' => 'cdsIdentity',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'DescribeRegions' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AcceptLanguage',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ '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)',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'ZoneType',
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ 'Zones' => [
+ 'description' => 'Details of zones.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'ZoneId' => [
+ 'description' => 'The zone ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou-h',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeZonesResponse>\\n <RequestId>5BEFE642-A383-4A18-8939-FB7DE4526F65</RequestId>\\n <Zones>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n </Zones>\\n</DescribeZonesResponse>","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',
+ ],
+ '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. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the regions supported by EDS.'."\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"
+ .'* 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',
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskSizeGib',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '32768',
+ 'minimum' => '0',
+ 'example' => '80',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskSizeGib',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The size of the data disk. Unit: GiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '65536',
+ 'minimum' => '0',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ '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',
+ ],
+ ],
+ [
+ '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 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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The promotion ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'InternetChargeType',
+ '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',
+ ],
+ ],
+ [
+ '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"
+ .'* Valid values if you set InternetChargeType to InternetChargeType: 10 to 200.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '3072',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskPerformanceLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskPerformanceLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Duration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskCategory',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskCategory',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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":"<DescribePrice>\\n <RequestId>B1175630-3C44-4389-A3C1-15639FFC8EBC</RequestId>\\n <PriceInfo>\\n <Price>\\n <OriginalPrice>2.796</OriginalPrice>\\n <DiscountPrice>0</DiscountPrice>\\n <Currency>CNY</Currency>\\n <TradePrice>2.796</TradePrice>\\n </Price>\\n </PriceInfo>\\n</DescribePrice>","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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '75405',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsENR35V',
+ ],
+ ],
+ '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' => 'InstanceId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource type.'."\n"
+ ."\n"
+ .'Valid values:'."\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"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Month (default)'."\n"
+ .'* Year'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'Month' => '',
+ 'Year' => '',
+ ],
+ 'example' => 'Month',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The renewal duration. The valid values for this parameter depend on the value of `PeriodUnit`.'."\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"
+ ."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'InstanceIds',
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The instance ID. This parameter has the same effect as `InstanceId`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-6ldllk9zxcpfhs****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ [
+ 'errorCode' => 'InternalError',
+ 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'InstanceType',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskSizeGib',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskPerformanceLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskPerformanceLevel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ '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"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Desktop (default): cloud computers.'."\n"
+ .'* NetworkPackage: premium bandwidth plans.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Desktop' => '',
+ 'NetworkPackage' => '',
+ ],
+ 'example' => 'Desktop',
+ ],
+ ],
+ [
+ 'name' => 'Bandwidth',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum public bandwidth. Unit: Mbit/s.'."\n"
+ ."\n"
+ .'> Valid values when PayByTraffic is set to PayByBandwidth: 10 to 1000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '3072',
+ 'minimum' => '2',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ResourceSpecs',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DesktopId' => [
+ 'type' => 'string',
+ ],
+ 'RootDiskSizeGib' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ 'UserDiskSizeGib' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ ],
+ ],
+ ],
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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",
+ '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' => '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' => '',
+ ],
+ ],
+ ],
+ ],
+ 'OrderLines' => [
+ 'description' => 'The orders.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => 'The order.'."\n",
+ 'example' => '5376483****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ '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' => 'RefundType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'ID of cloud computer N. Valid values of N: 1 to 20.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ 'required' => true,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'ForceRefresh',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to refresh the cache.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ '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,
+ ],
+ ],
+ [
+ '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"
+ .'* 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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<ListOfficeSiteOverviewResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>EC330A26-1940-4A26-A4C8-E99AE907E25B</RequestId>\\n <OfficeSiteOverviewResults>\\n <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>\\n <HasExpiredEdsCount>0</HasExpiredEdsCount>\\n <TotalEdsCount>1</TotalEdsCount>\\n <WillExpiredEdsCount>0</WillExpiredEdsCount>\\n <RunningEdsCount>1</RunningEdsCount>\\n <OfficeSiteName>test</OfficeSiteName>\\n <RegionId>cn-hangzhou</RegionId>\\n <OfficeSiteStatus>REGISTERED</OfficeSiteStatus>\\n </OfficeSiteOverviewResults>\\n</ListOfficeSiteOverviewResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '52838',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteType',
+ '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"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'SIMPLE' => '',
+ 'AD_CONNECTOR' => '',
+ ],
+ 'example' => 'SIMPLE',
+ ],
+ ],
+ [
+ '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' => '500',
+ 'minimum' => '0',
+ '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' => 'OfficeSiteId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network status.'."\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"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'REGISTERING' => '',
+ 'DEREGISTERING' => '',
+ 'REGISTERED' => '',
+ 'NEEDCONFIGTRUST' => '',
+ 'CONFIGTRUSTFAILED' => '',
+ 'DEREGISTERED' => '',
+ 'ERROR' => '',
+ 'CONFIGTRUSTING' => '',
+ 'NEEDCONFIGUSER' => '',
+ ],
+ 'example' => 'REGISTERED',
+ ],
+ ],
+ [
+ 'name' => 'SecurityProtection',
+ 'in' => 'query',
+ 'schema' => [
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SASE' => 'SASE',
+ 'OFF' => '',
+ ],
+ 'example' => 'SASE',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'description' => 'The ID of the virtual private cloud (VPC).'."\n",
+ 'example' => 'vpc-uf6bpyqivwl5f3pvoxxu0',
+ ],
+ ],
+ [
+ 'name' => 'AccountType',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeOfficeSitesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>\\n <OfficeSites>\\n <Status>REGISTERED</Status>\\n <CreationTime>2021-05-06T05:58Z</CreationTime>\\n <VpcId>vpc-uf6tz5k67puge5jn8****</VpcId>\\n <VpcType>Basic</VpcType>\\n <EnableAdminAccess>true</EnableAdminAccess>\\n <EnableCrossDesktopAccess>false</EnableCrossDesktopAccess>\\n <DesktopVpcEndpoint>http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com</DesktopVpcEndpoint>\\n <DesktopAccessType>INTERNET</DesktopAccessType>\\n <DomainName>example.com\\t</DomainName>\\n <SsoEnabled>false</SsoEnabled>\\n <CidrBlock>172.16.0.0/16</CidrBlock>\\n <Bandwidth>10</Bandwidth>\\n <TrustPassword>82Tg****</TrustPassword>\\n <Name>test</Name>\\n <EnableInternetAccess>false</EnableInternetAccess>\\n <DomainPassword>testPassword</DomainPassword>\\n <CustomSecurityGroupId>sg-bp1ce64o4g9mdf5u****</CustomSecurityGroupId>\\n <OuName>example.com/Domain Controllers</OuName>\\n <DomainUserName>Administrator</DomainUserName>\\n <SubDomainName>testSubDnsUserName</SubDomainName>\\n <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>\\n <CenId>cen-3gwy16dojz1m65****</CenId>\\n <MfaEnabled>false</MfaEnabled>\\n <NetworkPackageId>np-amtp8e8q1o9e4****</NetworkPackageId>\\n <DnsUserName>testDnsUserName\\t</DnsUserName>\\n <OfficeSiteType>AD_CONNECTOR</OfficeSiteType>\\n <ADConnectors>\\n <ConnectorStatus>RUNNING</ConnectorStatus>\\n <VSwitchId>vsw-bp19ocz3erfx15uon****</VSwitchId>\\n <ADConnectorAddress>172.24.*.*</ADConnectorAddress>\\n <TrustKey>password123***</TrustKey>\\n <NetworkInterfaceId>eni-bp1i4wx78lgosrj6****</NetworkInterfaceId>\\n <Specification>1</Specification>\\n </ADConnectors>\\n <Logs>\\n <Step>CREATE_CONNECTOR</Step>\\n <Message>code:success | message:Create Connector complete</Message>\\n <TimeStamp>2021-05-12T09:42Z</TimeStamp>\\n <Level>INFO</Level>\\n </Logs>\\n <VSwitchIds>vsw-bp19ocz3erfx15uon****</VSwitchIds>\\n <FileSystemIds>[\\"05b534****\\"]</FileSystemIds>\\n <SubDnsAddress> [\\"172.24.*.*\\"]</SubDnsAddress>\\n <DnsAddress> [\\"172.24.*.*\\"]</DnsAddress>\\n <NeedVerifyLoginRisk>false</NeedVerifyLoginRisk>\\n <DesktopCount>1</DesktopCount>\\n <NeedVerifyZeroDevice>true</NeedVerifyZeroDevice>\\n <CloudBoxOfficeSite>true</CloudBoxOfficeSite>\\n <SsoType>SAML</SsoType>\\n <ProtocolType>HDX</ProtocolType>\\n <AdHostname>beijing-ad01</AdHostname>\\n </OfficeSites>\\n</DescribeOfficeSitesResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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 (\\_), 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',
+ ],
+ ],
+ [
+ 'name' => 'NeedVerifyLoginRisk',
+ '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.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'NeedVerifyZeroDevice',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AuthorityHost',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TenantId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'DomainName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ClientSecret',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyOfficeSiteAttributeResponse>\\r\\n<RequestId>DE6C3EE0-0061-499F-A30C-6E43BB3EF931</RequestId>\\r\\n</ModifyOfficeSiteAttributeResponse>","errorExample":""}]',
+ 'title' => 'ModifyOfficeSiteAttribute',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyOfficeSiteCrossDesktopAccess' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-068266****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => ' ',
+ ],
+ 'ModifyOfficeSiteDnsInfo' => [
+ 'summary' => 'Modifies the DNS information of an office network.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-778418****',
+ ],
+ ],
+ [
+ 'name' => 'DnsAddress',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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 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****',
+ ],
+ ],
+ [
+ 'name' => 'CenOwnerId',
+ '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****',
+ ],
+ ],
+ [
+ '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](~~335132~~) operation to obtain the verification code.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123456',
+ ],
+ ],
+ [
+ 'name' => 'Bandwidth',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteName',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EnableInternetAccess',
+ '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 (default)'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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' => '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.````',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'VPC' => '',
+ 'Internet' => '',
+ 'Any' => '',
+ ],
+ 'example' => 'Internet',
+ ],
+ ],
+ [
+ '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',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'CloudBoxOfficeSite',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to create a CloudBox-based office network.'."\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',
+ ],
+ ],
+ [
+ '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',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientSecret',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'Eid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<CreateSimpleOfficeSiteResponse>\\n <OfficeSiteId>cn-hangzhou+os-c5cy7q578s8jc****</OfficeSiteId>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</CreateSimpleOfficeSiteResponse>","errorExample":""}]',
+ 'title' => 'CreateSimpleOfficeSite',
+ '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****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\"\\n}","errorExample":""},{"type":"xml","example":"<ActivateOfficeSiteResponse>\\r\\n <RequestId>269BDB16-2CD8-4865-84BD-11C40BC21DB0</RequestId>\\r\\n</ActivateOfficeSiteResponse>","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' => ' ',
+ ],
+ 'CreateADConnectorOfficeSite' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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 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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'CenId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the CEN instance.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cen-3gwy16dojz1m65****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DomainPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the domain administrator. The password can be up to 64 characters in length.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'testPassword',
+ ],
+ ],
+ [
+ '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 (\\_), 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',
+ ],
+ ],
+ [
+ '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"
+ .'* <!-- -->'."\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',
+ ],
+ ],
+ [
+ 'name' => 'SubDomainName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The domain name of the enterprise AD subdomain.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'child.example.com',
+ ],
+ ],
+ [
+ 'name' => 'MfaEnabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable multi-factor authentication (MFA).'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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",
+ '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',
+ ],
+ 'required' => true,
+ 'example' => '192.168.XX.XX',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'SubDomainDnsAddress',
+ '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",
+ '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',
+ ],
+ 'required' => false,
+ 'example' => '192.168.XX.XX',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ '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",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 1 => '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'BackupDns',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The DNS address of the backup domain controller.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '192.168.2.100',
+ ],
+ ],
+ [
+ 'name' => 'BackupDCHostname',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The hostname of the backup domain controller.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dc002',
+ ],
+ ],
+ [
+ 'name' => 'VSwitchId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The array of the vSwitch IDs.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The vSwitch ID.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'vsw-uf68bgq7rjwbqpg0****',
+ ],
+ 'required' => false,
+ 'maxItems' => 2,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ 'OfficeSiteId' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'NetworkSpace.VpcInfoExist',
+ 'errorMessage' => 'vpc info already exist.',
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'After you call this operation to create an AD office network, you must perform the following steps to complete AD domain setting:'."\n"
+ ."\n"
+ .'1. Configure a conditional forwarder in a Domain Name System (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"
+ ."\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"
+ ."\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"
+ ."\n"
+ .'For more information, see [Create and manage enterprise AD office networks](~~214469~~).',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ListUserAdOrganizationUnits' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The enterprise AD office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+dir-485361****',
+ ],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The string that you enter for fuzzy search.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'develop',
+ ],
+ ],
+ [
+ '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' => 'CAAAAA==',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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==',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<ListUserAdOrganizationUnitsResponse>\\n <OUNames>\\n <OUName>example.com/Domain Controllers</OUName>\\n <OfficeSiteId>cn-hangzhou+dir-485361****</OfficeSiteId>\\n </OUNames>\\n <RequestId>28978806-3938-5774-B107-0DAEC97C5BD1</RequestId>\\n</ListUserAdOrganizationUnitsResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Filter',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The query string for fuzzy query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '*jin*',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ '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****',
+ ],
+ ],
+ [
+ '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 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',
+ ],
+ ],
+ [
+ '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,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'OUPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The organizational unit (OU) of the specified AD domain.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'example.com/Domain Controllers',
+ ],
+ ],
+ [
+ 'name' => 'AssignedInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'IncludeAssignedUser',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<ListOfficeSiteUsersResponse>\\n <RequestId>269BDB16-2CD8-4865-84BD-11C40BC21DB0</RequestId>\\n <Users>\\n <EndUser>Alice</EndUser>\\n </Users>\\n</ListOfficeSiteUsersResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SubDomainName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the subdomain in the enterprise AD domain.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'childexample.com',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DnsAddress',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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.*.*',
+ ],
+ 'required' => false,
+ 'example' => '127.0.*.*',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ '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.*.*',
+ ],
+ 'required' => false,
+ 'example' => '127.0.*.*',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => 'oldad.com/Domain Controllers',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BackupDCHostname',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The hostname of the secondary domain controller.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dc002',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyADConnectorOfficeSiteResponse>\\r\\n <RequestId>3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF</RequestId>\\r\\n</ModifyADConnectorOfficeSiteResponse>","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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ 'name' => 'MfaEnabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable 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' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise AD office network.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+dir-778418****',
+ ],
+ ],
+ [
+ 'name' => 'TrustKey',
+ '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',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'password123***',
+ ],
+ ],
+ [
+ 'name' => 'RdsLicenseDomain',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfigADConnectorTrustResponse>\\r\\n <RequestId>ECFA4A91-136C-5A58-9C77-858A84D60032</RequestId>\\r\\n</ConfigADConnectorTrustResponse>","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' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region.'."\n",
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the AD workspace.'."\n",
+ 'example' => 'cn-hangzhou+dir-778418****',
+ 'required' => true,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'OUName',
+ '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,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DomainUserName',
+ '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,
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DomainPassword',
+ '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,
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ 'type' => 'string',
+ ],
+ ],
+ 'type' => 'object',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfigADConnectorUserResponse>\\r\\n <RequestId>BB4B415B-A9CA-5A13-8E52-D6D3C24BE140</RequestId>\\r\\n</ConfigADConnectorUserResponse>","errorExample":""}]',
+ 'extraInfo' => ' ',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'title' => 'ConfigADConnectorUser',
+ ],
+ 'CreateADConnectorDirectory' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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' => 'DomainName',
+ '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",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'corp.example.com',
+ ],
+ ],
+ [
+ 'name' => 'DomainUserName',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DomainPassword',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryName',
+ '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",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'testDirectoryName',
+ ],
+ ],
+ [
+ '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"
+ .'* <!-- -->'."\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' => 'To grant the local administrator permission [Default]',
+ 'false' => 'Not to grant the local administrator permission',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ [
+ '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"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SubDomainName',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'MfaEnabled',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => 'To enable MFA',
+ 'false' => 'To disable MFA [Default]',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'DnsAddress',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'VSwitchId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'SubDomainDnsAddress',
+ '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.**.**',
+ ],
+ 'required' => false,
+ 'example' => '127.0.**.**',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Specification',
+ 'in' => 'query',
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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.**.**',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<CreateADConnectorDirectoryResponse>\\n <TrustPassword>82Tg****</TrustPassword>\\n <DirectoryId>cn-hangzhou+dir-gx2x1dhsmu52rd****</DirectoryId>\\n <RequestId>3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF</RequestId>\\n <AdConnectors>\\n <Address>127.0.**.**</Address>\\n </AdConnectors>\\n</CreateADConnectorDirectoryResponse>","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' => [],
+ ],
+ ],
+ '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' => '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',
+ ],
+ ],
+ [
+ 'name' => 'EnableInternetAccess',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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"
+ .'* <!-- -->'."\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 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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'VPC' => '',
+ 'Internet' => '',
+ 'Any' => '',
+ ],
+ 'example' => 'Internet',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ 'required' => true,
+ 'maxItems' => 20,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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' => 'DirectoryType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'SIMPLE' => '',
+ 'AD_CONNECTOR' => '',
+ ],
+ 'example' => 'RAM',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The directory status. This parameter is equivalent to `Status`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'REGISTERED',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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' => 'DirectoryId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ '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****',
+ ],
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeDirectoriesResponse>\\n <Directories>\\n <Status>REGISTERING</Status>\\n <DomainName>example.com</DomainName>\\n <CustomSecurityGroupId>sg-bp1ce64o4g9mdf5u****</CustomSecurityGroupId>\\n <Name>testDirectoryName</Name>\\n <DirectoryType>RAM</DirectoryType>\\n <DomainPassword>testPassword</DomainPassword>\\n <TrustPassword>82Tg****</TrustPassword>\\n <DirectoryId>cn-hangzhou+dir-gx2x1dhsmu52rd****</DirectoryId>\\n <DesktopVpcEndpoint>http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com</DesktopVpcEndpoint>\\n <VpcId>vpc-uf6tz5k67puge5jn8****</VpcId>\\n <CreationTime>2020-11-02T01:44Z</CreationTime>\\n <DesktopAccessType>Internet</DesktopAccessType>\\n <DomainUserName>sAMAccountName</DomainUserName>\\n <EnableInternetAccess>false</EnableInternetAccess>\\n <DnsUserName>testDnsUserName</DnsUserName>\\n </Directories>\\n <Directories>\\n <ADConnectors>\\n <ADConnectorAddress>172.17.**.**</ADConnectorAddress>\\n <NetworkInterfaceId>eni-bp1i4wx78lgosrj6****</NetworkInterfaceId>\\n <ConnectorStatus>RUNNING</ConnectorStatus>\\n <VSwitchId>vsw-bp19ocz3erfx15uon****</VSwitchId>\\n </ADConnectors>\\n <Logs>\\n <Level>INFO</Level>\\n <Step>DescribeDirectories</Step>\\n <Message>code:success | message:Create Connector complete.</Message>\\n <TimeStamp>2021-01-22T06:45Z</TimeStamp>\\n </Logs>\\n </Directories>\\n <Directories>\\n <VSwitchIds>vsw-bp19ocz3erfx15uon****</VSwitchIds>\\n <DnsAddress>[\\"171.17.**.**\\"]</DnsAddress>\\n </Directories>\\n <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n</DescribeDirectoriesResponse>","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',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'OUPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The organizational unit (OU) in the specified AD domain.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'example.com/Domain Controllers',
+ ],
+ ],
+ [
+ 'name' => 'AssignedInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available. The value can be 1 or left empty.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'asc',
+ ],
+ ],
+ [
+ 'name' => 'IncludeAssignedUser',
+ 'in' => 'query',
+ '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' => '[email protected]',
+ ],
+ 'Phone' => [
+ 'description' => 'The mobile number.',
+ 'type' => 'string',
+ 'example' => '130********',
+ ],
+ 'DisplayNameNew' => [
+ 'type' => 'string',
+ ],
+ 'UserPrincipalName' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]\\",\\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',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the directory.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd**** ',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the AD directory.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testDirectoryName ',
+ ],
+ ],
+ [
+ 'name' => 'SubDomainName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The domain name of the existing AD subdomain.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'childexample.com ',
+ ],
+ ],
+ [
+ 'name' => 'MfaEnabled',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => 'true',
+ 'false' => 'false',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'DnsAddress',
+ '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' => false,
+ 'example' => '127.0.**.** ',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'SubDomainDnsAddress',
+ '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.**.** ',
+ ],
+ 'required' => false,
+ 'example' => '127.0.**.** ',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyADConnectorDirectoryResponse>\\r\\n <RequestId>3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF</RequestId>\\r\\n</ModifyADConnectorDirectoryResponse>","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',
+ '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' => 'DirectoryId',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD313427\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDirectoriesResponse>\\r\\n <RequestId>5CC5E450-FC43-4F5B-B540-9964BD313427</RequestId>\\r\\n</DeleteDirectoriesResponse>","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',
+ ],
+ ],
+ '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' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer pool.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dg-boyczi8enfyc5****',
+ ],
+ ],
+ [
+ 'name' => 'BundleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'b-je9hani001wfn****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopName',
+ 'in' => 'query',
+ 'schema' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'To be hidden.',
+ ],
+ ],
+ [
+ 'name' => 'VpcId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'To be hidden.',
+ ],
+ ],
+ [
+ 'name' => 'Amount',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'To be hidden.',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'system-all-enabled-policy',
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit of the subscription duration.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'Month' => '',
+ 'Year' => '',
+ ],
+ 'example' => 'Month',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable automatic payment.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the sales promotion.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '23141',
+ ],
+ ],
+ [
+ 'name' => 'UserAssignMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Hostname',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DesktopNameSuffix',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'VolumeEncryptionEnabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable disk encryption.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopMemberIp',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The private IP address of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '10.0.0.1',
+ ],
+ ],
+ [
+ 'name' => 'UserCommands',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'BundleModels',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The cloud computer templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The desktop template that you want to use.'."\n",
+ '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****',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'DesktopTimers',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The details of the scheduled task on cloud computers.'."\n",
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'SubnetId',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'MonthDesktopSetting',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'SnapshotPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the auto-snapshot policy.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sp-28mp6my0l6zow****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the resource group.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-3mtuc28rx95lx****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopAttachment',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'TimerGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the timer group.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ccg-0caoeogrk9m5****',
+ ],
+ ],
+ [
+ 'name' => 'SavingPlanId',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'description' => 'The ID of the saving plan.',
+ 'example' => 'spn-4b945dc4Wktd****',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ExtendInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AppRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'QosRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ChannelCookie',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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****"]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CreateDesktopsResponse>\\n <OrderId>123456789</OrderId>\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\n <DesktopId>[\\"ecd-gx2x1dhsmucyy****\\"]</DesktopId>\\n</CreateDesktopsResponse>","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' => ' ',
+ ],
+ '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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '133183',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsOD038K',
+ ],
+ ],
+ '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,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ '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 regions supported by Elastic Desktop Service.',
+ '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 the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '["ecd-gx2x1dhsmucyy****"]',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'NeedExtraInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '52826',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsENR35V',
+ ],
+ ],
+ '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' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer pool.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dg-boyczi8enfyc5****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopStatus',
+ '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',
+ ],
+ ],
+ [
+ '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,
+ 'docRequired' => false,
+ 'maximum' => '1000',
+ 'minimum' => '1',
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'UserName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the end user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Alice',
+ ],
+ ],
+ [
+ 'name' => 'DesktopName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testDesktopName',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The directory ID, which is the same as the office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ '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' => 'testName',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'system-all-enabled-policy',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'PostPaid',
+ ],
+ ],
+ [
+ '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:59:59Z',
+ ],
+ ],
+ [
+ 'name' => 'ProtocolType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The authorized user of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'alice',
+ ],
+ 'required' => false,
+ 'example' => 'alice',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ExcludedEndUserId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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',
+ ],
+ 'required' => false,
+ 'example' => 'andy',
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ManagementFlag',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The flag that is used to manage the cloud desktops.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Migrating' => '',
+ 'Updating' => '',
+ 'NoFlag' => '',
+ ],
+ 'example' => 'NoFlag',
+ ],
+ ],
+ [
+ 'name' => 'QueryFotaUpdate',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ '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",
+ '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",
+ '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",
+ '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',
+ 'required' => false,
+ 'example' => 'TestValue',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'SnapshotPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the snapshot policy.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sp-hb12mclyne09xw***',
+ ],
+ ],
+ [
+ 'name' => 'OnlyDesktopGroup',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query pooled cloud computers.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ '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',
+ 'required' => false,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'OsTypes',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The operating systems (OSs).'."\n",
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ 'name' => 'DesktopType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer type. You can call the [DescribeDesktopTypes](~~188882~~) operation to query the IDs of all supported types.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'eds.general.2c8g',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ '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****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'DesktopStatusList',
+ 'in' => 'query',
+ 'allowEmptyValue' => false,
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of cloud computer status.'."\n",
+ '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',
+ ],
+ 'example' => 'Stopped',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ 'name' => 'GpuInstanceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the elastic GPU pool.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'gp-0bm2iz1v6m6nx****',
+ ],
+ ],
+ [
+ 'name' => 'QosRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the network throttling rule.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qos-5605u0gelk200****',
+ ],
+ ],
+ [
+ 'name' => 'SubPayType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'duration' => '',
+ 'postPaid' => '',
+ 'monthPackage' => '',
+ 'prePaid' => '',
+ ],
+ 'example' => 'monthPackage',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise resource group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-4hsvzbbmqdzu3s****',
+ ],
+ ],
+ [
+ 'name' => 'FillResourceGroup',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query the information about the enterprise resource group.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ '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 returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'IncludeAutoSnapshotPolicy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ '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 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',
+ ],
+ 'Desktops' => [
+ 'description' => 'The cloud computers.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeDesktopsResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TotalCount>1</TotalCount>\\n <Desktops>\\n <CreationTime>2020-11-06T08:28Z</CreationTime>\\n <ChargeType>PostPaid</ChargeType>\\n <DesktopName>testDesktopName</DesktopName>\\n <PolicyGroupName>test</PolicyGroupName>\\n <SystemDiskSize>0</SystemDiskSize>\\n <PolicyGroupId>system-all-enabled-policy</PolicyGroupId>\\n <DesktopStatus>Running</DesktopStatus>\\n <DesktopType>ecd.basic.large</DesktopType>\\n <GpuCount>1</GpuCount>\\n <ProtocolType>HDX</ProtocolType>\\n <Memory>4096</Memory>\\n <GpuSpec>NVIDIA T4</GpuSpec>\\n <ImageId>m-4zfb6zj728hhr****</ImageId>\\n <DirectoryId>cn-hangzhou+dir-363353****</DirectoryId>\\n <ManagementFlag>NoFlag</ManagementFlag>\\n <DataDiskCategory>null</DataDiskCategory>\\n <SystemDiskCategory>null</SystemDiskCategory>\\n <NetworkInterfaceId>123456</NetworkInterfaceId>\\n <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>\\n <DataDiskSize>null</DataDiskSize>\\n <DesktopGroupId>null</DesktopGroupId>\\n <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>\\n <OfficeSiteName>test</OfficeSiteName>\\n <DirectoryType>SIMPLE</DirectoryType>\\n <OfficeSiteVpcType>basic</OfficeSiteVpcType>\\n <StartTime>2020-11-06T08:31Z</StartTime>\\n <Cpu>2</Cpu>\\n <NetworkInterfaceIp>192.168.74.165</NetworkInterfaceIp>\\n <ExpiredTime>2021-12-31T15:59Z</ExpiredTime>\\n <OsType>Windows</OsType>\\n <ConnectionStatus>Disconnected</ConnectionStatus>\\n <BundleId>b-2g65ljy4291vl****</BundleId>\\n <BundleName>Name</BundleName>\\n <OfficeSiteType>SIMPLE</OfficeSiteType>\\n <HostName>testName</HostName>\\n <Disks>\\n <DiskType>SYSTEM</DiskType>\\n <DiskId>d-jedbpr4sl9l37****</DiskId>\\n <DiskSize>80</DiskSize>\\n <PerformanceLevel>PL0</PerformanceLevel>\\n </Disks>\\n <Tags>\\n <Key>TestKey</Key>\\n <Value>TestValue</Value>\\n </Tags>\\n <Sessions>\\n <EndUserId>29615820929547****</EndUserId>\\n <EstablishmentTime>2021-03-07T08:23Z</EstablishmentTime>\\n <ExternalUserName>Testname</ExternalUserName>\\n </Sessions>\\n <EndUserIds>Alice</EndUserIds>\\n <DowngradeQuota>3</DowngradeQuota>\\n <DowngradedTimes>0</DowngradedTimes>\\n <GpuCategory>0</GpuCategory>\\n <GpuDriverVersion>null</GpuDriverVersion>\\n <ZoneType>AvailabilityZone</ZoneType>\\n <FotaUpdate>\\n <NewTaskUid>t-bp198jigq7l0h5ac****</NewTaskUid>\\n <CurrentAppVersion>0.0.0-D-20220102.000000</CurrentAppVersion>\\n <NewAppVersion>0.0.0-R-20220307.190736</NewAppVersion>\\n <ReleaseNote>测试升级包03-07</ReleaseNote>\\n <Size>108815097</Size>\\n </FotaUpdate>\\n <Progress>100%</Progress>\\n <Platform>Ubuntu</Platform>\\n </Desktops>\\n</DescribeDesktopsResponse>","errorExample":""}]',
+ 'title' => 'DescribeDesktops',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeDesktopTypes' => [
+ 'summary' => 'Queries the instance types of cloud computers.',
+ '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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopTypeId',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'InstanceTypeFamily',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CpuCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of vCPUs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'MemorySize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The memory size. Unit: MiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '4',
+ ],
+ ],
+ [
+ 'name' => 'GpuCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of GPUs.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'DesktopIdForModify',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'OrderType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The order type.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'DOWNGRADE' => '',
+ 'UPGRADE' => '',
+ ],
+ 'example' => 'DOWNGRADE',
+ ],
+ ],
+ [
+ 'name' => 'AppliedScope',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Applicable Scope of specifications. Default value: `Public`',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Public' => 'Public',
+ 'SavingPlan' => 'SavingPlan',
+ ],
+ 'example' => 'Public',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupIdForModify',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dg-abcdefg****',
+ ],
+ ],
+ [
+ 'name' => 'GpuDriverType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GPU driver type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* T4'."\n"
+ .'* A10'."\n"
+ .'* G28'."\n"
+ .'* G39'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'T4' => 'T4',
+ 'A10' => 'A10',
+ 'G28' => 'G28',
+ 'G39' => 'G39',
+ ],
+ 'example' => 'A10',
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Memory' => 'Memory',
+ 'Cpu' => 'Cpu',
+ ],
+ 'example' => 'Memory',
+ ],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sorting order.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ASC (default): the ascending order.'."\n"
+ .'* DESC: the descending order.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'ASC' => 'ASC',
+ 'DESC' => 'DESC',
+ ],
+ 'example' => 'ASC',
+ ],
+ ],
+ [
+ 'name' => 'Scope',
+ 'in' => 'query',
+ 'schema' => [
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'MonthPackage' => 'MonthPackage',
+ 'FastBuy' => 'FastBuy',
+ ],
+ 'example' => 'FastBuy',
+ ],
+ ],
+ [
+ 'name' => 'DesktopTypeIdList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The specification IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The specification ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'eds.enterprise.4c8g',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'SupportMinSessionCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of sessions supported by the specification.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'ZoneId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'null',
+ ],
+ ],
+ [
+ 'name' => 'GpuMemory',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'description' => 'The GPU memory size. Unit: MB.',
+ 'example' => '2048',
+ ],
+ ],
+ [
+ 'name' => 'ScopeSet',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ 'DesktopTypes' => [
+ 'description' => 'The specifications.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeDesktopTypesResponse>\\n<RequestId>FE1810C7-09DA-4224-A8DC-5110954FD47F</RequestId>\\n<DesktopTypes>\\n <MemorySize>95232</MemorySize>\\n <CpuCount>24</CpuCount>\\n <DesktopTypeId>eds.graphics.24c1t4</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>eds.graphics</InstanceTypeFamily>\\n <GpuSpec>16 GiB</GpuSpec>\\n <GpuCount>1</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>63488</MemorySize>\\n <CpuCount>16</CpuCount>\\n <DesktopTypeId>eds.graphics.16c1t4</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>eds.graphics</InstanceTypeFamily>\\n <GpuSpec>16 GiB</GpuSpec>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>1</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>24576</MemorySize>\\n <CpuCount>12</CpuCount>\\n <DesktopTypeId>eds.hf.12c24g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.hf</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>16384</MemorySize>\\n <CpuCount>8</CpuCount>\\n <DesktopTypeId>eds.hf.8c16g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.hf</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>8192</MemorySize>\\n <CpuCount>4</CpuCount>\\n <DesktopTypeId>eds.hf.4c8g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.hf</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>32768</MemorySize>\\n <CpuCount>16</CpuCount>\\n <DesktopTypeId>eds.general.16c32g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>32768</MemorySize>\\n <CpuCount>8</CpuCount>\\n <DesktopTypeId>eds.general.8c32g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>16384</MemorySize>\\n <CpuCount>8</CpuCount>\\n <DesktopTypeId>eds.general.8c16g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>16384</MemorySize>\\n <CpuCount>4</CpuCount>\\n <DesktopTypeId>eds.general.4c16g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>8192</MemorySize>\\n <CpuCount>4</CpuCount>\\n <DesktopTypeId>eds.general.4c8g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>8192</MemorySize>\\n <CpuCount>2</CpuCount>\\n <DesktopTypeId>eds.general.2c8g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>4096</MemorySize>\\n <CpuCount>2</CpuCount>\\n <DesktopTypeId>eds.general.2c4g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>2048</MemorySize>\\n <CpuCount>2</CpuCount>\\n <DesktopTypeId>eds.general.2c2g</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>eds.general</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>50</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>47104</MemorySize>\\n <CpuCount>10</CpuCount>\\n <DesktopTypeId>ecd.graphics.2xlarge</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>ecd.graphics</InstanceTypeFamily>\\n <GpuSpec>8 GiB</GpuSpec>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0.5</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>23552</MemorySize>\\n <CpuCount>4</CpuCount>\\n <DesktopTypeId>ecd.graphics.xlarge</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>ecd.graphics</InstanceTypeFamily>\\n <GpuSpec>4 GiB</GpuSpec>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0.25</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>32768</MemorySize>\\n <CpuCount>8</CpuCount>\\n <DesktopTypeId>ecd.performance.2xlarge</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>ecd.performance</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>16384</MemorySize>\\n <CpuCount>4</CpuCount>\\n <DesktopTypeId>ecd.advanced.xlarge</DesktopTypeId>\\n <SystemDiskSize>150</SystemDiskSize>\\n <InstanceTypeFamily>ecd.advanced</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>150</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>8192</MemorySize>\\n <CpuCount>2</CpuCount>\\n <DesktopTypeId>ecd.advanced.large</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>ecd.advanced</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>70</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>4096</MemorySize>\\n <CpuCount>2</CpuCount>\\n <DesktopTypeId>ecd.basic.large</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>ecd.basic</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>70</DataDiskSize>\\n</DesktopTypes>\\n<DesktopTypes>\\n <MemorySize>2048</MemorySize>\\n <CpuCount>1</CpuCount>\\n <DesktopTypeId>ecd.basic.small</DesktopTypeId>\\n <SystemDiskSize>80</SystemDiskSize>\\n <InstanceTypeFamily>ecd.basic</InstanceTypeFamily>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>20</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>80</SystemDiskSize>\\n <DataDiskSize>70</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>100</DataDiskSize>\\n </AllowDiskSize>\\n <AllowDiskSize>\\n <SystemDiskSize>150</SystemDiskSize>\\n <DataDiskSize>150</DataDiskSize>\\n </AllowDiskSize>\\n <GpuCount>0</GpuCount>\\n <DataDiskSize>20</DataDiskSize>\\n</DesktopTypes>\\n</DescribeDesktopTypesResponse>","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.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DescribeCustomizedListHeaders' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'GroupId',
+ '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***',
+ ],
+ ],
+ [
+ 'name' => 'DesktopStatus',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer.'."\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' => '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',
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'PostPaid',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'LangType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'zh-CN' => '',
+ 'en-GB' => '',
+ ],
+ 'example' => '`zh-CN`',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ '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",
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of response.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'ExportDesktop.UnknowError',
+ 'errorMessage' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.',
+ ],
+ ],
+ ],
+ '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":"<ExportDesktopListInfoResponse>\\n <Url>https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********</Url>\\n <RequestId>D3DFB159-0FAD-5C96-9E1F-DDBF15534B71</RequestId>\\n</ExportDesktopListInfoResponse>","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",
+ ],
+ 'StartDesktops' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","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',
+ '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 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,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '101AE027-8299-5E6E-A782-6C91C962****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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' => 'DesktopId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '6557DBA9-CF3E-5C1B-B1F1-68FDA599****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'StoppedMode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The billing mode after you stop the cloud computer.'."\n"
+ ."\n"
+ .'Default value: StopCharging. Valid values:'."\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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'StopCharging' => '',
+ 'KeepCharging' => '',
+ ],
+ 'example' => 'StopCharging',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'OsUpdate',
+ '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",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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,
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'OsUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RebootDesktopsResponse>\\r\\n <RequestId>8F851208-C0EA-4CDD-9074-DBE70CB430DA</RequestId>\\r\\n</RebootDesktopsResponse>","errorExample":""}]',
+ 'title' => 'RebootDesktops',
+ 'summary' => 'Restart cloud computers.',
+ 'description' => 'The cloud computers that you want to restart must be in the Running state.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RebuildDesktops' => [
+ '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](~~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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<RebuildDesktopsResponse>\\n <RebuildResults>\\n <Message>The current status of the desktop does not support this operation.</Message>\\n <DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>\\n <Code>IncorrectDesktopStatus</Code>\\n </RebuildResults>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n</RebuildDesktopsResponse>","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' => ' ',
+ ],
+ 'SetDesktopMaintenance' => [
+ 'summary' => 'Set the cloud computer maintenance mode.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => 'Mode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopIds',
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the cloud computer for which you want to set maintenance mode.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-dzeotbgawdnfo****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'BA6A1853-3EA9-5EEB-86C8-3D14A3E01905',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDesktopNameResponse>\\r\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\r\\n</ModifyDesktopNameResponse>","errorExample":""}]',
+ 'title' => 'ModifyDesktopName',
+ 'summary' => 'Changes the name of a cloud computer to a new name.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyDiskSpec' => [
+ 'summary' => 'Changes the performance level (PL) of a system disk or data disk.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ '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' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ecd-2yjhqxo1monxxxxxx',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskPerformanceLevel',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'PL1' => 'PL1',
+ 'PL0' => 'PL0',
+ 'PL3' => 'PL3',
+ 'PL2' => 'PL2',
+ ],
+ 'example' => 'PL1',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskPerformanceLevel',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'PL1' => 'PL1',
+ 'PL0' => 'PL0',
+ 'PL3' => 'PL3',
+ 'PL2' => 'PL2',
+ ],
+ 'example' => 'PL1',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'youhuiquan_promotion_option_id_for_blank',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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"
+ ."\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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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',
+ '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' => 'ChargeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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"
+ ."\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',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit of the subscription duration if you specify subscription as the new billing method for the cloud desktop.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Month' => '',
+ 'Year' => '',
+ 'Week' => '',
+ ],
+ 'example' => 'Month',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the promotional activity.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '500038360030606',
+ ],
+ ],
+ [
+ 'name' => 'UseDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is in invitational preview and not publicly available.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => 'internal only',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ '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',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'DesktopId' => [
+ 'description' => 'The IDs of the cloud computers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '["ecd-gx2x1dhsmucyy****"]',
+ ],
+ ],
+ 'TaskId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of a cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'ecd-4543qyik164a4****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopType',
+ '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",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'eds.general.2c8g',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskSizeGib',
+ '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",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '32768',
+ 'minimum' => '0',
+ 'example' => '80',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskSizeGib',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '65536',
+ 'minimum' => '0',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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"
+ ."\n"
+ .' <!-- -->',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskPerformanceLevel',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'PL1' => 'PL1',
+ 'PL0' => 'PL0',
+ 'PL3' => 'PL3',
+ 'PL2' => 'PL2',
+ ],
+ 'example' => 'PL0',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the promotional activity.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '500033080110596',
+ ],
+ ],
+ [
+ 'name' => 'ResourceSpecs',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The array of resource specification templates.',
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource type.'."\n"
+ ."\n"
+ .'> This parameter is optional for non-subscribed cloud computers.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'DesktopMonthPackage' => 'DesktopMonthPackage',
+ ],
+ 'example' => 'DesktopMonthPackage',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DesktopTimers',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The details of the scheduled task on cloud computers.'."\n",
+ '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"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'NoOperationDisconnect' => '',
+ 'LogoutShutdown' => '',
+ 'NoConnect' => '',
+ 'TimerBoot' => '',
+ 'TimerReset' => '',
+ 'LoginAutoConnect' => '',
+ 'NoOperationShutdown' => '',
+ 'TimerShutdown' => '',
+ 'NoOperationReboot' => '',
+ 'TimerReboot' => '',
+ ],
+ 'example' => 'TimerBoot',
+ ],
+ '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",
+ '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',
+ ],
+ '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",
+ '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',
+ ],
+ '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' => '',
+ 'Shutdown' => '',
+ ],
+ 'example' => 'Shutdown',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'UseDesktopTimers',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to use the `DesktopTimers`** parameter. Set the value to `true`**.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'NewHostName',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ListType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the list.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* desktop: cloud computer'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'desktop' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ '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',
+ ],
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ ],
+ ],
+ ],
+ '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' => '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',
+ '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-shanghai',
+ ],
+ ],
+ [
+ 'name' => 'TargetOfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the destination office network.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-shenzhen+dir-388505****',
+ ],
+ ],
+ [
+ '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-39clsqyxr****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'E46DECEC-AC72-570E-958B-B52A4B****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'ChooseClusterError.ZoneId',
+ 'errorMessage' => 'Cannot choose zone, please try other zone.',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ ],
+ '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' => 'Period',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit of the renewal duration specified by the `Period` parameter.'."\n"
+ ."\n"
+ .'Default value: Month. Valid values:'."\n"
+ ."\n"
+ .'* Month'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Year'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20844399755****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RenewDesktopsResponse>\\n <RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB</RequestId>\\n <OrderId>20844399755****</OrderId>\\n</RenewDesktopsResponse>","errorExample":""}]',
+ 'title' => 'RenewDesktops',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeleteDesktops' => [
+ 'summary' => 'Releases pay-as-you-go cloud computers or expired subscription cloud computers.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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,
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteDesktops',
+ ],
+ 'DescribeDesktopMetadata' => [
+ 'summary' => 'Queries the list and metadata of cloud computers in a specific region.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai',
+ ],
+ ],
+ [
+ 'name' => 'SearchRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-778418****',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dg-i1ruuudp92qpj****',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd',
+ 'maxLength' => 100,
+ ],
+ ],
+ [
+ 'name' => 'CreationTimeStart',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2025-01-01T12:00:00Z',
+ ],
+ ],
+ [
+ 'name' => 'OperationTimeStart',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2025-01-01T12:00:00Z',
+ ],
+ ],
+ [
+ 'name' => 'IncludeDesktopGroup',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-84mztzatmipf2****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'HostName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '主机名称',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ASW-2F-SRV-YXYZ-4.SHPTG',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => true,
+ 'docRequired' => true,
+ 'example' => 'ecd-gq8u6whi9f6k8****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ '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' => 'EndUserId',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the current end user of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Ab123456',
+ ],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer connection task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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****',
+ ],
+ ],
+ [
+ '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' => '28c80e90-f71e-4c23-93d6-1225329cf949',
+ ],
+ ],
+ [
+ '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"
+ .'* 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"
+ .'}',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* FINISHED: The credential is obtained.'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\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"
+ ."\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********',
+ ],
+ '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****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ecd-asw3giklqvfqe****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'demo001',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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' => '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,
+ ],
+ ],
+ [
+ 'name' => 'AuthorizeDesktopId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'RevokeDesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the cloud computers whose end users you want to remove.'."\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****',
+ ],
+ 'required' => false,
+ 'docRequired' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ecd-7w78ozhjcwa3u****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'required' => false,
+ 'example' => 'alice',
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyEntitlementResponse>\\n <RequestId>8F851208-C0EA-4CDD-9074-DBE70CB430DA</RequestId>\\n</ModifyEntitlementResponse>","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',
+ ],
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'MaxUserPerDesktop',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'description' => 'The number of users assigned to each cloud computer.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '500',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'MaxDesktopPerUser',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'description' => 'The number of cloud computers allocated to each user.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => true,
+ 'maximum' => '500',
+ 'example' => '0',
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'example' => 'AVERAGE',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'Preview',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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](~~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****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the office network.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'pg-9c2d6t2dwflqr****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupName',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DefaultInitDesktopCount',
+ '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',
+ 'required' => false,
+ 'maximum' => '1000',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'KeepDuration',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The billing method of the shared group.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* PostPaid: pay-as-you-go.'."\n"
+ .'* PrePaid: subscription.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'PostPaid' => '',
+ 'PrePaid' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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"
+ ."\n"
+ .'* If you set `PeriodUnit` to `Year`, valid values of this parameter:'."\n"
+ ."\n"
+ .' * 1'."\n"
+ .' * 2'."\n"
+ .' * 3'."\n"
+ .' * 4'."\n"
+ .' * 5'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit of the subscription duration.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'Month' => '',
+ 'Year' => '',
+ ],
+ 'example' => 'Month',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to automatically complete the payment for subscription orders.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'Comments',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks of the shared group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'MinDesktopsCount',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'MaxDesktopsCount',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AllowAutoSetup',
+ 'in' => 'query',
+ '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' => [
+ '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ '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' => 'alice',
+ ],
+ 'required' => false,
+ 'maxItems' => 1000,
+ ],
+ ],
+ [
+ 'name' => 'ResetType',
+ 'in' => 'query',
+ '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' => [
+ '',
+ '',
+ '',
+ '',
+ ],
+ 'example' => '0',
+ ],
+ ],
+ [
+ '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' => [
+ '',
+ '',
+ ],
+ 'example' => '0',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Classify',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AllClassifyUsers',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The types of the users.'."\n"
+ ."\n"
+ .'> This parameter is not publicly available.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'Alice',
+ ],
+ ],
+ [
+ 'name' => 'VolumeEncryptionEnabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable disk encryption.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ConnectDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'IdleDisconnectDuration',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'StopDuration',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'BuyDesktopsCount',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'GroupVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version of the shared group.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The tags. You can specify up to 20 tags.'."\n",
+ '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,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the coupon.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'youhuiquan_promotion_option_id_*****',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'cloud_auto',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SystemDiskPerLevel',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DataDiskCategory',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DataDiskSize',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'example' => 'PL0',
+ ],
+ ],
+ [
+ 'name' => 'DefaultLanguage',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ 'name' => 'DesktopType',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Hostname',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'example' => 'testhost',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'GroupAmount',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SessionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the session.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* SingleSession'."\n"
+ .'* MultipleSession'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SingleSession' => '',
+ 'MultipleSession' => '',
+ ],
+ 'example' => 'SingleSession',
+ ],
+ ],
+ [
+ 'name' => 'TimerGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the timer group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ccg-0caoeogrk9m5****',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotPolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sp-28mp6my0l6zow****',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserOuPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SimpleUserGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DeleteDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the shared group.'."\n",
+ 'type' => 'string',
+ 'example' => '[\'dg-1np2yupx0uim****\']',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'headers' => [],
+ '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' => [
+ '',
+ '',
+ ],
+ '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',
+ ],
+ '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' => [
+ '',
+ '',
+ ],
+ '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' => '',
+ ],
+ '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 => '',
+ '',
+ '',
+ ],
+ '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 => '',
+ '',
+ '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ 'Forced' => [
+ 'description' => 'Indicates whether the scheduled task is forcibly executed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ ],
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'PolicyGroupIds' => [
+ 'description' => 'The IDs of the applied policies.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'pd-abcd***',
+ ],
+ ],
+ 'PolicyGroupNames' => [
+ 'description' => 'The names of the applied policies.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The name of the applied policy.'."\n",
+ 'type' => 'string',
+ 'example' => 'abcd',
+ ],
+ ],
+ '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' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<GetDesktopGroupDetailResponse>\\n <RequestId>1B5268CE-5EB3-545F-9F38-A8BCF7105777</RequestId>\\n <Desktops>\\n <CreationTime>2022-02-17T14:51:07Z</CreationTime>\\n <PayType>PrePaid</PayType>\\n <PolicyGroupName>test-policy</PolicyGroupName>\\n <Creator>1007214305******</Creator>\\n <MaxDesktopsCount>10</MaxDesktopsCount>\\n <AllowAutoSetup>1</AllowAutoSetup>\\n <ResType>0</ResType>\\n <SystemDiskSize>80</SystemDiskSize>\\n <PolicyGroupId>pg-53iyi2aar0nd6****</PolicyGroupId>\\n <OwnBundleId>bundle_eds_general_4c8g_s8d5_win2019</OwnBundleId>\\n <GpuCount>1</GpuCount>\\n <AllowBufferCount>0</AllowBufferCount>\\n <Memory>16384</Memory>\\n <GpuSpec>16 GiB</GpuSpec>\\n <DirectoryId>cn-hangzhou+dir-adde******</DirectoryId>\\n <OwnBundleName>test</OwnBundleName>\\n <DataDiskCategory>cloud_ssd</DataDiskCategory>\\n <DesktopGroupName>test1</DesktopGroupName>\\n <SystemDiskCategory>cloud_ssd</SystemDiskCategory>\\n <OfficeSiteId>cn-hangzhou+dir-467671****</OfficeSiteId>\\n <KeepDuration>1000</KeepDuration>\\n <MinDesktopsCount>1</MinDesktopsCount>\\n <DataDiskSize>50</DataDiskSize>\\n <DesktopGroupId>dg-2i8qxpv6t1a03****</DesktopGroupId>\\n <OfficeSiteName>testName</OfficeSiteName>\\n <DirectoryType>SIMPLE</DirectoryType>\\n <Cpu>4</Cpu>\\n <ExpiredTime>2022-03-17T16:00:00Z</ExpiredTime>\\n <Comments>test</Comments>\\n <OfficeSiteType>SIMPLE</OfficeSiteType>\\n <Status>1</Status>\\n <ResetType>0</ResetType>\\n </Desktops>\\n</GetDesktopGroupDetailResponse>","errorExample":""}]',
+ 'title' => 'GetDesktopGroupDetail',
+ ],
+ 'DescribeDesktopGroups' => [
+ 'summary' => 'Queries cloud computer shares.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ '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](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupName',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unit of the subscription duration.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'Month' => '',
+ 'Year' => '',
+ ],
+ 'example' => 'Month',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the applied policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-53iyi2aar0nd6****',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OwnType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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",
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cloud computer share.'."\n",
+ '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"
+ ."\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"
+ ."\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',
+ '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",
+ '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',
+ ],
+ '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"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ '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',
+ ],
+ '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",
+ 'type' => 'string',
+ 'example' => 'eds.enterprise_office.4c4g',
+ ],
+ 'CountPerStatus' => [
+ 'description' => 'The number of cloud computers in each state.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.'."\n",
+ '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*****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeDesktopGroupsResponse>\\n <NextToken>String\\tcaeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <DesktopGroups>\\n <CreateTime>2022-02-17T14:51:07Z</CreateTime>\\n <PayType>PrePaid</PayType>\\n <PolicyGroupName>test-policy</PolicyGroupName>\\n <Creator>1007214305******</Creator>\\n <MaxDesktopsCount>10</MaxDesktopsCount>\\n <SystemDiskSize>80</SystemDiskSize>\\n <PolicyGroupId>pg-53iyi2aar0nd6c8qj</PolicyGroupId>\\n <OwnBundleId>bundle_eds_general_4c8g_s8d5_win2019</OwnBundleId>\\n <GpuCount>1</GpuCount>\\n <Memory>16384</Memory>\\n <GpuSpec>16 GiB</GpuSpec>\\n <DirectoryId>cn-hangzhou+dir-adde******</DirectoryId>\\n <OwnBundleName>test</OwnBundleName>\\n <DataDiskCategory>cloud_ssd</DataDiskCategory>\\n <DesktopGroupName>test1</DesktopGroupName>\\n <SystemDiskCategory>cloud_ssd</SystemDiskCategory>\\n <OfficeSiteId>cn-hangzhou+dir-467671****</OfficeSiteId>\\n <KeepDuration>1000</KeepDuration>\\n <MinDesktopsCount>1</MinDesktopsCount>\\n <EndUserCount>1</EndUserCount>\\n <DataDiskSize>50</DataDiskSize>\\n <DesktopGroupId>dg-2i8qxpv6t1a03****</DesktopGroupId>\\n <OfficeSiteName>testName</OfficeSiteName>\\n <DirectoryType>SIMPLE</DirectoryType>\\n <Cpu>4</Cpu>\\n <ExpiredTime>2022-03-17T16:00:00Z</ExpiredTime>\\n <Comments>test</Comments>\\n <OfficeSiteType>SIMPLE</OfficeSiteType>\\n <Status>1</Status>\\n <ResetType>0</ResetType>\\n </DesktopGroups>\\n</DescribeDesktopGroupsResponse>","errorExample":""}]',
+ 'title' => 'DescribeDesktopGroups',
+ ],
+ 'ExportDesktopGroupInfo' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the office network.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-467671****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-53iyi2aar0nd6****',
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ ],
+ [
+ 'name' => 'ExpiredTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The expiration date of the subscription cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '2022-12-31T15:59Z',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ '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. You can specify 1 to 100 IDs of cloud computer shares.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'LangType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language of the response.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'zh-CN' => '',
+ 'en-GB' => '',
+ ],
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The tags. You can specify up to 20 tags.'."\n",
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'ExportDesktopGroup.UnknowError',
+ 'errorMessage' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.',
+ ],
+ ],
+ ],
+ '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":"<ExportDesktopGroupInfoResponse>\\n <Url>https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********</Url>\\n <RequestId>24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC</RequestId>\\n</ExportDesktopGroupInfoResponse>","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.',
+ ],
+ 'DescribeDesktopsInGroup' => [
+ 'summary' => 'Queries the cloud computers in a share 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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'PayType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The billing method of the cloud computer share.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'PostPaid' => '',
+ 'PrePaid' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The maximum number of entries per page.'."\n"
+ ."\n"
+ .'* Default value: 10.'."\n"
+ .'* Maximum value: 100.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '100',
+ '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.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'IgnoreDeleted',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to ignore deletion flags.'."\n"
+ ."\n"
+ .'Default value: true. Valid values:'."\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',
+ ],
+ ],
+ [
+ 'name' => 'CustomStartTimePeriod',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'CustomEndTimePeriod',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'PaidDesktops' => [
+ 'description' => 'The subscription cloud computers.',
+ '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"
+ ."\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 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.',
+ '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 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",
+ 'type' => 'string',
+ 'example' => '192.168.XX.XX',
+ ],
+ 'ProtocolType' => [
+ 'description' => 'The protocol.'."\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",
+ 'type' => 'string',
+ 'example' => '0.1.0-R-20220914.17****',
+ ],
+ 'ExpiredTime' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ 'PostPaidDesktops' => [
+ 'description' => 'The pay-as-you-go cloud computers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The pay-as-you-go cloud computer.'."\n",
+ '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",
+ 'type' => 'string',
+ 'example' => '0.1.0-R-20220914.17****',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeDesktopsInGroupResponse>\\n <PaidDesktops>\\n <EndUserName/>\\n <EndUserId/>\\n <DesktopName>hx-test-3</DesktopName>\\n <DesktopId>ecd-2i8qxpv6t1a04qpu1</DesktopId>\\n <ConnectionStatus>0</ConnectionStatus>\\n <DesktopStatus>Running</DesktopStatus>\\n <ManagementFlag>NoFlag</ManagementFlag>\\n </PaidDesktops>\\n <PaidDesktopsCount>1</PaidDesktopsCount>\\n <RequestId>5399F876-8F01-5767-A1FD-21F2EE3C3323</RequestId>\\n</DescribeDesktopsInGroupResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ '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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the cloud computers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-84mztzatmipf2****',
+ ],
+ 'required' => true,
+ 'maxItems' => 1000,
+ ],
+ ],
+ ],
+ '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' => '34FB4D97-C0D9-5534-ABC6-90C7EBD5****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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](~~196646~~) operation to query the regions supported by Elastic Desktop Service.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'OwnBundleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'b-7t275tpgjueeu****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the security policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'pg-53iyi2aar0nd6****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'desktopGroupName1',
+ ],
+ ],
+ [
+ 'name' => 'ScaleStrategyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the scaling policy group.'."\n"
+ ."\n"
+ .'> This parameter is unavailable.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 's-kakowkdl****',
+ ],
+ ],
+ [
+ 'name' => 'KeepDuration',
+ '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"
+ ."\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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '1000',
+ ],
+ ],
+ [
+ 'name' => 'Comments',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The remarks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'MinDesktopsCount',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'MaxDesktopsCount',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '1000',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'AllowAutoSetup',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '1',
+ 'minimum' => '0',
+ 'enumValueTitles' => [
+ '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'AllowBufferCount',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '1000',
+ 'minimum' => '0',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ResetType',
+ 'in' => 'query',
+ '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' => [
+ '',
+ '',
+ '',
+ '',
+ ],
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'LoadPolicy',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ '',
+ '',
+ ],
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'BindAmount',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The IDs of the images.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'desktopimage-windows-server-2016-64-ch',
+ ],
+ ],
+ [
+ 'name' => 'Classify',
+ '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"
+ .'* teacher: teacher-oriented.'."\n"
+ .'* student: student-oriented.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'teacher' => 'teacher',
+ 'student' => 'student',
+ ],
+ 'example' => 'teacher',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ConnectDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'IdleDisconnectDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisableSessionConfig',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to disable session management.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'StopDuration',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemId',
+ '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.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '04f314****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of policy groups.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the policy group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'BuyDesktopsCount',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DeleteDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyDesktopGroupResponse>\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\n</ModifyDesktopGroupResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'high',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'PayType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'PostPaid' => '',
+ 'PrePaid' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ ],
+ [
+ 'name' => 'ResetType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'm-4zfb6zj728hhr****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ [
+ '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-kadkdfaf****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ResetScope',
+ '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.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'ALL' => '',
+ 'IMAGE' => '',
+ ],
+ 'example' => 'ALL',
+ ],
+ ],
+ [
+ 'name' => 'LastRetryTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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 regions supported by Elastic Desktop Service.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer pool.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'ScaleTimerInfos',
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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' => '[{"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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-dbdkfmh883****',
+ ],
+ ],
+ [
+ 'name' => 'TimerType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CronExpression',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '0 0 2 ? * 1-7',
+ ],
+ ],
+ [
+ 'name' => 'ResetType',
+ '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',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to forcefully execute the scheduled task.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '388CF76E-FFB3-5174-9F91-CDD****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-fgxsniu6at****',
+ ],
+ ],
+ [
+ 'name' => 'TimerType',
+ '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 => '',
+ '',
+ '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'AC7912E7-8BDF-547F-BCAC****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ ],
+ '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' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the shared group.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-7724r1jitbjzc****',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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, and 5'."\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 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',
+ ],
+ ],
+ [
+ '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 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',
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'high',
+ 'chargeType' => 'paid',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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":"<DeleteDesktopGroupResponse>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n</DeleteDesktopGroupResponse>","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',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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 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',
+ 'required' => false,
+ 'example' => '123e4567-e89b-12d3-a456-426655440000',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the users to whom you want to grant permissions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the user to whom you want to grant permissions.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'alice',
+ ],
+ 'required' => false,
+ 'maxItems' => 10000,
+ ],
+ ],
+ [
+ '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-kadkdfaf****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'UserOuPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SimpleUserGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddUserToDesktopGroupResponse>\\n <RequestId>2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03</RequestId>\\n</AddUserToDesktopGroupResponse>","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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-8ttn55ujj8nj8****',
+ ],
+ ],
+ [
+ '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,
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the authorized user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'alice',
+ ],
+ ],
+ [
+ 'name' => 'ConnectState',
+ 'in' => 'query',
+ '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' => [
+ '',
+ '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'QueryUserDetail',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'OrgId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the organization to which the end user belongs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'org-d0fua2oyukw8j****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The authorized user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => [
+ 'description' => 'The ID of the authorized user.'."\n",
+ 'type' => 'string',
+ 'example' => 'alice',
+ ],
+ 'EndUserEmail' => [
+ 'description' => 'The email address of the authorized user.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'DesktopName' => [
+ 'description' => 'The name of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => 'testName',
+ ],
+ '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",
+ 'type' => 'string',
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ 'EndUserType' => [
+ 'description' => 'The user account type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* SIMPLE: convenience account'."\n"
+ .'* AD_CONNECTOR: enterprise Active Directory (AD) account',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'SIMPLE' => '',
+ 'AD_CONNECTOR' => '',
+ ],
+ 'example' => 'SIMPLE',
+ ],
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The seat of the end user.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'UserName' => [
+ 'description' => 'The username.'."\n",
+ 'type' => 'string',
+ 'example' => 'nameDemo',
+ ],
+ 'PropertyId' => [
+ 'description' => 'The property ID.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '123',
+ ],
+ 'PropertyKey' => [
+ 'description' => 'The property name.'."\n",
+ 'type' => 'string',
+ 'example' => 'key',
+ ],
+ 'PropertyType' => [
+ 'description' => 'The property type.'."\n"
+ ."\n"
+ .'Valid values:'."\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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'UserDesktopId' => [
+ 'description' => 'The ID of the cloud computer that is used by the user.'."\n",
+ 'type' => 'string',
+ 'example' => 'ud-i896ze8hazpvl****',
+ ],
+ 'EndUserRemark' => [
+ 'description' => 'The remarks.'."\n",
+ 'type' => 'string',
+ 'example' => 'Note',
+ ],
+ 'DisplayName' => [
+ 'description' => 'The display name of the enterprise AD account.'."\n",
+ 'type' => 'string',
+ 'example' => 'alice',
+ ],
+ 'UserPrincipalName' => [
+ 'type' => 'string',
+ ],
+ 'DisplayNameNew' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]\\",\\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":"<DescribeUsersInGroupResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>750E6E83-F9FC-528A-AE24-1FAE249B30FE</RequestId>\\n <UsersCount>1</UsersCount>\\n <OnlineUsersCount>0</OnlineUsersCount>\\n <EndUsers>\\n <EndUserId>alice</EndUserId>\\n <EndUserEmail>[email protected]</EndUserEmail>\\n <DesktopName>testName</DesktopName>\\n <ConnectionStatus>1</ConnectionStatus>\\n <DesktopId>ud-7ftf5b6yu77b0****</DesktopId>\\n <EndUserType>SIMPLE</EndUserType>\\n <EndUserPhone>1871234****</EndUserPhone>\\n <EndUserName>alice</EndUserName>\\n </EndUsers>\\n</DescribeUsersInGroupResponse>","errorExample":""}]',
+ 'title' => 'DescribeUsersInGroup',
+ ],
+ 'DescribeUserConnectionRecords' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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' => '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'SIMPLE' => '',
+ 'AD_CONNECTOR' => '',
+ ],
+ 'example' => 'SIMPLE',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ConnectDurationFrom',
+ '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',
+ 'required' => false,
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'ConnectDurationTo',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-138dsptkrt00u****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ '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',
+ ],
+ 'ConnectionRecords' => [
+ 'description' => 'The connection records.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The connection record.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ConnectionRecordId' => [
+ 'description' => 'The ID of the connection record.'."\n",
+ 'type' => 'string',
+ 'example' => '528',
+ ],
+ 'ConnectStartTime' => [
+ 'description' => 'The time when the end user connected to the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-01-19T10:12:38Z',
+ ],
+ 'DesktopName' => [
+ 'description' => 'The name of the cloud computer to which the end user connected.'."\n",
+ 'type' => 'string',
+ 'example' => 'testName',
+ ],
+ 'ConnectDuration' => [
+ 'description' => 'The connection duration. Unit: milliseconds.'."\n",
+ 'type' => 'string',
+ 'example' => '3405035000',
+ ],
+ 'ConnectEndTime' => [
+ 'description' => 'The time when the end user disconnected from the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-02-27T20:03:13Z',
+ ],
+ 'DesktopId' => [
+ 'description' => 'The ID of the cloud computer to which the end user connected.'."\n",
+ 'type' => 'string',
+ 'example' => 'ud-2hawufy3uedi1****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeUserConnectionRecordsResponse>\\n <RequestId>2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03</RequestId>\\n <ConnectionRecords>\\n <ConnectionRecordId>528</ConnectionRecordId>\\n <ConnectStartTime>2022-01-19T10:12:38Z</ConnectStartTime>\\n <DesktopName>testName</DesktopName>\\n <ConnectDuration>3405035000</ConnectDuration>\\n <ConnectEndTime>2022-02-27T20:03:13Z</ConnectEndTime>\\n <DesktopId>ud-2hawufy3uedi1****</DesktopId>\\n </ConnectionRecords>\\n</DescribeUserConnectionRecordsResponse>","errorExample":""}]',
+ 'title' => 'DescribeUserConnectionRecords',
+ 'summary' => 'Queries the connection records of an authorized user to cloud computers in a cloud computer pool.',
+ ],
+ 'ModifyUserToDesktopGroup' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'OldEndUserIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'NewEndUserIds',
+ '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,
+ ],
+ ],
+ ],
+ '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":"<ModifyUserToDesktopGroupResponse>\\n <RequestId>CFC74699-6F9C-5437-861A-D186E3347B7E</RequestId>\\n</ModifyUserToDesktopGroupResponse>","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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'dg-2i8qxpv6t1a03****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ '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,
+ ],
+ ],
+ [
+ '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-kadkdfaf****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'UserOuPath',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'SimpleUserGroupId',
+ '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":"<RemoveUserFromDesktopGroupResponse>\\n <RequestId>CFC74699-6F9C-5437-861A-D186E3347B7E</RequestId>\\n</RemoveUserFromDesktopGroupResponse>","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"
+ ."\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"
+ ."\n"
+ .'* Valid value when the `PayType` parameter is set to `PrePaid`:'."\n"
+ ."\n"
+ .' * PayByBandwidth: charges by fixed bandwidth.'."\n"
+ ."\n"
+ .'* Valid values when the `PayType` parameter is set to `PostPaid`:'."\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"
+ ."\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"
+ .'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"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Month'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Year'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Week'."\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"
+ .'* 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' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable auto-renewal for the premium bandwidth plan.'."\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' => 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":"<CreateNetworkPackage>\\n <RequestId>269BDB16-2CD8-4865-84BD-11C40BC21DB0</RequestId>\\n <NetworkPackageId>np-amtp8e8q1o9e4****</NetworkPackageId>\\n</CreateNetworkPackage>","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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details of the Internet access package.'."\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"
+ ."\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"
+ ."\n"
+ .'* Valid value when the `PayType` parameter is set to `PrePaid`:'."\n"
+ ."\n"
+ .' * PayByBandwidth: charges by fixed bandwidth.'."\n"
+ ."\n"
+ .'* Valid values when the `PayType` parameter is set to `PostPaid`:'."\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"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* PayByTraffic: charges by data transfer.'."\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",
+ 'type' => 'string',
+ 'example' => '2021-07-10T00:00:00Z',
+ ],
+ 'NetworkPackageStatus' => [
+ 'description' => 'The status of the premium bandwidth plan.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Creating'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Released'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* InUse'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Releasing'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\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',
+ ],
+ ],
+ 'BusinessStatus' => [
+ 'description' => 'The business status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Expired'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* Normal'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Expired' => '',
+ 'Normal' => '',
+ ],
+ 'example' => 'Normal',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeNetworkPackages>\\n<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n<NetworkPackages>\\n <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>\\n <NetworkPackageId>np-amtp8e8q1o9e4****</NetworkPackageId>\\n <ExpiredTime>2099-12-31T15:59:59Z</ExpiredTime>\\n <CreateTime>2021-05-10T02:35:26Z</CreateTime>\\n <Bandwidth>10</Bandwidth>\\n <OfficeSiteName>test</OfficeSiteName>\\n <NetworkPackageStatus>InUse</NetworkPackageStatus>\\n <InternetChargeType>PayByTraffic</InternetChargeType>\\n</NetworkPackages>\\n</DescribeNetworkPackagesResponse>","errorExample":""}]',
+ 'title' => 'DescribeNetworkPackages',
+ 'summary' => 'Queries the details of one or more premium bandwidth plans.',
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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"
+ ."\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",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Details of the traffic that is consumed by the cloud desktop.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DesktopName' => [
+ 'description' => 'The name of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => 'desktop-1',
+ ],
+ 'DesktopId' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd-8bslxqq0csytn****',
+ ],
+ 'FlowRank' => [
+ 'description' => 'The traffic ranking.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'FlowIn' => [
+ 'description' => 'The traffic amount. Unit: KB.'."\n",
+ 'type' => 'string',
+ 'example' => '1000',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ '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' => 'MaxResults',
+ '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',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kRxd1mKkNnHlUy14zdjl/I',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-shanghai+dir-631324****',
+ ],
+ ],
+ [
+ 'name' => 'SourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The granularity of the ACL.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* desktop: cloud computer'."\n"
+ .'* vpc: office network',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'desktop' => '',
+ 'vpc' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ACL entry.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Policy' => [
+ 'description' => 'The ACL type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* allow: whitelist'."\n"
+ .'* disable: blacklist',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'allow' => '',
+ 'deny' => '',
+ ],
+ 'example' => 'allow',
+ ],
+ 'SourceType' => [
+ 'description' => 'The granularity of the ACL.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* desktop: cloud computer'."\n"
+ .'* vpc: office network',
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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.',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 'desktop' => '',
+ 'vpc' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ 'name' => 'SourceId',
+ '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***',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ 'minItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'Policy',
+ '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.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'allow' => '',
+ 'deny' => '',
+ ],
+ 'example' => 'allow',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Schema of response.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '062B1439-709A-580E-85DF-CE97A1560565',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the premium bandwidth plan.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'np-e0iodl3yzb62q****',
+ ],
+ ],
+ [
+ '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-*********',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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-*********',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ '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 most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'NetworkPackageId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The promotion ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '500038360030606',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ ],
+ 500 => [
+ [
+ 'errorCode' => 'InternalError',
+ 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.',
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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 most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the premium bandwidth plan.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'np-cxj99qb8d34vo****',
+ ],
+ ],
+ [
+ 'name' => 'Bandwidth',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PromotionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The promotion ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '500033080110596',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyNetworkPackageBandwidth',
+ ],
+ 'ModifyNetworkPackageEnabled' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the premium bandwidth plan.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'np-cfedn7r2pe48g****',
+ ],
+ ],
+ [
+ 'name' => 'Enabled',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ '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' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of premium bandwidth plans. You can specify one or more IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the premium bandwidth plan.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'np-amtp8e8q1o9e4****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.\\'."\n"
+ .'Default value: 50.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.\\'."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ '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"
+ ."\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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'PackageIds' => [
+ 'description' => 'The bandwidth plans that are bound to the CEN instance.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'PackageId' => [
+ 'description' => 'The ID of the bandwidth plan that is bound to the CEN instance.'."\n",
+ 'type' => 'string',
+ 'example' => 'cenbwp-4c2zaavbvh5f42****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeCensResponse>\\n <TotalCount>1</TotalCount>\\n <PageSize>50</PageSize>\\n <RequestId>2BFA6822-240E-4E27-B4C8-AA400EF7474D</RequestId>\\n <PageNumber>1</PageNumber>\\n <Cens>\\n <Status>Active</Status>\\n <ProtectionLevel>REDUCED</ProtectionLevel>\\n <Description>test</Description>\\n <Ipv6Level>DISABLED</Ipv6Level>\\n <CreationTime>2021-06-16T08:46Z</CreationTime>\\n <CenId>cen-3gwy16dojz1m65****</CenId>\\n <Name>testCen</Name>\\n <Tags>\\n <Value>testValue</Value>\\n <Key>testKey</Key>\\n </Tags>\\n <PackageIds>\\n <PackageId>cenbwp-4c2zaavbvh5f42****</PackageId>\\n </PackageIds>\\n </Cens>\\n</DescribeCensResponse>","errorExample":""}]',
+ 'title' => 'DescribeCens',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'VerifyCen' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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' => 'CenId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the CEN instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cen-3gwy16dojz1m65****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'CidrBlock',
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ '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",
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'TransitRouterService.TrNotExistInRegion',
+ 'errorMessage' => 'The transit router need create in current region.',
+ ],
+ ],
+ ],
+ '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":"<VerifyCenResponse>\\n <Status>Access</Status>\\n <RouteEntries>\\n <Status>Access</Status>\\n <DestinationCidrBlock>100.64.X.X/10</DestinationCidrBlock>\\n <RegionId>cn-shanghai</RegionId>\\n </RouteEntries>\\n <RouteEntries>\\n <Status>Access</Status>\\n <DestinationCidrBlock>172.16.111.0/27</DestinationCidrBlock>\\n <RegionId>cn-shanghai</RegionId>\\n <NextHopInstanceId>vpc-uf62bu0xs5j8md54****</NextHopInstanceId>\\n </RouteEntries>\\n <RouteEntries>\\n <Status>Access</Status>\\n <DestinationCidrBlock>192.168.0.0/24</DestinationCidrBlock>\\n <RegionId>cn-shanghai</RegionId>\\n <NextHopInstanceId>vpc-uf6n17kvw0t15br3s****</NextHopInstanceId>\\n </RouteEntries>\\n <RequestId>06D87278-F765-5FC9-9978-ADD7DC070C7D</RequestId>\\n</VerifyCenResponse>","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' => ' ',
+ ],
+ 'SendVerifyCode' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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.'."\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',
+ ],
+ ],
+ [
+ '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"
+ .'* 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****"}',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CenId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the CEN instance.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cen-3gwy16dojz1m65****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachCenResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</AttachCenResponse>","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' => [],
+ ],
+ ],
+ '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' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachCenResponse>\\r\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\r\\n</DetachCenResponse>","errorExample":""}]',
+ 'title' => 'DetachCen',
+ 'summary' => 'Unbinds an advanced office network from a CEN instance.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateDrive' => [
+ 'summary' => 'Creates a user-level storage resource.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'AliUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of your Alibaba Cloud account.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '1202****',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'DomainId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the storage resource.'."\n"
+ ."\n"
+ .'> Call the DescribeDrives operation to retrieve the storage resource ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'dom-aaaa****',
+ ],
+ ],
+ [
+ 'name' => 'ExternalDomainId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the storage resource.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* NAS: File Storage NAS'."\n"
+ .'* PDS: Drive and Photo Service'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'NAS' => '',
+ 'PDS' => '',
+ ],
+ 'example' => 'NAS',
+ ],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The usage of the storage resource.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* DESKTOP: data disk space'."\n"
+ .'* USER_PROFILE: space for personal data of the user'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'DESKTOP' => '',
+ 'USER_PROFILE' => '',
+ ],
+ 'example' => 'USER_PROFILE',
+ ],
+ ],
+ [
+ 'name' => 'DriveName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the user-level storage resource.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test01',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the user-level storage resource.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test01',
+ ],
+ ],
+ [
+ 'name' => 'ProfileRoaming',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is deprecated.'."\n",
+ 'type' => 'boolean',
+ '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' => '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"
+ ."\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' => '[email protected]****',
+ ],
+ '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"
+ ."\n"
+ .'> Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '536870912000',
+ ],
+ 'UsedSize' => [
+ 'description' => 'The amount of user-level storage resource capacity used.'."\n"
+ ."\n"
+ .'> Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '243175936',
+ ],
+ 'Status' => [
+ 'description' => 'The status of the user-level storage resource.'."\n"
+ ."\n"
+ .'Valid values:'."\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"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* DESKTOP: data disk space'."\n"
+ .'* USER_PROFILE: space for personal data of the user'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'DESKTOP' => '',
+ 'USER_PROFILE' => '',
+ ],
+ 'example' => 'USER_PROFILE',
+ ],
+ 'ProfileRoaming' => [
+ 'description' => '> This parameter is deprecated.'."\n",
+ 'type' => 'boolean',
+ '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\\": \\"[email protected]****\\",\\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ '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",
+ 'type' => 'string',
+ 'example' => '200',
+ ],
+ 'Message' => [
+ 'description' => 'The returned message.'."\n",
+ 'type' => 'string',
+ 'example' => 'successful',
+ ],
+ 'Data' => [
+ 'description' => 'Indicates whether the delete operation was successful.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'UserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'DomainIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'ResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the storage resource.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* NAS: NAS storage'."\n"
+ .'* PDS: PDS storage'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'NAS' => '',
+ 'PDS' => '',
+ ],
+ 'example' => 'NAS',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'AAAA****',
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ '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****',
+ ],
+ 'Drives' => [
+ 'description' => 'The user-level storage resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user-level storage resource.'."\n",
+ '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",
+ 'type' => 'string',
+ 'example' => 'user01',
+ ],
+ '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' => '[email protected]****',
+ ],
+ 'Name' => [
+ 'description' => 'The name of the storage resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'test****',
+ ],
+ 'Description' => [
+ 'description' => 'The introduction to the storage resource.'."\n",
+ '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',
+ ],
+ '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' => '',
+ ],
+ 'example' => 'NORMAL',
+ ],
+ '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',
+ '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',
+ ],
+ '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****',
+ ],
+ 'DesktopGroupName' => [
+ 'description' => 'The name of the cloud computer pool.'."\n",
+ 'type' => 'string',
+ 'example' => 'group01',
+ ],
+ ],
+ ],
+ ],
+ 'EnableProfileManagement' => [
+ 'description' => 'Indicates whether the UPM feature is enabled.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]****\\",\\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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 list of regions where Enterprise Drive Service is available.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the enterprise drive'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'wuying-pds',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the office network. This parameter takes effect only if you set OfficeSiteType to `AD_CONNECTOR`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-400695****',
+ ],
+ ],
+ [
+ 'name' => 'CenId',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cen-g4ba1mkji8nj6****',
+ ],
+ ],
+ [
+ 'name' => 'DomainName',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UserMaxSize',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'SolutionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'co-0esnf8kb8zpfbqmvt',
+ ],
+ ],
+ [
+ 'name' => 'CdsChargeType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Period',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 1 => '1',
+ '2',
+ '3',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PeriodUnit',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Year' => '',
+ ],
+ 'example' => 'Year',
+ ],
+ ],
+ [
+ 'name' => 'UserCount',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResellerOwnerUid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ '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****',
+ ],
+ 'RegionId' => [
+ 'description' => 'The ID of the region.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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***',
+ ],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '20',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'MTA0MjA=',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-0456357992',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ 'required' => false,
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'ParentOrgId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'root',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '',
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'GroupId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'GroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The team name for fuzzy search.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'Test Team 1'."\n",
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cg-e70ga4ixp30ur****',
+ ],
+ ],
+ [
+ 'name' => 'DriveStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The team space status. Valid values:'."\n"
+ ."\n"
+ .'* enabled'."\n"
+ .'* disabled'."\n"
+ ."\n"
+ .'Default value: enabled.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'enabled',
+ ],
+ ],
+ [
+ 'name' => 'GroupType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'org',
+ ],
+ ],
+ [
+ 'name' => 'DriveType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'testDirectoryName ',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ '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' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lY3I2VNHLwy+nIoSXh****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]\\",\\n \\"JobNumber\\": \\"12345\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeCloudDriveGroups',
+ ],
+ 'ModifyCloudDriveGroups' => [
+ 'summary' => 'Modifies team spaces.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The total capacity of the team space.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'docRequired' => true,
+ 'minimum' => '1',
+ 'example' => '32212254720',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ '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-hangzhou+cds-532033****',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ '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,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'create',
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-352282****',
+ ],
+ ],
+ [
+ 'name' => 'UserMaxSize',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ '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,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'get',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-066224****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****',
+ ],
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'F083AAE5-7AA9-53BB-9060-AFFB2C18****',
+ ],
+ 'CloudDriveUsers' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ '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' => '',
+ 'type' => 'string',
+ 'example' => 'abc',
+ ],
+ 'EndUserId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]****\\",\\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-596198****',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'abc',
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'D2E005C4-8CA3-5F1D-9917-E75BE3BF****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-64326*****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bcl',
+ ],
+ 'required' => false,
+ 'docRequired' => true,
+ 'maxItems' => 100,
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-82414*****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3',
+ ],
+ 'CloudDrivePermissionModels' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Permission' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'CDS_DOWNLOAD',
+ ],
+ 'EndUsers' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'bcl',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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,
+ 'example' => 'cn-hangzhou+cds-60911*****',
+ ],
+ ],
+ [
+ 'name' => 'DownloadEndUserIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DownloadUploadEndUserIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'NoDownloadNoUploadEndUserIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '9197824D-AD4B-571F-94BB-C2E6D5855AB6',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'create',
+ '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' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'test1',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud disk.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-82414*****',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ '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-])+$',
+ ],
+ ],
+ [
+ 'name' => 'FileType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ParentFileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the parent folder.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '637c9163b453b1a384874264ba79f3f9eab9****',
+ ],
+ ],
+ [
+ 'name' => 'FileLength',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The file size. Unit: bytes.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'example' => '2048',
+ ],
+ ],
+ [
+ 'name' => 'FileHash',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The hash value of the SHA1 algorithm that is used by the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8****',
+ ],
+ ],
+ [
+ 'name' => 'ConflictPolicy',
+ 'in' => 'query',
+ '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",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-shanghai+cds-465878****',
+ ],
+ ],
+ [
+ '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' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '635a316c94f40f35f5354da29b2aee88c9d1****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud disk.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-352282****',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'root',
+ ],
+ ],
+ [
+ 'name' => 'AutoRename',
+ '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"
+ ."\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',
+ ],
+ ],
+ [
+ 'name' => 'FileReceiverId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '目标复制文件所在的个人空间ID(即UserId,您可以在DescribeCloudDriveUsers接口返回的报文中获取。)或者目标复制文件所在的团队空间ID(即GroupId,您可以在DescribeCloudDriveGroups接口返回的报文中获取。)'."\n"
+ .'> FileReceiverId和FileReceiverType都为空时,默认复制到文件所在的个人空间。'."\n"
+ .'>',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user02',
+ ],
+ ],
+ [
+ 'name' => 'FileReceiverType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '文件所属的空间类型。',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'user' => '个人空间',
+ 'group' => '团队空间',
+ ],
+ 'example' => 'user',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user to which the network disk is assigned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testUser',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-320357****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'FileIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'OrderType',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'CreateTimeDesc' => '',
+ 'ModifiedTimeAsc' => '',
+ 'NameDesc' => '',
+ 'SizeAsc' => '',
+ 'ModifiedTimeDesc' => '',
+ 'CreateTimeAsc' => '',
+ 'SizeDesc' => '',
+ 'NameAsc' => '',
+ ],
+ 'example' => 'CreateTimeDesc',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'available' => '',
+ 'uploading' => '',
+ ],
+ 'example' => 'available',
+ ],
+ ],
+ [
+ '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' => 'WyI2Mzg4MjAwMzFhNGQwZWVmN2I3MjRkZjZhZjAyMWU4YzY1MmRjZmUyIiwibiIsIm4iLDEsLTEsMTY2OTg2NTQ3NTMxMiwiNjM4ODIwMDNlNTU0YmZiZjFkYTk0MmEyYTZhMjEyZDkxODdjMjAy****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ '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',
+ ],
+ '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",
+ 'type' => 'string',
+ 'example' => '63c83ececb4e6926c51448fc5ecb****',
+ ],
+ 'Thumbnail' => [
+ 'description' => 'The URL of the thumbnail.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx',
+ ],
+ 'CreateTime' => [
+ 'description' => 'The time when the file was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-09-06T07:27:08Z',
+ ],
+ 'ModifiedTime' => [
+ 'description' => 'The time when the file was last modified.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-09-06T07:27:08Z',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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\\": \\"[email protected]****\\",\\n \\"OpenTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ParentId\\": \\"3343213ff2f63db8470984e6c92c3213dfdw****\\\\n\\",\\n \\"Modifier\\": \\"[email protected]****\\",\\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud disk.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai+cds-135515****',
+ ],
+ ],
+ [
+ 'name' => 'AsyncTaskId',
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who uses the network disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The enterprise drive ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-64326*****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'FileName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the file.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'test.txt'."\n",
+ 'maxLength' => 1024,
+ 'minLength' => 1,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '',
+ ],
+ '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',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-346063****',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '63f3257b68b018170b194d87b875512d108f****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'description' => 'The group ID.',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ '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 enterprise drive ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-643267****',
+ ],
+ ],
+ [
+ 'name' => 'FileId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '63f3257b68b018170b194d87b875512d108f****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'user****',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The team ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who uses the network disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-066224****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '',
+ ],
+ 'example' => 'true',
+ ],
+ 'Message' => [
+ 'description' => 'Error message. This parameter is not returned if the value of Code is `success`.'."\n",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai+cds-135515****',
+ ],
+ ],
+ [
+ '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' => 0,
+ ],
+ ],
+ [
+ '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' => '2020-06-28T11:33:00.000+08:00',
+ ],
+ ],
+ [
+ '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' => '',
+ '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,
+ ],
+ ],
+ [
+ '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"
+ .'* 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',
+ ],
+ ],
+ [
+ 'name' => 'DisableSave',
+ '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',
+ ],
+ ],
+ [
+ '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"
+ .'* 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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '99999',
+ 'minimum' => '0',
+ '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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '99999',
+ 'minimum' => '0',
+ 'example' => '100',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'FileIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The file IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The file ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '['."\n"
+ .' "4221bf6e6ab43c255edc4463bf3a6f5f5d31****"'."\n"
+ .']',
+ ],
+ 'required' => false,
+ 'docRequired' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+cds-532033****',
+ ],
+ ],
+ [
+ 'name' => 'ShareId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the file sharing link.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '7JQX1Fs****'."\n",
+ ],
+ ],
+ [
+ 'name' => 'Creators',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'ShareName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sharing name for fuzzy search.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'user',
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The file sharing status. Valid values: ● disabled: canceled ● enabled: valid'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'disabled',
+ 'enum' => [
+ 'enabled',
+ 'disabled',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ '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',
+ 'required' => false,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '100',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ShareId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the file sharing task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7JQX1Fs****',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'Status',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sharing status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* disabled: The sharing task is canceled.'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* enabled: The sharing task is valid.'."\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"
+ .'> 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"
+ ."\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' => 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"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* false'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* true'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ ' false' => '',
+ 'true' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ '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"
+ .'* false'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* true'."\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',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ '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' => '0',
+ ],
+ ],
+ [
+ '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' => '0',
+ ],
+ ],
+ [
+ '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' => '0',
+ ],
+ ],
+ [
+ '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' => '0',
+ ],
+ ],
+ [
+ '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' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'ModifyCdsFileShareLink',
+ ],
+ 'CancelCdsFileShareLink' => [
+ 'summary' => 'Cancels a file sharing task.',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ShareId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the file sharing task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '7JQX1Fsw****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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",
+ 'type' => 'string',
+ 'example' => 'success',
+ ],
+ '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' => '',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who uses the network disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-352282****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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' => '角色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,
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-i1ruuudp92qpj****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the user who uses the drive.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'user01',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-346063****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-c3acvkkbsfkte****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'CdsId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the enterprise drive.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+cds-066224****',
+ ],
+ ],
+ [
+ 'name' => 'MemberList',
+ 'in' => 'query',
+ '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' => [
+ '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',
+ ],
+ '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' => '',
+ ],
+ 'example' => 'IT_User',
+ 'default' => 'IT_User',
+ 'enum' => [
+ 'IT_User',
+ 'IT_Group',
+ ],
+ ],
+ ],
+ 'required' => true,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ 'docRequired' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the team space.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cg-1fbmvrc7ug5m7****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the NAS file system.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'szy-asp-upm-test',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the NAS file system.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'newDescription',
+ ],
+ ],
+ [
+ 'name' => 'StorageType',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the workspace.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-beijing+dir-15657*****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the desktop group.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'dg-fh0vdzyh6rdc*****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The list of users.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bcl',
+ ],
+ 'required' => false,
+ 'maxItems' => 10000,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Workspace ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Description of the NAS file system.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'testDescription',
+ ],
+ ],
+ [
+ 'name' => 'StorageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Storage specification type of the NAS file system. Allowed values:'."\n"
+ ."\n"
+ .'- Capacity: Capacity type.'."\n"
+ .'- Performance: Performance type.'."\n"
+ ."\n"
+ .'Default value: Capacity',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Capacity',
+ ],
+ ],
+ [
+ 'name' => 'EncryptType',
+ '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"
+ ."\n"
+ .'- 0: Not encrypted.'."\n"
+ .'- 1: Encrypted using NAS-managed keys.'."\n"
+ ."\n"
+ .'Default value: 0',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'Return object.',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileSystemId' => [
+ 'description' => 'ID of the NAS file system.',
+ 'type' => 'string',
+ 'example' => '04f314****',
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '<props="china">'."\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"
+ .'</props>'."\n"
+ ."\n"
+ .'<props="intl">'."\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"
+ .'</props>',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'translator' => 'machine',
+ ],
+ 'DescribeNASFileSystems' => [
+ 'summary' => 'Queries the information about File Storage NAS (NAS) file systems.',
+ '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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the office network.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '500',
+ 'minimum' => '0',
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The token that determines the start point of the query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemId',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'MatchCompatibleProfile',
+ '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',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The NAS file system.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeNASFileSystemsResponse>\\n<FileSystems>\\n <SupportAcl>false</SupportAcl>\\n <Description>testDescription</Description>\\n <StorageType>Capacity</StorageType>\\n <ZoneId>cn-hangzhou-f</ZoneId>\\n <CreateTime>2021-05-10T11:39Z</CreateTime>\\n <MountTargetStatus>Active</MountTargetStatus>\\n <MeteredSize>0</MeteredSize>\\n <OfficeSiteId>cn-hangzhou+dir-363353****</OfficeSiteId>\\n <MountTargetDomain>04f314****-at***.cn-hangzhou.nas.aliyuncs.com</MountTargetDomain>\\n <Capacity>10485760</Capacity>\\n <FileSystemType>standard</FileSystemType>\\n <FileSystemStatus>Running</FileSystemStatus>\\n <FileSystemName>testNAS</FileSystemName>\\n <FileSystemId>04f314****</FileSystemId>\\n <OfficeSiteName>test</OfficeSiteName>\\n <RegionId>cn-hangzhou</RegionId>\\n</FileSystems>\\n<RequestId>269BDB16-2CD8-4865-84BD-11C40BC21DB0</RequestId>\\n<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n</DescribeNASFileSystemsResponse>","errorExample":""}]',
+ 'title' => 'DescribeNASFileSystems',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the NAS file system.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '04f314****',
+ ],
+ ],
+ [
+ 'name' => 'MountTargetDomain',
+ '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',
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ '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' => 'FileSystemId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the NAS file system.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '3a6ef4****',
+ ],
+ ],
+ ],
+ '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' => '[{"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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'FileSystemId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the NAS file systems that you want to delete.'."\n",
+ '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****',
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ .'><warning>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.></warning>',
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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' => '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' => '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' => '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' => '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' => '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' => 'DataDiskList',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ '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',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => 'PolicyGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '策略ID',
+ 'description' => 'The ID of the policy group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-8hlryfn331******',
+ ],
+ ],
+ [
+ 'name' => 'TimerGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '中心定时任务组ID',
+ 'description' => 'The ID of the scheduled task group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ccg-0caoeogrk9m5****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the resource group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-4knxmfneq1e******',
+ ],
+ ],
+ [
+ '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' => 'RegionConfigList',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ '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' => '',
+ ],
+ '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**********',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ 'name' => 'SiteConfigList',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ 'description' => '区域配置管理',
+ '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,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'enum' => [
+ 'PostPaid',
+ 'PrePaid',
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserDuration',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enum' => [
+ '120',
+ '250',
+ '360',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PostPaidAfterUsedUp',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'PlainResult<String>',
+ 'description' => 'PlainResult'."\n",
+ '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-********',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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' => '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' => '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' => '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' => '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' => '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' => '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',
+ ],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '业务类型',
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'null',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'ListResult<TemplateModel>',
+ 'description' => 'ListResult'."\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-*******',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'eventInfo' => [
+ 'enable' => false,
+ 'eventNames' => [],
+ ],
+ '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',
+ ],
+ 'ModifyTemplate' => [
+ 'summary' => 'Modifies a custom cloud computer template.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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' => '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' => false,
+ 'example' => '',
+ 'maxLength' => 126,
+ 'minLength' => 2,
+ 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SystemDiskPerformanceLevel',
+ 'in' => 'formData',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'PL1' => '',
+ 'PL0' => '',
+ 'AutoPL' => '',
+ ],
+ 'example' => 'AutoPL',
+ ],
+ ],
+ [
+ 'name' => 'DataDiskList',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '策略ID',
+ 'description' => 'The ID of the policy group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ ],
+ ],
+ [
+ 'name' => 'DefaultLanguage',
+ 'in' => 'formData',
+ '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"
+ ."\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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'en-US' => '',
+ 'zh-HK' => '',
+ 'zh-CN' => '',
+ 'ja-JP' => '',
+ ],
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ 'name' => 'TimerGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '中心定时任务组ID',
+ 'description' => 'The ID of the scheduled task group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'bcc-dweha*****',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => 'The ID of the resource group.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'rg-a5fqjjqaejt***',
+ ],
+ ],
+ [
+ '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' => 'RegionConfigList',
+ 'in' => 'formData',
+ 'style' => 'flat',
+ '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' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 10,
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'ChargeType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ 'enum' => [
+ 'PostPaid',
+ 'PrePaid',
+ ],
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'AutoRenew',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'UserDuration',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enum' => [
+ '120',
+ '250',
+ '360',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'PostPaidAfterUsedUp',
+ 'in' => 'formData',
+ 'schema' => [
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateIds',
+ 'in' => 'formData',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the templates that you want to delete.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the template that you want to delete.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'b-7ywwjrr50t1a*****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'BizType',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '> This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'null',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'BaseResult',
+ 'description' => 'The response parameters.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TemplateId',
+ 'in' => 'formData',
+ 'schema' => [
+ 'title' => '模板ID',
+ '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' => '',
+ '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',
+ ],
+ '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*****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ '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' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the image.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'm-4zfb6zj728hhr****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RootDiskSizeGib',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BundleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testBundleName',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The OS language. This parameter is available only for system images. 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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'en-US' => '',
+ 'zh-HK' => '',
+ 'zh-CN' => '',
+ 'ja-JP' => '',
+ ],
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskSizeGib',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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',
+ ],
+ 'required' => true,
+ 'example' => '70',
+ 'maxItems' => 1,
+ ],
+ ],
+ [
+ 'name' => 'RootDiskPerformanceLevel',
+ '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"
+ .'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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'PL1' => 'PL1',
+ 'PL0' => 'PL0',
+ 'PL3' => 'PL3',
+ 'PL2' => 'PL2',
+ ],
+ 'example' => 'PL1',
+ ],
+ ],
+ [
+ 'name' => 'UserDiskPerformanceLevel',
+ '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"
+ ."\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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'PL1' => 'PL1',
+ 'PL0' => 'PL0',
+ 'PL3' => 'PL3',
+ 'PL2' => 'PL2',
+ ],
+ 'example' => 'PL1',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"BundleId\\": \\"b-cezrnfgecbich****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<BundleIdResponse>\\n<BundleId>b-cezrnfgecbich****</BundleId>\\n<RequestId>A90B77D3-261E-4AB2-A860-2FA2098D****</RequestId>\\n</BundleIdResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ '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 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 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',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The token that is used to start the next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'BundleType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SYSTEM' => '',
+ 'CUSTOM' => '',
+ ],
+ 'example' => 'SYSTEM',
+ ],
+ ],
+ [
+ 'name' => 'DesktopTypeFamily',
+ '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',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'eds.graphics' => '',
+ 'eds.hf' => '',
+ 'eds.general' => '',
+ ],
+ 'example' => 'eds.general',
+ ],
+ ],
+ [
+ 'name' => 'CpuCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of vCPUs contained in the cloud computer instance type.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'MemorySize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The memory size of the cloud computer instance type. Unit: GiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '4',
+ ],
+ ],
+ [
+ 'name' => 'GpuCount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of GPUs contained in the cloud computer instance type.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'CheckStock',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query the inventory status of the cloud computer instance type.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'FromDesktopGroup',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ProtocolType',
+ '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)',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'BundleId',
+ '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',
+ ],
+ 'required' => false,
+ 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'SupportMultiSession',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return multi-session cloud computer templates. Default value: false.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'VolumeEncryptionEnabled',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable disk encryption.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'FotaChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '> This parameter is not available for public use.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'This parameter is now in invitational preview and unavailable.',
+ ],
+ ],
+ [
+ 'name' => 'SelectedBundle',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The desktop template that is selected based on specific criteria.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'SessionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the session. Valide values:'."\n"
+ ."\n"
+ .'- SingleSession'."\n"
+ .'- MultipleSession',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SingleSession' => '',
+ 'MultipleSession' => '',
+ ],
+ 'example' => 'SingleSession',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Linux' => 'Linux',
+ 'Windows' => 'Windows',
+ ],
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'Scope',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The scenario to use the image.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'FastBuy',
+ ],
+ ],
+ [
+ 'name' => 'GpuDriverType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The GPU driver type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* T4'."\n"
+ .'* A10'."\n"
+ .'* G28'."\n"
+ .'* G39'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeBundlesResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8</NextToken>\\n <RequestId>BCC854D8-5D1E-46D3-96EF-797A5DD36789</RequestId>\\n <Bundles>\\n <Description>test</Description>\\n <BundleType>SYSTEM</BundleType>\\n <OsType>Windows</OsType>\\n <StockState>Sufficient</StockState>\\n <DesktopType>ecd.graphics.2xlarge</DesktopType>\\n <ProtocolType>HDX</ProtocolType>\\n <BundleId>bundle_ecd_graphics.2xlarge_s15d15_win2019</BundleId>\\n <ImageId>desktopimage-windows-server-2019-64-ch-vgpu</ImageId>\\n <ImageName>Windows server 2019 Chinese</ImageName>\\n <Language>en-US</Language>\\n <BundleName>Advanced graphics with Windows 2019</BundleName>\\n <Disks>\\n <DiskType>SYSTEM</DiskType>\\n <DiskSize>150</DiskSize>\\n <DiskPerformanceLevel>PL0</DiskPerformanceLevel>\\n </Disks>\\n <DesktopTypeAttribute>\\n <CpuCount>10</CpuCount>\\n <GpuCount>0.5</GpuCount>\\n <GpuSpec>NVIDIA T4</GpuSpec>\\n <MemorySize>47104</MemorySize>\\n </DesktopTypeAttribute>\\n <DesktopTypeFamily>eds.general</DesktopTypeFamily>\\n <CreationTime>2021-09-30T06:09Z</CreationTime>\\n </Bundles>\\n</DescribeBundlesResponse>","errorExample":""}]',
+ 'title' => 'DescribeBundles',
+ 'summary' => 'Queries the details of cloud computer templates.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ModifyBundle' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BundleId',
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-aea3oaww001np****',
+ ],
+ ],
+ [
+ 'name' => 'BundleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the new cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'newName',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the new cloud computer template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'newDescription',
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ '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',
+ ],
+ ],
+ ],
+ '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":"<ModifyBundleResponse>\\r\\n<RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A****</RequestId>\\r\\n</ModifyBundleResponse>","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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BundleId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ '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":"<DeleteBundlesResponse>\\r\\n <RequestId>A5CDCED9-54D4-457C-917D-3F2A783CDA1E</RequestId>\\r\\n</DeleteBundlesResponse>","errorExample":""}]',
+ 'title' => 'DeleteBundles',
+ 'summary' => 'Deletes custom cloud computer templates.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'CreateImage' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'ecd-7w78ozhjcwa3u****',
+ ],
+ ],
+ [
+ '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' => false,
+ 'docRequired' => false,
+ 'example' => 'testImageName',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ '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://`.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'This is description.',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the snapshot.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 's-2zefuwk8l6ytcgd3bf4o',
+ ],
+ ],
+ [
+ 'name' => 'ImageResourceType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'This parameter is not publicly available.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'To be hidden.',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotIds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'AutoCleanUserdata',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DiskType',
+ '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]',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SYSTEM' => '',
+ 'ALL' => '',
+ ],
+ 'example' => 'ALL',
+ ],
+ ],
+ [
+ 'name' => 'DataSnapshotIds',
+ '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":"<CreateImageResponse>\\n <RequestId>F5F82BA8-92FE-49E4-AEB9-9010CE7329F3</RequestId>\\n <ImageId>m-gx2x1dhsmusr2****</ImageId>\\n</CreateImageResponse>","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' => [],
+ ],
+ ],
+ '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' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the image that is copied to the destination region.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ ],
+ [
+ 'name' => 'DestinationImageName',
+ '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',
+ ],
+ ],
+ [
+ '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.',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ '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' => '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'Linux' => 'Linux',
+ 'Windows' => 'Windows',
+ ],
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'GpuCategory',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether the image is a GPU-accelerated image.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'ProtocolType',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'GpuDriverType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'LicenseType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EnableSecurityCheck',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable security check.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ '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 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',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'ImageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SYSTEM' => '',
+ 'CUSTOM' => '',
+ ],
+ 'example' => 'SYSTEM',
+ ],
+ ],
+ [
+ 'name' => 'ImageStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The state of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Creating' => '',
+ 'Available' => '',
+ 'CreateFailed' => '',
+ ],
+ 'example' => 'Available',
+ ],
+ ],
+ [
+ 'name' => 'GpuCategory',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'ProtocolType',
+ '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) (recommended)',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'LanguageType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The language of the OS.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'en-US' => '',
+ 'zh-HK' => '',
+ 'zh-CN' => '',
+ 'ja-JP' => '',
+ ],
+ 'example' => 'en-US',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd.graphics.xlarge',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the images. You can specify one or more image IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the image.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ 'required' => false,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ 'in' => 'query',
+ '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',
+ ],
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'GpuDriverVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version of the GPU driver.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '417.22',
+ ],
+ ],
+ [
+ 'name' => 'SessionType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'SINGLE_SESSION' => '',
+ 'MULTIPLE_SESSION' => '',
+ ],
+ 'example' => 'SINGLE_SESSION',
+ ],
+ ],
+ [
+ 'name' => 'FotaVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The image version.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0.0.3-R-20220616.133609',
+ ],
+ ],
+ [
+ 'name' => 'ImageName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The image name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Win_01',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeImagesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB</RequestId>\\n <Images>\\n <CreationTime>2018-01-10T01:01:10Z</CreationTime>\\n <Status>Available</Status>\\n <Progress>100%</Progress>\\n <DataDiskSize>150</DataDiskSize>\\n <ImageType>SYSTEM</ImageType>\\n <Description>This is description.</Description>\\n <Size>40</Size>\\n <OsType>WINDOWS</OsType>\\n <ProtocolType>HDX</ProtocolType>\\n <Name>testImageName</Name>\\n <ImageId>m-gx2x1dhsmusr2****</ImageId>\\n <GpuCategory>false</GpuCategory>\\n <SupportedLanguages>en-US</SupportedLanguages>\\n </Images>\\n</DescribeImagesResponse>","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' => [],
+ ],
+ ],
+ '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,
+ 'enumValueTitles' => [],
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ecd-bd53sfmysz8ir****',
+ ],
+ ],
+ [
+ '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,
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l3d+SWeOobbIlDLjwhjkTk',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ '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 image ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'm-4zfb6zj728hhr****',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'm-2g65ljy3ynrdq****',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ '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' => false,
+ 'example' => 'testName',
+ ],
+ ],
+ [
+ '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' => true,
+ 'example' => 'testDescription',
+ ],
+ ],
+ ],
+ '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":"<ModifyImageAttributeResponse>\\r\\n <RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB</RequestId>\\r\\n</ModifyImageAttributeResponse>","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' => [],
+ ],
+ ],
+ '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 IDs of the images.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ ],
+ [
+ 'name' => 'AddAccount',
+ '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",
+ '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****',
+ ],
+ 'required' => false,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ 'name' => 'RemoveAccount',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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",
+ '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****',
+ ],
+ 'required' => false,
+ 'maxItems' => 50,
+ ],
+ ],
+ ],
+ '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' => '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'TargetProtocolType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The protocol to which you want to update the image protocols. Set the value to ASP.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'ASP' => 'Adaptive Streaming Protocol',
+ ],
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The image IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-gqudcafrqcex9****',
+ ],
+ 'required' => true,
+ 'maxItems' => 500,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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****\']',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ImageId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The image IDs. You can specify 1 to 100 image IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'm-gx2x1dhsmusr2****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'DeleteCascadedBundle',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to delete the associated template.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The information that is returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ecd-gx2x1dhsmucyy****"',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'testSnapshotName',
+ 'maxLength' => 128,
+ 'minLength' => 2,
+ 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'SourceDiskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the disk for which you want to create a snapshot.'."\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',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 'system' => '',
+ 'data' => '',
+ ],
+ 'example' => 'system',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The object returned.'."\n",
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-2ze81owrnv9pity4****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSnapshotResponse>\\n <SnapshotId>s-2ze81owrnv9pity4****</SnapshotId>\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\n</CreateSnapshotResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hzngahou',
+ 'title' => '地域。',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the snapshot.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 's-2zeipxmnhej803x7****',
+ 'title' => '快照ID。',
+ ],
+ ],
+ [
+ 'name' => 'StopDesktop',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否关机并恢复快照。',
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ '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' => '请求ID。',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\n"
+ .'* The data that you want to retain is backed up.'."\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"
+ ."\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testName',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The snapshot ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 's-2ze81owrnv9pity4****',
+ ],
+ ],
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test_data_disk'."\n",
+ ],
+ ],
+ [
+ 'name' => 'SourceDiskType',
+ '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"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Data: the data disk.'."\n"
+ .'* System: the system disk.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Data' => '',
+ 'System' => '',
+ ],
+ 'example' => 'system',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotType',
+ '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"
+ ."\n"
+ .'* auto: automatic snapshots'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* user: manual snapshots'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'all' => '',
+ 'auto' => '',
+ 'user' => '',
+ ],
+ 'example' => 'user',
+ ],
+ ],
+ [
+ 'name' => 'OsType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Linux' => '',
+ 'Windows' => '',
+ ],
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'Creator',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user who creates the snapshot.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Administrator',
+ ],
+ ],
+ [
+ '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",
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2020-11-31T06:32:31Z',
+ ],
+ ],
+ [
+ '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' => '8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****',
+ ],
+ ],
+ [
+ '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,
+ 'maximum' => '100',
+ 'minimum' => '0',
+ 'example' => '10',
+ 'default' => '100',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ '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' => '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeSnapshotsResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****</NextToken>\\n <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>\\n <Snapshots>\\n <Status>ACCOMPLISHED</Status>\\n <Progress>100%</Progress>\\n <Description>testDescription</Description>\\n <DesktopId></DesktopId>\\n <SnapshotName>testSnapshotName</SnapshotName>\\n <SnapshotId>s-2zeipxmnhej803x7****</SnapshotId>\\n <SourceDiskSize>150</SourceDiskSize>\\n <CreationTime>2020-12-20T14:52:28Z</CreationTime>\\n <SnapshotType>USER</SnapshotType>\\n <RemainTime>30</RemainTime>\\n <SourceDiskType>SYSTEM</SourceDiskType>\\n </Snapshots>\\n</DescribeSnapshotsResponse>","errorExample":""}]',
+ 'title' => 'DescribeSnapshots',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ '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****',
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSnapshotResponse>\\r\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\r\\n</DeleteSnapshotResponse>","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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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 query the most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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 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-])+$',
+ ],
+ ],
+ [
+ 'name' => 'RetentionDays',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CronExpression',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The CRON expression for periodic scheduling.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '0 0 2 ? * 1-7',
+ ],
+ ],
+ [
+ 'name' => 'DiskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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](~~196646~~) operation to query the most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sp-c5tv9d64ebjnj****',
+ ],
+ ],
+ [
+ 'name' => 'PolicyName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Test 1201'."\n",
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'* Maximum value: 50.'."\n"
+ .'* Default value: 50.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'maximum' => '50',
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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.'."\n",
+ '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' => '',
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'sp-ejtum8j5tfcw7****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"
+ ."\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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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 most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'sp-itcmrhqt01tdo****',
+ ],
+ ],
+ [
+ '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 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' => false,
+ 'example' => 'Automatic system snapshot'."\n",
+ 'maxLength' => 128,
+ 'minLength' => 2,
+ 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$',
+ ],
+ ],
+ [
+ 'name' => 'RetentionDays',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CronExpression',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The CRON expression.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '0 20 16 ? * 1,2,3,4,5,6,7',
+ ],
+ ],
+ [
+ 'name' => 'DiskType',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyAutoSnapshotPolicy',
+ ],
+ 'CancelAutoSnapshotPolicy' => [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the automatic snapshot policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'sp-78lhzpe7kjfnd****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PolicyId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ '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****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ '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' => '',
+ ],
+ 'example' => 'desktop'."\n",
+ ],
+ ],
+ [
+ 'name' => 'BusinessType',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'PolicyGroupIds',
+ '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,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ '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' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'ResourceRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID of the resource.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ProductType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupType',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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 multiple cloud computer policies are configured for global enforcement, only the earliest-associated policy will 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' => true,
+ 'docRequired' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'tenantRelevance' => 'tenant',
+ ],
+ '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' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer policy ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'pg-53iyi2aar0nd6****',
+ ],
+ ],
+ [
+ 'name' => 'BusinessType',
+ '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',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ 'name' => 'Clipboard',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'LocalDrive',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UsbRedirect',
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => 'GpuAcceleration',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'Html5FileTransfer',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Watermark',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The policy name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [],
+ 'example' => 'testPolicyGroupName',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'EndUserId',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkCustomText',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkSecurity',
+ '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',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'NetRedirect',
+ 'in' => 'query',
+ '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' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'AppContentProtection',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'RemoteCoordinate',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'InternetCommunicationProtocol',
+ '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',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkColor',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The font color 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 font size of the watermark. Valid values: 10 to 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkFontStyle',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'plain',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkRowAmount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of watermark rows. Valid values: 3 to 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'CpuProtectedMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CpuRateLimit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '70',
+ ],
+ ],
+ [
+ 'name' => 'CpuSampleDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CpuSingleRateLimit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '80',
+ ],
+ ],
+ [
+ 'name' => 'CpuDownGradeDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '50',
+ ],
+ ],
+ [
+ 'name' => 'MemoryProtectedMode',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'MemoryDownGradeDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserApplyAdminCoordinate',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserGroupCoordinate',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RecordingAudio',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingStartTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingEndTime',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '08:59:00',
+ ],
+ ],
+ [
+ 'name' => 'RecordingFps',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The frame rate of screen recording. Unit: fps.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'RecordingDuration',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'int32',
+ 'required' => false,
+ 'example' => '15',
+ ],
+ ],
+ [
+ 'name' => 'RecordingUserNotify',
+ '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'."\n",
+ ],
+ ],
+ [
+ 'name' => 'RecordingUserNotifyMessage',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The notification sent to end users when screen recording is enabled.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'deny',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SessionMaxRateKbps',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisplayMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'StreamingMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ColorEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'SmoothEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'QualityEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncPolicy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The video encoding policy.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* qualityFirst: prioritizes image quality.'."\n"
+ .'* bandwidthFirst: prioritizes bandwidth.'."\n",
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncMaxQP',
+ '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',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncAvgKbps',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2000',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncPeakKbps',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The peak bitrate allowed for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2000',
+ ],
+ ],
+ [
+ 'name' => 'MaxReconnectTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'WyAssistant',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkAntiCam',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable anti-screen capture for invisible watermarks.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* off: doesn\'t enable anti-screen capture for invisible watermarks.'."\n"
+ .'* on: enables anti-screen capture for invisible watermarks.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkPower',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'chrome.exe',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'MemoryProcessors',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The memory processors.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The memory processor.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'notepad.exe',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRule',
+ '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 name resolution rule.'."\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,
+ ],
+ ],
+ [
+ 'name' => 'NetRedirectRule',
+ '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",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The network redirection rule.'."\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'."\n",
+ ],
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ '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' => 'android',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ '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 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"
+ .'* 1: enables USB redirection based on device manufacturers.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 1 => '',
+ ],
+ 'example' => '1',
+ ],
+ '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,
+ ],
+ ],
+ [
+ '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 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,
+ ],
+ '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 \'\'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',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ 'CidrIp' => [
+ 'description' => 'The object of the security group rule 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' => 200,
+ ],
+ ],
+ [
+ 'name' => 'AuthorizeAccessPolicyRule',
+ '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,
+ ],
+ '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' => 'DeviceRedirects',
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'DeviceRules',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'WatermarkColumnAmount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of watermark columns. Valid values: 3 to 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRuleType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'ClipboardScope',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'enum' => [
+ 'global',
+ 'grained',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ClipboardGraineds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'StatusMonitor',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileRestart',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileShutdown',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionModel',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'adaptive',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionWidth',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'example' => '720',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionHeight',
+ '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',
+ 'required' => false,
+ 'example' => '1280',
+ ],
+ ],
+ [
+ 'name' => 'Taskbar',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'NoOperationDisconnect',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisconnectKeepSession',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisconnectKeepSessionTime',
+ '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' => '120',
+ ],
+ ],
+ [
+ 'name' => 'RecordEvents',
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'RecordEventFilePaths',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'DeviceConnectHint',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'FileMigrate',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'WuyingKeeper',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'InternetPrinter',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SafeMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ScreenDisplayMode',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientControlMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferSpeedLocation',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferSpeed',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferAddress',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'CpdDriveClipboard',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'UseTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'AutoReconnect',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '断连后自动重连',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileWuyingKeeper',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端无影管家开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileSafeMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端Windows系统的安全按钮开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileWyAssistant',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端小颖开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RecordEventLevels',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'title' => '录屏事件的等级',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EventType' => [
+ 'title' => '事件类型',
+ 'type' => 'string',
+ 'example' => 'StartApplication',
+ ],
+ 'EventLevel' => [
+ 'title' => '事件等级',
+ 'type' => 'string',
+ 'example' => 'HIGH',
+ ],
+ ],
+ ],
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'RecordEventFileExts',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'title' => '录屏事件后缀',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ 'example' => 'txt',
+ ],
+ 'maxItems' => 6,
+ ],
+ ],
+ [
+ 'name' => 'ExternalDrive',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkShadow',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientCreateSnapshot',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'AcademicProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ModelLibrary',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'PortProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'MemoryOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'CpuOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DiskOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionDpi',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'maximum' => '400',
+ 'minimum' => '25',
+ ],
+ ],
+ [
+ 'name' => 'HoverConfigMsg',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'MultiScreen',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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***',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CED7F18-43B1-5035-BBB6-2538B***\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyCenterPolicy',
+ ],
+ 'DescribeResourceByCenterPolicyId' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The policy ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'pg-53iyi2aar0nd6****',
+ ],
+ ],
+ [
+ 'name' => 'ProductType',
+ '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' => false,
+ 'enumValueTitles' => [
+ 'app' => '',
+ 'resourceGroup' => '',
+ 'desktop' => '',
+ 'desktopGroup' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'A pagination token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l69tQX7yFxx6/4dbooBAOc',
+ ],
+ ],
+ [
+ 'name' => 'ResourceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The resource ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-ia2zw38bi6cm7****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****',
+ ],
+ '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' => '',
+ ],
+ ],
+ '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',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '259955',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsN6S2WW',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.\\'."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'maximum' => '200',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ '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' => 'pg-53iyi2aar0nd6****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Scope',
+ 'in' => 'query',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'IP' => '',
+ 'GLOBAL' => '',
+ ],
+ 'example' => 'GLOBAL',
+ ],
+ ],
+ [
+ 'name' => 'BusinessType',
+ '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,
+ 'enumValueTitles' => [
+ 1 => '',
+ 8 => '',
+ ],
+ 'example' => '1',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ 'name' => 'PortProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ModelLibrary',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'AcademicProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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",
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ 'NetRedirectRule' => [
+ 'description' => 'The network redirection policies.'."\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 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',
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ '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',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BusinessType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Clipboard',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'LocalDrive',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'UsbRedirect',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => 'GpuAcceleration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Html5FileTransfer',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Watermark',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The policy name.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'testPolicyGroupName',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'EndUserId,HostName,ClientTime',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkCustomText',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'If you set `WatermarkType` to `custom`, you must also specify `WatermarkCustomText`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkSecurity',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'NetRedirect',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AppContentProtection',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RemoteCoordinate',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'optionalControl' => '',
+ 'fullControl' => '',
+ 'disableControl' => '',
+ ],
+ 'example' => 'fullControl',
+ ],
+ ],
+ [
+ 'name' => 'InternetCommunicationProtocol',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'both',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkColor',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The font color 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 font size of the watermark. Valid values: 10 to 20.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkFontStyle',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'plain',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkRowAmount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of watermark rows. Valid values: 3 to 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkColumnAmount',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of watermark columns. Valid values: 3 to 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '3',
+ ],
+ ],
+ [
+ 'name' => 'CpuProtectedMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CpuRateLimit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The overall CPU usage. Valid values: 70 to 90. Unit: percentage (%).'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '70',
+ ],
+ ],
+ [
+ 'name' => 'CpuSampleDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The overall CPU sampling duration. Valid values: 10 to 60. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '60',
+ ],
+ ],
+ [
+ 'name' => 'CpuSingleRateLimit',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The single-CPU usage. Valid values: 70 to 100. Unit: %.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '70',
+ ],
+ ],
+ [
+ 'name' => 'CpuDownGradeDuration',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The CPU underclocking duration. Valid values: 30 to 120. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'MemoryProtectedMode',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'MemoryDownGradeDuration',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserApplyAdminCoordinate',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserGroupCoordinate',
+ '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',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RecordingAudio',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingStartTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingEndTime',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '08:59:00',
+ ],
+ ],
+ [
+ 'name' => 'RecordingFps',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The frame rate of screen recording. Unit: fps.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'RecordingDuration',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ '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' => 'int32',
+ 'required' => false,
+ 'example' => '15',
+ ],
+ ],
+ [
+ 'name' => 'RecordingUserNotify',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingUserNotifyMessage',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The notification sent to end users when screen recording is enabled.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ 'example' => 'deny',
+ ],
+ ],
+ [
+ 'name' => 'EnableSessionRateLimiting',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'SessionMaxRateKbps',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisplayMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'StreamingMode',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ColorEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'SmoothEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'QualityEnhancement',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncPolicy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The video encoding policy.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* qualityFirst: prioritizes image quality.'."\n"
+ .'* bandwidthFirst: prioritizes bandwidth.'."\n",
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncMaxQP',
+ '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',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncAvgKbps',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The average bitrate for video encoding. Unit: Kbit/s. Valid values: 1000 to 50000.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '2000',
+ ],
+ ],
+ [
+ 'name' => 'VideoEncPeakKbps',
+ 'in' => 'query',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'MaxReconnectTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'WyAssistant',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'MemoryProcessors',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRule',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'NetRedirectRule',
+ '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",
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 50,
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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 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,
+ ],
+ ],
+ [
+ 'name' => 'AuthorizeSecurityPolicyRule',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'AuthorizeAccessPolicyRule',
+ '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,
+ ],
+ ],
+ [
+ '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' => [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DeviceRules',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'WatermarkAntiCam',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkPower',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRuleType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'ClipboardScope',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '剪切板生效范围',
+ 'type' => 'string',
+ 'example' => 'GLOBAL',
+ 'enum' => [
+ 'global',
+ 'grained',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ClipboardGraineds',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'StatusMonitor',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileRestart',
+ '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.'."\n"
+ .'* on: displays the Restart button in the DesktopAssistant menu.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileShutdown',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionModel',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'adaptive',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionHeight',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Taskbar',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'NoOperationDisconnect',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisconnectKeepSession',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'DisconnectKeepSessionTime',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'RecordEvents',
+ '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',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'RecordEventFilePaths',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'DeviceConnectHint',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to display the peripheral connection prompt.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'FileMigrate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable file transfer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'WuyingKeeper',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable Cloud Computer Manager.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'InternetPrinter',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'SafeMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'ScreenDisplayMode',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientControlMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferSpeedLocation',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferSpeed',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FileTransferAddress',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'CpdDriveClipboard',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'UseTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'AutoReconnect',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '客户端自动重连开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileWuyingKeeper',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端无影管家开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileSafeMenu',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端Windows 安全控制开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'MobileWyAssistant',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '移动端小颖的开关',
+ 'type' => 'string',
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RecordEventLevels',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'title' => '录屏事件的级别',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'EventType' => [
+ 'title' => '事件类型',
+ 'type' => 'string',
+ 'example' => 'StartApplication',
+ ],
+ 'EventLevel' => [
+ 'title' => '事件等级',
+ 'type' => 'string',
+ 'example' => 'HIGH',
+ ],
+ ],
+ ],
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'RecordEventFileExts',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'title' => '录屏事件文件扩展名',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ 'example' => 'txt',
+ ],
+ 'maxItems' => 6,
+ ],
+ ],
+ [
+ 'name' => 'ExternalDrive',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'WatermarkShadow',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ClientCreateSnapshot',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'AcademicProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ModelLibrary',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'PortProxy',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'BusinessChannel',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'DiskOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'CpuOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'MemoryOverload',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'ResolutionDpi',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'maximum' => '400',
+ 'minimum' => '25',
+ ],
+ ],
+ [
+ 'name' => 'HoverConfigMsg',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'MultiScreen',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'CreateCenterPolicy',
+ ],
+ 'CloneCenterPolicy' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'BusinessType',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer policy that you want to clone.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the cloud computer policy that you want to clone.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'testPolicyGroupName',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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](~~DescribeRegions~~) operation to query the regions supported by Elastic Desktop Service (EDS).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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 (default): disables both one-way and two-way transfer. Files cannot be copied between local devices and cloud computers.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => 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): disabled. Local disk mapping is unavailable on cloud computers.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'read' => '',
+ 'readwrite' => '',
+ 'off' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'UsbRedirect',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'VisualQuality',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'medium',
+ ],
+ ],
+ [
+ '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' => '',
+ ],
+ '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 (default): The watermarking feature is disabled.'."\n"
+ .'* on: Visible watermarks are applied.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'blind' => '',
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'Name',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the policy.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'testPolicyGroupName',
+ ],
+ ],
+ [
+ '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`, 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 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' => '',
+ ],
+ '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' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'PrinterRedirection',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ '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,
+ 'example' => 'Alice',
+ '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 (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 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"
+ .'* 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',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 200,
+ ],
+ ],
+ [
+ 'name' => 'AuthorizeAccessPolicyRule',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ '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',
+ ],
+ ],
+ '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' => [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'GpuAcceleration',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ '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,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRuleType',
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'OFF' => '',
+ 'ON' => '',
+ ],
+ 'example' => 'OFF',
+ ],
+ ],
+ [
+ 'name' => 'DomainResolveRule',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The details of the domain name resolution rule.'."\n",
+ '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,
+ ],
+ ],
+ [
+ '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. 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',
+ ],
+ ],
+ [
+ 'name' => 'RecordingEndTime',
+ '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',
+ ],
+ ],
+ [
+ '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' => '2',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'CameraRedirect',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the webcam redirection feature.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* off: Webcam redirection is disabled.'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .'* on: Webcam redirection is enabled. This value is the default value.'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'on',
+ ],
+ ],
+ [
+ 'name' => 'NetRedirect',
+ '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"
+ ."\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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'AppContentProtection',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the anti-screenshot feature.'."\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",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'off' => '',
+ 'on' => '',
+ ],
+ 'example' => 'off',
+ ],
+ ],
+ [
+ 'name' => 'RecordContent',
+ '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"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\n"
+ ."\n"
+ .' <!-- -->'."\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.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => false,
+ 'example' => '30',
+ ],
+ ],
+ [
+ 'name' => 'RemoteCoordinate',
+ 'in' => 'query',
+ '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' => '',
+ ],
+ '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' => 'deviceRedirect',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'DeviceRules',
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'WyAssistant',
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PolicyGroupId' => [
+ 'description' => 'The cloud computer policy ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePolicyGroupResponse>\\n<RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>\\n<PolicyGroupId>pg-gx2x1dhsmthe9****</PolicyGroupId>\\n</CreatePolicyGroupResponse>","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",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'DeletePolicyGroups' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PolicyGroupId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The cloud computer policy IDs. You can specify 1 to 100 policies.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cloud computer policy ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ ],
+ 'required' => true,
+ 'example' => 'pg-gx2x1dhsmthe9****',
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameter.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePolicyGroupsResponse>\\r\\n <RequestId>8BBD24F5-DECA-48D8-B08C-15619790F07B</RequestId>\\r\\n</DeletePolicyGroupsResponse>","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' => ' ',
+ ],
+ 'ModifyPolicyGroup' => [
+ 'summary' => 'Modifies the cloud computer policy.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ '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',
+ ],
+ ],
+ [
+ '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":"<ModifyDesktopsPolicyGroupResponse>\\n <RequestId>D3A17B8E-066B-421F-87DC-0B6451D89751</RequestId>\\n <ModifyResults>\\n <DesktopId>ecd-7w78ozhjcwa3u****</DesktopId>\\n <Code>success</Code>\\n </ModifyResults>\\n</ModifyDesktopsPolicyGroupResponse>","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":"<DescribePolicyGroupsResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6kb60RyIe8hZIdhSybWz5t4</NextToken>\\n <RequestId>2CB27899-306D-56E9-A8F1-AD83D9FEDF3B</RequestId>\\n <DescribePolicyGroups>\\n <PolicyGroupId>pg-8whrmp8dewbdv****</PolicyGroupId>\\n <PrinterRedirection>on</PrinterRedirection>\\n <Name>sg-new-02</Name>\\n <PolicyGroupType>CUSTOM</PolicyGroupType>\\n <LocalDrive>off</LocalDrive>\\n <PolicyStatus>AVAILABLE</PolicyStatus>\\n <UsbRedirect>off</UsbRedirect>\\n <ClientTypes>\\n <Status>ON</Status>\\n <ClientType>windows</ClientType>\\n </ClientTypes>\\n <ClientTypes>\\n <Status>ON</Status>\\n <ClientType>linux</ClientType>\\n </ClientTypes>\\n <ClientTypes>\\n <Status>ON</Status>\\n <ClientType>macos</ClientType>\\n </ClientTypes>\\n <ClientTypes>\\n <Status>OFF</Status>\\n <ClientType>ios</ClientType>\\n </ClientTypes>\\n <ClientTypes>\\n <Status>OFF</Status>\\n <ClientType>android</ClientType>\\n </ClientTypes>\\n <ClientTypes>\\n <Status>ON</Status>\\n <ClientType>html5</ClientType>\\n </ClientTypes>\\n <PreemptLogin>off</PreemptLogin>\\n <Html5FileTransfer>off</Html5FileTransfer>\\n <EdsCount>1</EdsCount>\\n <Clipboard>off</Clipboard>\\n <VisualQuality>medium</VisualQuality>\\n <Html5Access>on</Html5Access>\\n <Watermark>off</Watermark>\\n </DescribePolicyGroups>\\n</DescribePolicyGroupsResponse>","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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'DeleteVirtualMFADevice' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ '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":"<DeleteVirtualMFADeviceResponse>\\r\\n <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>\\r\\n</DeleteVirtualMFADeviceResponse>","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' => ' ',
+ ],
+ 'DescribeVirtualMFADevices' => [
+ 'summary' => 'Queries the virtual multi-factor authentication (MFA) devices that are associated with Active Directory (AD) accounts.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeVirtualMFADevicesResponse>\\n<VirtualMFADevices>\\n <GmtEnabled>2020-12-20T14:52:28Z</GmtEnabled>\\n <OfficeSiteId>cn-hangzhou+dir-269345****</OfficeSiteId>\\n <EndUserId>usertest</EndUserId>\\n <DirectoryId>cn-hangzhou+dir-gx2x1dhsmu52rd****</DirectoryId>\\n <SerialNumber>a25f297f-f2e1-4a44-bbf1-5f48a6e5****</SerialNumber>\\n <ConsecutiveFails>1</ConsecutiveFails>\\n <GmtUnlock>2020-12-21T15:21:28Z</GmtUnlock>\\n <status>NORMAL</status>\\n</VirtualMFADevices>\\n<RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>\\n<NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as</NextToken>\\n</DescribeVirtualMFADevicesResponse>","errorExample":""}]',
+ 'title' => 'DescribeVirtualMFADevices',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'UnlockVirtualMFADevice' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ '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":"<UnlockVirtualMFADeviceResponse>\\r\\n <RequestId>FB550AAB-FB36-4A91-93F6-F4374AF65403</RequestId>\\r\\n</UnlockVirtualMFADeviceResponse>","errorExample":""}]',
+ 'title' => 'UnlockVirtualMFADevice',
+ 'summary' => 'Unlocks a virtual multi-factor authentication (MFA) device that is in the LOCKED state.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'LockVirtualMFADevice' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ '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' => '[{"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",
+ ],
+ '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 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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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' => [],
+ ],
+ ],
+ '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 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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'UpdateFotaTask' => [
+ 'summary' => 'Enables or disables the auto-push feature for an image update task.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ '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](~~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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ 'ApproveFotaUpdate' => [
+ 'summary' => 'Allows you to upgrade images.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ ],
+ 'SetOfficeSiteSsoStatus' => [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetOfficeSiteSsoStatusResponse>\\r\\n <RequestId>5CC5E450-FC43-4F5B-B540-9964BD313427</RequestId>\\r\\n</SetOfficeSiteSsoStatusResponse>","errorExample":""}]',
+ 'title' => 'SetOfficeSiteSsoStatus',
+ 'summary' => 'Enables or disables single sign-on (SSO) for an office network.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SetIdpMetadata' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => '&lt;EntityDescriptor ID********Descriptor&gt;',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"IdpEntityId\\": \\"http://test****.cn/adfs/services/trust\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetIdpMetadataResponse>\\n <RequestId>F369A091-002F-49C8-AD55-02A776297C7B</RequestId>\\n <IdpEntityId>http://test****.cn/adfs/services/trust</IdpEntityId>\\n</SetIdpMetadataResponse>","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' => ' ',
+ ],
+ 'SetDirectorySsoStatus' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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":"<SetDirectorySsoStatusResponse>\\r\\n <RequestId>AF5539DC-F0CE-4F04-A8BC-50B65F86FE61</RequestId>\\r\\n</SetDirectorySsoStatusResponse>","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' => ' ',
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SsoStatus\\": false,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOfficeSiteSsoStatusResponse>\\n <RequestId>9C013BF3-BA83-400E-85DF-861804F0948A</RequestId>\\n <SsoStatus>false</SsoStatus>\\n</GetOfficeSiteSsoStatusResponse>","errorExample":""}]',
+ 'title' => 'GetOfficeSiteSsoStatus',
+ 'summary' => 'Queries whether single sign-on (SSO) is enabled for an office network.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'GetSpMetadata' => [
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The information that is returned.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SpMetadata' => [
+ 'description' => 'The metadata of the SP.'."\n",
+ 'type' => 'string',
+ 'example' => '<?xml version=************/md:EntityDescriptor>',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"SpMetadata\\": \\"<?xml version=************/md:EntityDescriptor>\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSpMetadataResponse>\\n <SpMetadata>&lt;?xml version=************/md:EntityDescriptor&gt;</SpMetadata>\\n <RequestId>D3506372-0840-466F-9E73-98D58432D6A7</RequestId>\\n</GetSpMetadataResponse>","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' => ' ',
+ ],
+ 'StopInvocation' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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,
+ ],
+ ],
+ ],
+ '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":"<StopInvocationResponse>\\r\\n <RequestId>F5F82BA8-92FE-49E4-AEB9-9010CE7329F3</RequestId>\\r\\n</StopInvocationResponse>","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' => ' ',
+ ],
+ 'DescribeInvocations' => [
+ '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](~~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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeInvocationsResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****</NextToken>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n <Invocations>\\n <CreationTime>2020-12-19T09:15:46Z</CreationTime>\\n <CommandContent>cnBtIC1xYSB8IGdyZXAgdnNm****</CommandContent>\\n <InvocationStatus>Pending</InvocationStatus>\\n <CommandType>RunPowerShellScript</CommandType>\\n <InvokeId>t-hz0jdfwd9f****</InvokeId>\\n </Invocations>\\n <Invocations>\\n <InvokeDesktops>\\n <Dropped>0</Dropped>\\n <InvocationStatus>Success</InvocationStatus>\\n <ErrorInfo>the specified instance does not exists</ErrorInfo>\\n <ExitCode>0</ExitCode>\\n <StartTime>2020-12-20T06:15:55Z</StartTime>\\n <DesktopId>ecd-7w78ozhjcwa3u****</DesktopId>\\n <Repeats>0</Repeats>\\n <FinishTime>2020-12-20T06:15:56Z</FinishTime>\\n <Output>OutPutTestmsg</Output>\\n <UpdateTime>2020-12-25T06:15:56Z</UpdateTime>\\n <CreationTime>2020-12-20T06:15:54Z</CreationTime>\\n <ErrorCode>InstanceNotExists</ErrorCode>\\n <StopTime>2020-12-25T09:15:47Z</StopTime>\\n </InvokeDesktops>\\n </Invocations>\\n</DescribeInvocationsResponse>","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' => ' ',
+ ],
+ 'RunCommand' => [
+ 'summary' => 'Runs a PowerShell or batch (.bat) command on one or more Windows cloud computers.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ ],
+ 'ListTagResources' => [
+ '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' => '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,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<ListTagResourcesResponse>\\n <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TagResources>\\n <ResourceId>ecd-ia2zw38bi6cm7****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n <ResourceType>ALIYUN::GWS::INSTANCE</ResourceType>\\n <TagValue>TestValue</TagValue>\\n </TagResources>\\n</ListTagResourcesResponse>","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' => ' ',
+ ],
+ 'TagResources' => [
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ '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":"<TagResourcesResponse>\\r\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\r\\n</TagResourcesResponse>","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' => ' ',
+ ],
+ 'UntagResources' => [
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ ],
+ '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":"<UntagResourcesResponse>\\r\\n <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>\\r\\n</UntagResourcesResponse>","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' => ' ',
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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,
+ '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,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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":"<DescribeClientEventsResponse>\\n <NextToken>AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****</NextToken>\\n <RequestId>28A40F12-F340-442B-A35F-46EF6A03227B</RequestId>\\n <Events>\\n <Status>200</Status>\\n <BytesReceived>8665</BytesReceived>\\n <DesktopIp>10.10.*.*</DesktopIp>\\n <EventTime>2020-11-30T06:32:31Z</EventTime>\\n <BytesSend>2345</BytesSend>\\n <OfficeSiteId>cn-hangzhou+dir-bh77qa8nmjot4****</OfficeSiteId>\\n <AliUid>112259558861****</AliUid>\\n <DesktopId>ecd-8fupvkhg0aayu****</DesktopId>\\n <RegionId>cn-hangzhou</RegionId>\\n <EventId>5651188b-3070-d1cc-5311-75753d59****</EventId>\\n <DirectoryType>RAM</DirectoryType>\\n <EventType>DESKTOP_DISCONNECT</EventType>\\n <EndUserId>28961708130834****</EndUserId>\\n <ClientIp>100.68.*.*</ClientIp>\\n <ClientOS>Darwin 17.7.0 x64</ClientOS>\\n <OfficeSiteType>SIMPLE</OfficeSiteType>\\n <DirectoryId>cn-hangzhou+dir-bh77qa8nmjot4****</DirectoryId>\\n <ClientVersion>1.0.4 202012021700</ClientVersion>\\n <OfficeSiteName>test</OfficeSiteName>\\n <DesktopName>test</DesktopName>\\n <DesktopGroupId>dg-kadkdfaf****</DesktopGroupId>\\n <DesktopGroupName>testName</DesktopGroupName>\\n </Events>\\n</DescribeClientEventsResponse>","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' => ' ',
+ ],
+ 'ExportClientEvents' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ 'DescribeRecordings' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ 'DescribeRecordFile' => [
+ 'summary' => 'Queries the screen recording files in all regions.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'tenantRelevance' => 'tenant',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'DescribeGlobalDesktopRecords' => [
+ 'summary' => 'Queries the basic information of all cloud computers and the corresponding usage duration records.',
+ '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.'."\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,
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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",
+ ],
+ 'AddDevices' => [
+ 'summary' => 'Adds trusted devices.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ ],
+ 'DeleteDevices' => [
+ 'summary' => 'Deletes trusted devices.',
+ 'methods' => [
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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",
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'AttachEndUser',
+ ],
+ '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' => '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****',
+ ],
+ ],
+ [
+ 'name' => 'AdDomain',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The address of the Active Directory (AD) office network.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xn--0zw****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => [],
+ ],
+ ],
+ '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",
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the bound user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ '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"
+ .'* 2: software client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [
+ 1 => '',
+ '',
+ ],
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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",
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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 supported by Elastic Desktop Service (EDS).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testUser',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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 returned per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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 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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'ResourceGroupId',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ [
+ 'name' => 'FillHardwareInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否增加终端信息返回。',
+ 'type' => 'boolean',
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '返回信息的语言类型。',
+ 'type' => 'string',
+ 'example' => 'zh-CN',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ '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' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID of the terminal that connects to the session.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'xianqiu',
+ ],
+ ],
+ [
+ '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"',
+ ],
+ ],
+ [
+ '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"',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '20',
+ ],
+ ],
+ [
+ '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"',
+ ],
+ ],
+ [
+ 'name' => 'FillTerminalInfo',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否补充终端信息。',
+ 'description' => 'Whether to supplement terminal information.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '返回信息语言类型。',
+ 'description' => 'The language of the response.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'DesktopGroupName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '共享桌面名称。',
+ 'description' => 'The name of the shared desktop.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-4oyi32wmrctgx****',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The workspace ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-shanghai+dir-259382****',
+ ],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The beginning of the time range to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1679449506572',
+ ],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The end of the time range to query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '1677808889806',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The universally unique identifier (UUID) of the device.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '62f2f1f252f04e0e9d8bc****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ '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.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zhangsan',
+ ],
+ ],
+ [
+ 'name' => 'CoId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the application for the coordinate permissions.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'co-fqsm6e8ee75w61fp9',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => 'C43EEAC3-84F8-5C1E-A067-4751C3D1422E',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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 most recent region list.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the end user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'zhangsan',
+ ],
+ ],
+ [
+ 'name' => 'CoId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the stream coordination task.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'co-fqsm6e8ee75w61fp9',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ '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' => 'RevokeCoordinatePrivilege',
+ 'summary' => 'Revokes the coordinate permissions.',
+ ],
+ 'CreateBandwidthResourcePackages' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'create',
+ ],
+ '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' => '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'AutoPay',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable the auto-payment feature.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'true',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '数据是客户端用户操作时产生,无法通过用例获取',
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'trt-hffhi4nmqoi4****',
+ ],
+ ],
+ [
+ 'name' => 'FileIds',
+ 'in' => 'query',
+ 'style' => 'flat',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'trf-i4pz8emx2k2fr****',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'autoTest' => false,
+ 'notSupportAutoTestReason' => '数据是客户端用户操作时产生,无法通过用例获取',
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the transmission task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'trt-03tdwg4tcuwdzv****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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****',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ '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****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'OssBucketRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region where the OSS bucket storing the file resides.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OssBucketName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the OSS bucket where the file resides.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ed****-17337752804***',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ecd-39clsqyxr****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The page number.\\'."\n"
+ .'Default value: 1.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the report export task.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ret-sfkdsjfi*****',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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。',
+ ],
+ ],
+ ],
+ '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' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ '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',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ [
+ '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,
+ ],
+ ],
+ [
+ 'name' => 'ReportFileName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the report file.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '',
+ ],
+ ],
+ [
+ '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',
+ ],
+ ],
+ ],
+ '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******',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'CreateQosRule' => [
+ 'summary' => 'Creates a Quality of Service (QoS) rule.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'np-cfedn7r2pe48g****',
+ ],
+ ],
+ [
+ 'name' => 'QosRuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '',
+ ],
+ ],
+ [
+ 'name' => 'Upload',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'Download',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '5',
+ ],
+ ],
+ [
+ 'name' => 'AuthDesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-sfasdfsddsat*****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'AuthAndroidId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cpn-asdsdfsdffsd*****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****',
+ ],
+ 'QosRuleId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'qos-5605u0gelk200****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\"\\n}","type":"json"}]',
+ 'title' => 'CreateQosRule',
+ ],
+ 'DeleteQosRules' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QosRuleId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'qos-5605u0gelk200****',
+ ],
+ 'required' => true,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'NetworkPackageId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'np-cxj99qb8d34vo****',
+ ],
+ ],
+ [
+ 'name' => 'QosRuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QosRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'qos-5605u0gelk200****',
+ ],
+ ],
+ [
+ 'name' => 'AuthDesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-j45qtb0eh91yg****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'RevokeDesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-j45qtb0eh91yg****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'AuthAndroidId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cpn-asdsdfsdffsd*****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'RevokeAndroidId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cpn-asdsdfsdffsd*****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'ModifyQosEntries',
+ ],
+ 'ModifyQosRule' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'QosRuleId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'qos-5605u0gelk200****',
+ ],
+ ],
+ [
+ 'name' => 'QosRuleName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'test',
+ ],
+ ],
+ [
+ 'name' => 'Upload',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ [
+ 'name' => 'Download',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '10',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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',
+ ],
+ ],
+];
diff --git a/data/en_us/ecd/2020-10-02/api-docs.php b/data/en_us/ecd/2020-10-02/api-docs.php
new file mode 100644
index 0000000..2463802
--- /dev/null
+++ b/data/en_us/ecd/2020-10-02/api-docs.php
@@ -0,0 +1,6223 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'ecd',
+ 'version' => '2020-10-02',
+ ],
+ 'directories' => [
+ [
+ 'id' => 203311,
+ 'title' => 'Cloud resource management',
+ 'type' => 'directory',
+ 'children' => [
+ 'DescribeRegions',
+ 'DescribeDirectories',
+ 'DescribeOfficeSites',
+ 'DescribeGlobalDesktops',
+ 'DescribeUserResources',
+ 'UnbindUserDesktop',
+ 'GetConnectionTicket',
+ 'StartDesktops',
+ 'StopDesktops',
+ 'RebootDesktops',
+ 'ReportSessionStatus',
+ 'ApproveFotaUpdate',
+ 'DescribeSnapshots',
+ 'ResetSnapshot',
+ 'GetCloudDriveServiceMountToken',
+ 'VerifyCredential',
+ ],
+ ],
+ [
+ 'id' => 203310,
+ 'title' => 'User logon',
+ 'type' => 'directory',
+ 'children' => [
+ 'GetLoginToken',
+ 'RefreshLoginToken',
+ 'SendTokenCode',
+ 'ChangePassword',
+ 'ResetPassword',
+ 'EncryptPassword',
+ 'DescribeFingerPrintTemplates',
+ 'SetFingerPrintTemplate',
+ 'SetFingerPrintTemplateDescription',
+ 'DeleteFingerPrintTemplate',
+ 'IsKeepAlive',
+ ],
+ ],
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'DescribeRegions' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ 'Regions' => [
+ 'description' => 'The regions.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The region.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RegionEndpoint' => [
+ 'description' => 'The region endpoint.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd.cn-hangzhou.aliyuncs.com',
+ ],
+ 'RegionId' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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 }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeRegions',
+ ],
+ 'DescribeDirectories' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The directory IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The directory ID, which is the same as the office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'F369A091-002F-49C8-AD55-02A77629****',
+ ],
+ 'Directories' => [
+ 'description' => 'The directories.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The directory.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DirectoryType' => [
+ 'description' => 'The directory type.'."\n",
+ 'type' => 'string',
+ 'example' => 'AD_CONNECTOR',
+ ],
+ 'SsoServiceUrl' => [
+ 'description' => 'The URL of the SSO service.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://eds-cn-shanghai-67726****',
+ ],
+ 'DesktopAccessType' => [
+ 'description' => 'The connection method.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* VPC: End users connect to cloud computers over an enterprise virtual private cloud (VPC).'."\n"
+ .'* INTERNET: End users connect to cloud computers over the Internet.'."\n"
+ .'* ANY: End users connect to cloud computers over the Internet or an enterprise VPC.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'VPC连接' => '',
+ 'INTERNET' => '',
+ 'ANY' => '',
+ ],
+ 'example' => 'INTERNET',
+ ],
+ 'DirectoryId' => [
+ 'description' => 'The directory ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****',
+ ],
+ 'ProviderId' => [
+ 'description' => 'The provider ID.'."\n",
+ 'type' => 'string',
+ 'example' => '26842',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A77629****\\",\\n \\"Directories\\": [\\n {\\n \\"DirectoryType\\": \\"AD_CONNECTOR\\",\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67726****\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ProviderId\\": \\"26842\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeDirectories',
+ 'summary' => 'Queries directory details.',
+ ],
+ 'DescribeOfficeSites' => [
+ 'summary' => 'Queries office networks.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => 'uuid',
+ 'description' => 'uuid'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ASDASD',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'OfficeSites' => [
+ 'description' => 'The office networks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the office network.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'SsoServiceUrl' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'https://eds-cn-shanghai-67****',
+ ],
+ 'DesktopAccessType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'INTERNET' => '',
+ 'VPC' => '',
+ 'Any' => '',
+ ],
+ 'example' => 'VPC',
+ ],
+ 'DesktopVpcEndpoint' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com',
+ ],
+ 'OfficeSiteType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'ad_connector' => '',
+ 'simple' => '',
+ ],
+ 'example' => 'SIMPLE',
+ ],
+ 'ProviderId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '268****',
+ ],
+ 'OfficeSiteId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ 'BizType' => [
+ 'title' => 'biztype',
+ 'description' => 'biztype'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => 'ENTERPRISE',
+ ],
+ 'AliUid' => [
+ 'title' => 'aliuid',
+ 'description' => 'aliuid'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '125552',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSites\\": [\\n {\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67****\\",\\n \\"DesktopAccessType\\": \\"VPC\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"ProviderId\\": \\"268****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"BizType\\": 0,\\n \\"AliUid\\": 125552\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeOfficeSites',
+ ],
+ 'DescribeGlobalDesktops' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '121369',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsENR35V',
+ ],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* cn-shanghai: China (Shanghai)'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'cn-shanghai' => '',
+ ],
+ 'example' => 'cn-shanghai',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network IDs.'."\n"
+ ."\n"
+ .'> This parameter is about to be disabled. Use `OfficeSiteId`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-880841****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network IDs.'."\n"
+ ."\n"
+ .'> `DirectoryId` the parameter is about to be retired, use this field.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-880841****',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique ID generated by the client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID. You can call the GetLoginToken operation to query the value of the SessionId parameter.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token. You can call the GetLoginToken operation to obtain the token. You can also call the UpdateToken operation to obtain the token RefreshLoginToken. Response parameter: LoginToken.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v147c9114a180489f89691663893169****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer status.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* Stopped'."\n"
+ .'* Starting.'."\n"
+ .'* Rebuilding'."\n"
+ .'* Running:.'."\n"
+ .'* Stopping:.'."\n"
+ .'* Expired'."\n"
+ .'* Deleted'."\n"
+ .'* Pending: The resource is still being prepared.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'Stopped' => '',
+ 'Starting' => '',
+ 'Rebuilding' => '',
+ 'Running' => '',
+ 'Stopping' => '',
+ 'Expired' => '',
+ 'Deleted' => '',
+ 'Pending' => '',
+ ],
+ 'example' => 'Running',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page.'."\n"
+ ."\n"
+ .'* Maximum value: 500.'."\n"
+ .'* and the default value is 10.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '500',
+ ],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer name.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'DesktopTest',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The cloud computer ID. You can specify one or more cloud computer IDs. Valid values: 1 to 20.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-hkbl45il187d6****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ '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' => 'DesktopAccessType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The method that is used to connect cloud computers that reside in the office network from WUYING clients.'."\n"
+ ."\n"
+ .'> The VPC connection method depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. If you set this parameter to VPC or Any, the system automatically enables PrivateLink.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* INTERNET (default): End users connect to cloud computers from clients over the Internet.'."\n"
+ .'* VPC: End users connect to cloud computers from clients over a virtual private cloud (VPC).'."\n"
+ .'* Any: End users connect to cloud computers from clients over the Internet or a VPC.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'INTERNET' => '',
+ 'VPC' => '',
+ 'Any' => '',
+ ],
+ 'example' => 'INTERNET',
+ ],
+ ],
+ [
+ 'name' => 'QueryFotaUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to query information about the image update.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'WithoutLatency',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Whether to query real-time cloud computer information. The cloud computer status information in the current interface has a delay of 1 to 3 seconds. If you need accurate information, set this value to `true`.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The field used for sorting. If you do not specify this option, the system is sorted in descending order of creation time.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* AssignTime: sort by allocation time.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'AssignTime' => '',
+ ],
+ 'example' => 'AssignTime',
+ ],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sorting method.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ASC (default): the ascending order.'."\n"
+ .'* DESC: the descending order.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'ASC' => '',
+ 'DESC' => '',
+ ],
+ 'example' => 'ASC',
+ ],
+ ],
+ [
+ 'name' => 'Keyword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The keyword. Fuzzy search is supported for cloud computer IDs, cloud computer names, and end user custom cloud computer names.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd',
+ ],
+ ],
+ [
+ 'name' => 'LoginRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the region where the office network resides. This parameter is left empty when you log on with an organization ID.'."\n"
+ ."\n"
+ .'* This parameter is required when you log on by using the office network ID.'."\n"
+ .'* If you log on by using an organization ID, this parameter can be left empty.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'NextToken' => [
+ 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n",
+ 'type' => 'string',
+ 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '4686A731-D601-548C-83E2-4CB6371E****',
+ ],
+ 'Desktops' => [
+ 'description' => 'The details about the cloud computer.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The details about 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 pool.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* PostPaid: 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',
+ ],
+ 'HostName' => [
+ 'description' => 'The hostname of the cloud desktop.'."\n",
+ 'type' => 'string',
+ 'example' => 'testName',
+ ],
+ 'DesktopGroupId' => [
+ 'description' => 'The ID of the cloud computer share.'."\n",
+ 'type' => 'string',
+ 'example' => 'dg-3uiojcc0j4kh7****',
+ ],
+ 'DesktopId' => [
+ 'description' => 'The cloud compute ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ 'RegionId' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'LastStartTime' => [
+ 'description' => 'The time when the cloud desktop was last started.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-07-13T15:59Z',
+ ],
+ 'Cpu' => [
+ 'description' => 'The number of vCPUs.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '2',
+ ],
+ 'EndUserId' => [
+ 'description' => 'The names of end users.'."\n",
+ 'type' => 'string',
+ 'example' => 'User1',
+ ],
+ 'ExpiredTime' => [
+ 'description' => 'The expiration time of the cloud computer.'."\n"
+ ."\n"
+ .'* For a cloud computer that is a package year or month, the return value is meaningful.'."\n"
+ .'* For pay-as-you-go cloud computers, the `2099-12-31T15:59Z` is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-31T15:59Z',
+ ],
+ 'DesktopStatus' => [
+ 'description' => 'The cloud computer status.'."\n",
+ 'type' => 'string',
+ 'example' => 'Running',
+ ],
+ 'DesktopType' => [
+ 'description' => 'The cloud computer type.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd.basic.large',
+ ],
+ 'ConnectionStatus' => [
+ 'description' => 'The state of the endpoint connection.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Connected'."\n"
+ .'* Disconnecting'."\n"
+ .'* Pending.'."\n"
+ .'* Connecting.'."\n"
+ .'* Disconnected.'."\n"
+ .'* Deleting'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Connected' => '',
+ 'Disconnecting' => '',
+ 'Pending' => '',
+ 'Connecting' => '',
+ 'Disconnected' => '',
+ 'Deleting' => '',
+ ],
+ 'example' => 'Disconnected',
+ ],
+ 'Memory' => [
+ 'description' => 'The memory of the cloud computer. Unit: MiB.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '4096',
+ ],
+ 'ImageId' => [
+ 'description' => 'The image ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'm-4zfb6zj728hhr****',
+ ],
+ 'DirectoryId' => [
+ 'description' => 'The network ID of the office. Same as `OfficeSiteId`.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** ',
+ ],
+ 'Disks' => [
+ 'description' => 'The disks.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the disk.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'DiskType' => [
+ 'description' => 'The disk type.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* SYSTEM: a system disk.'."\n"
+ .'* DATA: a data disk.'."\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',
+ ],
+ ],
+ ],
+ ],
+ 'OsType' => [
+ 'description' => 'The operating system.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* Linux'."\n"
+ .'* Windows'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Linux' => 'Linux',
+ 'Windows' => 'Windows',
+ ],
+ 'example' => 'Windows',
+ ],
+ 'Sessions' => [
+ 'description' => 'The list of session information.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the session.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EndUserId' => [
+ 'description' => 'End user information.'."\n",
+ 'type' => 'string',
+ 'example' => 'User1',
+ ],
+ 'EstablishmentTime' => [
+ 'description' => 'The time when the session was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-03-07T08:23Z',
+ ],
+ ],
+ ],
+ ],
+ 'PolicyGroupId' => [
+ 'description' => 'The cloud computer policy ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'pg-9cktlowtxfl6****',
+ ],
+ 'EndUserIds' => [
+ 'description' => 'The list of end user.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The names of end users.'."\n",
+ 'type' => 'string',
+ 'example' => 'User1',
+ ],
+ ],
+ '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',
+ ],
+ 'FotaUpdate' => [
+ 'description' => 'The information about image update.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Project' => [
+ 'description' => 'The name of the project.'."\n",
+ 'type' => 'string',
+ 'example' => 'testProject',
+ ],
+ 'Channel' => [
+ 'description' => 'Subscription Channel'."\n",
+ 'type' => 'string',
+ 'example' => 'Enterprise',
+ ],
+ 'CurrentAppVersion' => [
+ 'description' => 'The current version number of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '0.0.0-D-20220102.xxxx',
+ ],
+ 'NewAppVersion' => [
+ 'description' => 'The version number of the application after the update.'."\n",
+ 'type' => 'string',
+ 'example' => '0.0.0-R-20220307.xxxx',
+ ],
+ 'Force' => [
+ 'description' => 'Whether to force upgrade.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ReleaseNote' => [
+ 'description' => 'The description of the version that can be upgraded.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the update package for the cloud computer image. Unit: MiB.'."\n",
+ 'type' => 'string',
+ 'example' => '100',
+ ],
+ 'ReleaseNoteEn' => [
+ 'description' => 'The English release note for the new image version.'."\n",
+ 'type' => 'string',
+ 'example' => 'Release note',
+ ],
+ 'ReleaseNoteJp' => [
+ 'description' => 'The Japanese release note for the new image version.'."\n",
+ 'type' => 'string',
+ 'example' => 'リリースノート',
+ ],
+ 'NewDcdVersion' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'ProtocolType' => [
+ 'description' => 'The type of the protocol.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* High-definition Experience (HDX)'."\n"
+ .'* ASP'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ 'OfficeSiteId' => [
+ 'description' => 'The IDs of the office networks.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-363353****',
+ ],
+ 'NetworkInterfaceIp' => [
+ 'description' => 'The IP address of the ENI.'."\n",
+ 'type' => 'string',
+ 'example' => '192.168.xx.xx',
+ ],
+ 'UserCustomName' => [
+ 'description' => 'The custom cloud computer name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testDesktop',
+ ],
+ 'ManagementFlags' => [
+ 'description' => 'The list of cloud computer status.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The management status of the cloud computer.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* UNDER_MAINTENANCE: in maintenance mode.'."\n"
+ .'* MIGRATING.'."\n"
+ .'* ASSIGNING: in the assigned user.'."\n"
+ .'* MIGRATING_PROTOCOL .'."\n"
+ .'* NO_FLAG: stateless.'."\n"
+ .'* ENTER_MAINTENANCE: in maintenance mode.'."\n"
+ .'* UPDATING.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'UNDER_MAINTENANCE' => '',
+ 'MIGRATING' => '',
+ 'ASSIGNING' => '',
+ 'MIGRATING_PROTOCOL' => '',
+ 'NO_FLAG' => '',
+ 'ENTER_MAINTENANCE' => '',
+ 'UPDATING' => '',
+ ],
+ 'example' => 'UPDATING',
+ ],
+ ],
+ 'LocalName' => [
+ 'description' => 'The region name.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'RealDesktopId' => [
+ 'description' => 'If a shared cloud computer is assigned a real cloud computer, the ID of the cloud computer is displayed.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd-gx2x1dhsm****',
+ ],
+ 'DesktopTimers' => [
+ 'description' => 'The cloud computer timer object.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TimerType' => [
+ 'description' => 'The type of the scheduled task.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n"
+ .'* NoConnectShutdown: connectionless shutdown.'."\n"
+ .'* TimerBoot: scheduled start.'."\n"
+ .'* TimerReset: scheduled reset.'."\n"
+ .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n"
+ .'* TimerShutdown: Stops the cloud computers on schedule.'."\n"
+ .'* NoOperationReboot: scheduled restart upon inactivity.'."\n"
+ .'* TimerReboot: scheduled restart.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'NoOperationDisconnect' => '',
+ 'NoConnectShutdown' => '',
+ 'TimerBoot' => '',
+ 'TimerReset' => '',
+ 'NoOperationShutdown' => '',
+ 'TimerShutdown' => '',
+ 'NoOperationReboot' => '',
+ 'TimerReboot' => '',
+ ],
+ 'example' => 'NoConnectShutdown',
+ ],
+ 'CronExpression' => [
+ 'description' => 'The CRON expression for the scheduled task.'."\n"
+ ."\n"
+ .'For example, a `0 0 4 1/1 * ?` indicates that the operation is executed every day from 4:00 a.m. on the first day of each month.'."\n",
+ 'type' => 'string',
+ 'example' => '0 0 0 ? * 1',
+ ],
+ 'Interval' => [
+ 'description' => 'The interval at which the monitoring data was queried. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '60',
+ ],
+ 'Enforce' => [
+ 'description' => 'Indicates whether to forcibly execute the scheduled task. To `true` indicates that cloud computer and connection status detection are ignored, and scheduled tasks are forcibly executed.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ResetType' => [
+ 'description' => 'For a reset task, you must set the reset type.'."\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_BOTH',
+ ],
+ 'AllowClientSetting' => [
+ 'description' => 'Whether to allow clients to set policies.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'OperationType' => [
+ 'description' => 'The type of the scheduled task.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* HIBERNATE'."\n"
+ .'* SHUTDOWN'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'HIBERNATE' => '',
+ 'SHUTDOWN' => '',
+ ],
+ 'example' => 'SHUTDOWN',
+ ],
+ 'ExecutionTime' => [
+ 'description' => 'The task duration.'."\n",
+ 'type' => 'string',
+ 'example' => '2021-12-31T15:59Z',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Clients' => [
+ 'description' => 'The information about the supported clients.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The information about the supported clients.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'description' => 'The status of the client.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* OFF: does not allow logon.'."\n"
+ .'* ON: allows logon.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'OFF' => '',
+ 'ON' => '',
+ ],
+ 'example' => 'ON',
+ ],
+ 'ClientType' => [
+ 'description' => 'The client type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* html5: the web client.'."\n"
+ .'* android: the Android client.'."\n"
+ .'* linux: Linux client.'."\n"
+ .'* ios: the iOS client.'."\n"
+ .'* windows: the Windows client.'."\n"
+ .'* macos: the macOS client.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'html5' => '',
+ 'android' => '',
+ 'linux' => '',
+ 'ios' => '',
+ 'windows' => '',
+ 'macos' => '',
+ ],
+ 'example' => 'windows',
+ ],
+ ],
+ ],
+ ],
+ 'SupportHibernation' => [
+ 'description' => 'Indicates whether hibernation is supported.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* true: supported'."\n"
+ .'* false: not supported'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ 'HibernationBeta' => [
+ 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'SessionType' => [
+ 'description' => 'The type of the session.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* SINGLE_SESSION'."\n"
+ .'* MULTIPLE_SESSION'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'SINGLE_SESSION' => '',
+ 'MULTIPLE_SESSION' => '',
+ ],
+ 'example' => 'SINGLE_SESSION',
+ ],
+ 'Platform' => [
+ 'description' => 'The OS platform.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* Ubuntu'."\n"
+ .'* UOS'."\n"
+ .'* CentOS'."\n"
+ .'* Windows Server 2019'."\n"
+ .'* Windows Server 2016'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Ubuntu' => 'Ubuntu',
+ 'UOS' => 'UOS',
+ 'CentOS' => 'CentOS',
+ 'Windows Server 2019' => 'Windows Server 2019',
+ 'Windows Server 2016' => 'Windows Server 2016',
+ ],
+ 'example' => 'Ubuntu',
+ ],
+ 'Os' => [
+ 'description' => 'OS Type'."\n",
+ 'type' => 'string',
+ 'example' => 'Windows',
+ ],
+ 'RegionLocation' => [
+ 'type' => 'string',
+ ],
+ 'OsDescription' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****\\",\\n \\"RequestId\\": \\"4686A731-D601-548C-83E2-4CB6371E****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"HostName\\": \\"testName\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastStartTime\\": \\"2021-07-13T15:59Z\\",\\n \\"Cpu\\": 2,\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"Memory\\": 4096,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\t\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80\\n }\\n ],\\n \\"OsType\\": \\"Windows\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\"\\n }\\n ],\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"GpuMemory\\": 2048,\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"testProject\\",\\n \\"Channel\\": \\"Enterprise\\",\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.xxxx\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.xxxx\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": \\"100\\",\\n \\"ReleaseNoteEn\\": \\"Release note\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\",\\n \\"NewDcdVersion\\": \\"\\"\\n },\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"UserCustomName\\": \\"testDesktop\\",\\n \\"ManagementFlags\\": [\\n \\"UPDATING\\"\\n ],\\n \\"LocalName\\": \\"华东2(上海)\\",\\n \\"RealDesktopId\\": \\"ecd-gx2x1dhsm****\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"NoConnectShutdown\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1\\",\\n \\"Interval\\": 60,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_BOTH\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"SHUTDOWN\\",\\n \\"ExecutionTime\\": \\"2021-12-31T15:59Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"Os\\": \\"Windows\\",\\n \\"RegionLocation\\": \\"\\",\\n \\"OsDescription\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeGlobalDesktops',
+ 'summary' => 'Queries the details of cloud computers. Currently, only the region corresponding to the Chinese mainland can be queried (excluding: Nanjing-local region-shutting down).',
+ 'description' => '* This API is a centralized domain name. The endpoint is in the China (Shanghai) region. You cannot call this API operation in other regions.'."\n"
+ .'* The cloud computer status information in this interface has a delay of 1 to 3 seconds from the actual value.'."\n",
+ ],
+ 'DescribeUserResources' => [
+ 'summary' => 'Queries user resources.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '169949',
+ 'abilityTreeNodes' => [
+ 'FEATUREgwsENR35V',
+ ],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client. This parameter is non-sensitive and does not need encryption.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****',
+ ],
+ ],
+ [
+ 'name' => 'ClientType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* html5: the web client.'."\n"
+ .'* android: the Android client.'."\n"
+ .'* windows: the Windows client.'."\n"
+ .'* ios: the iOS client.'."\n"
+ .'* macos: the macOS client.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'html5' => '',
+ 'android' => '',
+ 'windows' => '',
+ 'ios' => '',
+ 'macos' => '',
+ ],
+ 'example' => 'windows',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '客户端版本',
+ 'description' => 'The client version.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '7.6.0-R-20241112.222305',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token. You can call the `GetLoginToken` or `RefreshLoginToken` operation to retrieve the logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID. You can call the `GetLoginToken` operation to retrieve the session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'LoginRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '登录的地域ID,用于工作区ID登录场景。',
+ 'description' => 'The ID of the region where end users log on to clients. This parameter applies to office network ID-based logons. For organization ID-based logons, you can leave this parameter empty.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'SearchRegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud resources in specific regions.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '工作区ID列表。',
+ 'description' => 'The office network IDs. This parameter is required for logons by using enterprise Active Directory (AD) accounts.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '工作区ID。',
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-5440****',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ResourceTypes',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '资源类型列表,为空则查询所有资源类型。'."\n"
+ .'可选范围:'."\n"
+ .'云桌面:Desktop'."\n"
+ .'桌面组:DesktopGroup'."\n"
+ .'云应用:App '."\n"
+ .'云盘:CloudDrive',
+ 'description' => 'The resource types. If you leave this parameter empty, resources of all supported types will be queried.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '资源类型',
+ 'description' => 'The resource type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n"
+ .'* Desktop: cloud computers.'."\n"
+ .'* DesktopGroup: cloud computer shares.'."\n"
+ .'* CloudDrive: enterprise drives.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'App' => '',
+ 'Desktop' => '',
+ 'DesktopGroup' => '',
+ 'CloudDrive' => '',
+ ],
+ 'example' => 'Desktop',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'ProductTypes',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '产品类型列表,为空则查询所有产品类型。'."\n"
+ .'可选范围:'."\n"
+ .'CloudApp:云应用'."\n"
+ .'CloudBrowser:云浏览器'."\n"
+ ."\0".'AndroidCloud:云手机'."\n"
+ .'CloudDesktop:云电脑'."\n"
+ .'ImageBuilder:VHD Builder'."\n"
+ .'ImageValidate:VHD 验证',
+ 'description' => 'The service types. If you leave this parameter empty, services of all supported types will be queried.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '产品类型',
+ 'description' => 'The service type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n"
+ .'* CloudApp: App Streaming.'."\n"
+ .'* CloudBrowser: Cloud Browser.'."\n"
+ .'* AndroidCloud: Cloud Phone.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'CloudDesktop' => '',
+ 'CloudApp' => '',
+ 'CloudBrowser' => '',
+ 'AndroidCloud' => '',
+ ],
+ 'example' => 'CloudApp',
+ ],
+ 'required' => false,
+ 'maxItems' => 5,
+ ],
+ ],
+ [
+ 'name' => 'ResourceIds',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'title' => '资源ID列表。'."\n"
+ .'可设置0~100个。',
+ 'description' => 'The resource IDs. You can specify up to 100 resource IDs.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '资源ID',
+ 'description' => 'The resource ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-00001',
+ ],
+ 'required' => false,
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ResourceName',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源名称,支持模糊搜索。',
+ 'description' => 'The resource name. Fuzzy search is supported.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'testName',
+ ],
+ ],
+ [
+ 'name' => 'ProtocolType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '协议类型。该参数仅用于过滤云桌面。支持范围:'."\n"
+ .'- HDX(HDX协议)'."\n"
+ .'- ASP(阿里巴巴自研ASP协议 [推荐])',
+ 'description' => 'The protocol type. You can specify this parameter to filter cloud computers.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* HDX: High-definition Experience (HDX).'."\n"
+ .'* ASP: Adaptive Streaming Protocol (ASP).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ ],
+ [
+ 'name' => 'AccessType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '接入类型,不传表示两种都显示。'."\n"
+ .'取值范围:'."\n"
+ .'互联网:INTERNET'."\n"
+ .'专线:VPC',
+ 'description' => 'The access type. If you leave this parameter empty, both types will be displayed.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* INTERNET: access over the Internet.'."\n"
+ .'* VPC: access over an enterprise virtual private cloud (VPC).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'INTERNET' => '',
+ 'VPC' => '',
+ ],
+ 'example' => 'INTERNET',
+ ],
+ ],
+ [
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '客户端语言。',
+ 'description' => 'The client language.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* en_US: English.'."\n"
+ .'* zh_CN: Simplified Chinese.'."\n"
+ .'* ja_JP: Japanese.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'en_US' => '',
+ 'zh_CN' => '',
+ 'ja_JP' => '',
+ ],
+ 'example' => 'zh-CN',
+ ],
+ ],
+ [
+ 'name' => 'CategoryType',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源一级类目。',
+ 'description' => 'The level-1 resource category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '资源二级类目',
+ 'description' => 'The level-2 resource category.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '0',
+ ],
+ ],
+ [
+ 'name' => 'QueryFotaUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to return the image version information of cloud computers.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ 'default' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'RefreshFotaUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否实时刷新OTA信息。',
+ 'description' => 'Specifies whether to refresh over-the-air (OTA) information in real time.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sorting field. If you do not specify this parameter, resources are sorted by creation time by default.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* CreateTime: the time when resources are created.'."\n"
+ .'* AssignTime: the time when resources are assigned.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'CreateTime' => '',
+ 'AssignTime' => '',
+ ],
+ 'example' => 'AssignTime',
+ ],
+ ],
+ [
+ 'name' => 'SortType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The sorting method.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* ASC (default): the ascending order.'."\n"
+ .'* DESC: the descending order.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'ASC' => '',
+ 'DESC' => '',
+ ],
+ 'example' => 'ASC',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. Default value: 500.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '500',
+ ],
+ ],
+ [
+ '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' => 'caeba0bbb2be03f84eb48b699f0a4883',
+ ],
+ ],
+ [
+ 'name' => 'AutoRefresh',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否主动刷新。主动刷新按钮则为true,定时刷新则为false。',
+ 'description' => 'Specifies whether to enable the immediate refresh feature.'."\n"
+ ."\n"
+ .'> To ensure the operation response speed, we recommend that you set the value to `false`.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* false'."\n"
+ .'* true'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'false' => '',
+ 'true' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'Scene',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '客户端场景,用于标识排序。',
+ 'description' => 'The client usage scenario. Set the value to `desktop`.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* desktop: cloud computers.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'desktop' => '',
+ ],
+ 'example' => 'desktop',
+ ],
+ ],
+ [
+ 'name' => 'DualCenterForward',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否双中心转发。',
+ 'description' => 'Specifies whether to enable geo-redundant forwarding. Set the value to `false`.'."\n"
+ ."\n"
+ .'Valid value:'."\n"
+ ."\n"
+ .'* false: disables geo-redundant forwarding.'."\n",
+ 'type' => 'boolean',
+ 'deprecated' => true,
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'QueryDesktopTimers',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否查询云电脑定时任务信息,默认为true。',
+ 'description' => '是否查询云电脑定时任务信息,默认为true。',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '是,默认值',
+ 'false' => '否',
+ ],
+ 'example' => 'true',
+ 'default' => 'true',
+ ],
+ ],
+ [
+ 'name' => 'QueryDesktopDurationList',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '是否查询云桌面套餐包信息,默认为true。',
+ 'description' => '是否查询云桌面套餐包信息,默认为true。',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '是,默认值',
+ 'false' => '否',
+ ],
+ 'example' => 'true',
+ 'default' => 'true',
+ ],
+ ],
+ ],
+ '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' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'QueryFailedResourceTypes' => [
+ 'title' => '查询失败的资源类型列表。取值范围:'."\n"
+ .'CloudDesktop:云桌面(含云电脑和云电脑池)'."\n"
+ .'CloudApp:云应用'."\n"
+ .'CloudDrive:云盘',
+ 'description' => 'The resource types that failed to be queried.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The resource type that failed to be queried.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n"
+ .'* CloudApp: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n"
+ .'* CloudDrive: enterprise drives.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'CloudDesktop' => '',
+ 'CloudApp' => '',
+ 'CloudDrive' => '',
+ ],
+ 'example' => 'CloudDesktop',
+ ],
+ 'enumValueTitles' => [],
+ ],
+ 'Resources' => [
+ 'title' => '资源详细信息列表。',
+ 'description' => 'The resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '资源详细信息',
+ 'description' => 'The resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'AliUid' => [
+ 'description' => 'The ID of the Alibaba Cloud account.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '194101959****',
+ ],
+ 'ResourceType' => [
+ 'title' => '资源类型。取值范围:'."\n"
+ .'云桌面:Desktop'."\n"
+ .'桌面组:DesktopGroup'."\n"
+ .'云应用:App '."\n"
+ .'云盘:CloudDrive',
+ 'description' => 'The resource type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n"
+ .'* Desktop: cloud computers.'."\n"
+ .'* DesktopGroup: cloud computer shares.'."\n"
+ .'* CloudDrive: enterprise drives.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'App' => '',
+ 'Desktop' => '',
+ 'DesktopGroup' => '',
+ 'CloudDrive' => '',
+ ],
+ 'example' => 'Desktop',
+ ],
+ 'RegionId' => [
+ 'title' => '地域ID。',
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou',
+ ],
+ 'RegionLocation' => [
+ 'title' => '地域位置。',
+ 'description' => 'The geographical location.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Mainland: regions in the Chinese mainland.'."\n"
+ .'* Overseas: regions outside the Chinese mainland, including China (Hong Kong).'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Mainland' => '',
+ 'Overseas' => '',
+ ],
+ 'example' => 'Mainland',
+ ],
+ 'ResourceGroupId' => [
+ 'title' => '资源组ID。',
+ 'description' => 'The resource group ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'dg-0****',
+ ],
+ 'ResourceId' => [
+ 'title' => '资源ID。',
+ 'description' => 'The resource ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd-d19tya8zi4****',
+ ],
+ 'ResourceLevel' => [
+ 'title' => '资源级别。'."\n"
+ .'取值范围:'."\n"
+ .'中心:Center'."\n"
+ .'单元:Region',
+ 'description' => 'The resource level.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Center: a centralized resource.'."\n"
+ .'* Region: a unit resource.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Center' => '',
+ 'Region' => '',
+ ],
+ 'example' => 'Center',
+ ],
+ 'CenterResourceId' => [
+ 'title' => '中心化资源ID。',
+ 'description' => 'The ID of the centralized resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecds-0****',
+ ],
+ 'ResourceName' => [
+ 'title' => '资源名称。',
+ 'description' => 'The resource name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testName01',
+ ],
+ 'CreateTime' => [
+ 'title' => '资源创建时间。',
+ 'description' => 'The time when the resource was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2024-12-11T07:12:12Z',
+ ],
+ 'ProductType' => [
+ 'title' => '产品类型。'."\n"
+ .'CloudDesktop - 云桌面'."\n"
+ .'CloudApp - 云应用'."\n"
+ .'AndroidCloud - 安卓云',
+ 'description' => 'The service type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n"
+ .'* CloudApp: App Streaming'."\n"
+ .'* CloudBrowser: Cloud Browser.'."\n"
+ .'* AndroidCloud: Cloud Phone.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'CloudDesktop' => '',
+ 'CloudApp' => '',
+ 'CloudBrowser' => '',
+ 'AndroidCloud' => '',
+ ],
+ 'example' => 'AndroidCloud',
+ ],
+ 'OfficeSiteId' => [
+ 'title' => '工作区ID。',
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-shanghai+dir-3367****',
+ ],
+ 'AccessType' => [
+ 'title' => '接入类型。'."\n"
+ .'取值范围:'."\n"
+ .'- INTERNET(互联网)'."\n"
+ .'- VPC(企业专网)'."\n"
+ .'- ANY(互联网和企业专网均可以)',
+ 'description' => 'The access type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* INTERNET: access over the Internet.'."\n"
+ .'* VPC: access over an enterprise VPC.'."\n"
+ .'* ANY: access over the Internet or an enterprise VPC.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'INTERNET' => '',
+ 'VPC' => '',
+ 'ANY' => '',
+ ],
+ 'example' => 'INTERNET',
+ ],
+ 'ProtocolType' => [
+ 'title' => '协议类型。取值范围:'."\n"
+ .'- HDX(HDX协议)'."\n"
+ .'- ASP(阿里巴巴自研ASP协议)',
+ 'description' => 'The protocol type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* HDX'."\n"
+ .'* ASP'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'HDX' => '',
+ 'ASP' => '',
+ ],
+ 'example' => 'ASP',
+ ],
+ 'OsType' => [
+ 'title' => '操作系统类型。取值范围:'."\n"
+ .'-Windows'."\n"
+ .'-Linux'."\n"
+ .'-Android',
+ 'description' => 'The OS type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Linux'."\n"
+ .'* Windows'."\n"
+ .'* Android'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Linux' => 'Linux',
+ 'Windows' => 'Windows',
+ 'Android' => 'Android',
+ ],
+ 'example' => 'Windows',
+ ],
+ 'Os' => [
+ 'title' => '操作系统平台信息。',
+ 'description' => 'The OS platform.'."\n",
+ 'type' => 'string',
+ 'example' => 'Windows Server 2022',
+ ],
+ 'OsDescription' => [
+ 'title' => '操作系统平台描述信息。',
+ 'description' => 'The description of the OS platform.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'SupportHibernation' => [
+ 'title' => '是否支持休眠。',
+ 'description' => 'Indicates whether hibernation is supported.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ 'HibernationBeta' => [
+ 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* true'."\n"
+ .'* false'."\n",
+ 'type' => 'boolean',
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ 'SessionType' => [
+ 'title' => '会话类型。SINGLE_SESSION代表单会话,MULTIPLE_SESSION代表多会话。',
+ 'description' => 'The session type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* SINGLE_SESSION'."\n"
+ .'* MULTIPLE_SESSION'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'SINGLE_SESSION' => '',
+ 'MULTIPLE_SESSION' => '',
+ ],
+ 'example' => 'SINGLE_SESSION',
+ ],
+ 'ChargeType' => [
+ 'title' => '计费方式。取值范围:'."\n"
+ .'- PostPaid(按量付费 [默认值])'."\n"
+ .'- PrePaid(包年包月)',
+ 'description' => 'The billing method.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Postpaid (default): pay-as-you-go.'."\n"
+ .'* PrePaid: subscription.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'PostPaid' => '',
+ 'PrePaid' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ 'SubPayType' => [
+ 'title' => '子计费方式。取值范围:'."\n"
+ .'- monthPackage(按月预付费模块)'."\n"
+ .'- PrePaid(时长包)',
+ 'description' => 'The sub-billing method.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* monthPackage: monthly subscription.'."\n"
+ .'* PrePaid: hourly plans.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'monthPackage' => '',
+ 'PrePaid' => '',
+ ],
+ 'example' => 'PrePaid',
+ ],
+ 'ExpiredTime' => [
+ 'title' => '包年包月付费类型资源的到期时间。',
+ 'description' => 'The expiration time of the subscription resource.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-02-22T16:00:00Z',
+ ],
+ 'AuthMode' => [
+ 'title' => '云应用授权模式。取值范围:'."\n"
+ .'App:应用授权'."\n"
+ .'Session:会话授权'."\n"
+ .'AppInstanceGroup:交付组授权'."\n",
+ 'description' => 'The authorization mode of the cloud app.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* App: authorizes access to apps.'."\n"
+ .'* AppInstanceGroup: authorizes access to delivery groups.'."\n"
+ .'* Session: authorizes access to sessions.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'App' => '',
+ 'AppInstanceGroup' => '',
+ 'Session' => '',
+ ],
+ 'example' => 'App',
+ ],
+ 'AppId' => [
+ 'title' => '应用ID。',
+ 'description' => 'The app ID. This parameter is for apps only.'."\n",
+ 'type' => 'string',
+ 'example' => 'app-0001',
+ ],
+ 'Version' => [
+ 'title' => '资源版本。',
+ 'description' => 'The resource version. This parameter is for apps only.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'CategoryType' => [
+ 'title' => '资源一级类目。',
+ 'description' => 'The level-1 resource category. This parameter is for apps only.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'CategoryId' => [
+ 'description' => 'The level-2 resource category. This parameter is for apps only.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '0',
+ ],
+ 'Icon' => [
+ 'title' => '资源图标链接。',
+ 'description' => 'The resource icon. This parameter is for apps only.'."\n",
+ 'type' => 'string',
+ 'example' => 'http://example.com/icon.png',
+ ],
+ 'ThemeColor' => [
+ 'title' => '资源主题颜色。',
+ 'description' => 'The theme color of the resource. This parameter is for apps only.'."\n",
+ 'type' => 'string',
+ 'example' => '#FFFFFF',
+ ],
+ 'CdsName' => [
+ 'title' => '网盘名称。',
+ 'description' => 'The drive name. This parameter is for enterprise drives only.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-shanghai+cds-695277****',
+ ],
+ 'ExternalDomainId' => [
+ 'title' => '外部Domain ID。',
+ 'description' => 'The ID of the external domain. This parameter is for enterprise drives only.'."\n",
+ 'type' => 'string',
+ 'example' => 'stg114510',
+ ],
+ 'ExternalUserId' => [
+ 'title' => '外部用户ID。',
+ 'description' => 'The ID of the external user. This parameter is for enterprise drives only.'."\n",
+ 'type' => 'string',
+ 'example' => 'test001',
+ ],
+ 'GlobalStatus' => [
+ 'title' => '是否支持跨地域访问。',
+ 'description' => 'Indicates whether cross-region access is supported. This parameter is for enterprise drives only.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'LocalName' => [
+ 'title' => '地域名称。',
+ 'description' => 'The region name.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'DesktopTimers' => [
+ 'title' => '桌面定时任务设置列表。',
+ 'description' => 'The scheduled tasks for cloud computers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '桌面定时任务设置。',
+ 'description' => 'The scheduled task.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'TimerType' => [
+ 'title' => '任务类型。',
+ 'description' => 'The task type.'."\n",
+ 'type' => 'string',
+ 'example' => 'TimerBoot',
+ ],
+ 'CronExpression' => [
+ 'title' => '定时任务的Cron表达式。',
+ 'description' => 'The cron expression specified in the scheduled task.'."\n",
+ 'type' => 'string',
+ 'example' => '0 30 13 ? * 1-7',
+ ],
+ 'Interval' => [
+ 'title' => '定时任务间隔时间。',
+ 'description' => 'The interval at which the scheduled task is executed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '15',
+ ],
+ 'Enforce' => [
+ 'title' => '是否强制执行。',
+ 'description' => 'Indicates whether to forcibly execute the scheduled task.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ResetType' => [
+ 'title' => '重置类型。',
+ 'description' => 'The reset option.'."\n",
+ 'type' => 'string',
+ 'example' => 'RESET_TYPE_SYSTEM',
+ ],
+ 'AllowClientSetting' => [
+ 'title' => '是否允许客户端设置',
+ 'description' => 'Indicates whether to allow end users to configure scheduled tasks on clients.'."\n",
+ 'type' => 'string',
+ 'example' => 'false',
+ ],
+ 'OperationType' => [
+ 'title' => '操作类型',
+ 'description' => 'The type of the scheduled action.'."\n",
+ 'type' => 'string',
+ 'example' => 'Hibernate',
+ ],
+ 'ExecutionTime' => [
+ 'title' => '执行时间',
+ 'description' => 'The time when the scheduled task is executed.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-21T11:37Z',
+ ],
+ ],
+ ],
+ ],
+ 'Clients' => [
+ 'title' => '资源支持的客户端类型列表。',
+ 'description' => 'The client types supported by resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '资源支持的单类客户端类型设置信息。',
+ 'description' => 'The client type supported by resources.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'ClientType' => [
+ 'title' => '客户端类型。',
+ 'description' => 'The client type.'."\n",
+ 'type' => 'string',
+ 'example' => 'windows',
+ ],
+ 'Status' => [
+ 'title' => '支持状态。',
+ 'description' => 'The status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* OFF'."\n"
+ .'* ON'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'OFF' => '',
+ 'ON' => '',
+ ],
+ 'example' => 'ON',
+ ],
+ ],
+ ],
+ ],
+ 'ResourceStatus' => [
+ 'title' => '资源状态。',
+ 'description' => 'The resource status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Unknown: The resource status is unknown.'."\n"
+ .'* Stopped: The resource is stopped.'."\n"
+ .'* Failed: The resource failed to be created.'."\n"
+ .'* Starting: The resource is being started.'."\n"
+ .'* Rebuilding: The resource is changing.'."\n"
+ .'* Running: The resource is running.'."\n"
+ .'* Stopping: The resource is being stopped.'."\n"
+ .'* FotaUpdating: The image is being updated.'."\n"
+ .'* Pending: The resource is still being prepared.'."\n"
+ .'* Deleting: The resource is being deleted.'."\n"
+ .'* Unavailable: The resource is unavailable.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Unknown' => '',
+ 'Stopped' => '',
+ 'Failed' => '',
+ 'Starting' => '',
+ 'Rebuilding' => '',
+ 'Running' => '',
+ 'Stopping' => '',
+ 'FotaUpdating' => '',
+ 'Pending' => '',
+ 'Deleting' => '',
+ 'Unavailable' => '',
+ ],
+ 'example' => 'Running',
+ ],
+ 'LastStartTime' => [
+ 'title' => '资源上次启动时间。',
+ 'description' => 'The time when the resource was last started.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-24T03:12:04Z',
+ ],
+ 'OrderStatus' => [
+ 'title' => '订单状态。',
+ 'description' => 'The order status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Ceased: Your account has an overdue payment.'."\n"
+ .'* Released: The order is closed.'."\n"
+ .'* Expired: The subscription resource has expired.'."\n"
+ .'* Normal: The order is normal.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Ceased' => '',
+ 'Released' => '',
+ 'Expired' => '',
+ 'Normal' => '',
+ ],
+ 'example' => 'Normal',
+ ],
+ 'ManagementStatuses' => [
+ 'title' => '管理状态列表。',
+ 'description' => 'The management status.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '管理状态',
+ 'description' => 'The management state.'."\n",
+ 'type' => 'string',
+ 'example' => 'NoFlag',
+ ],
+ ],
+ 'ResourceSessionStatus' => [
+ 'title' => '会话状态。',
+ 'description' => 'The session status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Unknown'."\n"
+ .'* Connected'."\n"
+ .'* Disconnected'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Unknown' => '',
+ 'Connected' => '',
+ 'Disconnected' => '',
+ ],
+ 'example' => 'Connected',
+ ],
+ 'Sessions' => [
+ 'description' => 'The sessions established between users and resources.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The session established between the user and the resource.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'UserId' => [
+ 'title' => '登录资源的用户名。',
+ 'description' => 'The username used to log on to the resource.'."\n",
+ 'type' => 'string',
+ 'example' => 'user001',
+ ],
+ 'UserPrincipalName' => [
+ 'title' => '绑定资源的用户的UPN(如果有),只有当前查询用户的Session该值才可能有值。',
+ 'description' => 'The User Principal Name (UPN) of the resource-bound user (if applicable). This parameter is returned only when you query the current user\'s sessions.'."\n",
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'ResourceSessionStartTime' => [
+ 'title' => '资源会话连接的时间。',
+ 'description' => 'The timestamp when the resource session was established.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-22T11:03:36Z',
+ ],
+ 'NickName' => [
+ 'title' => '用户的昵称。',
+ 'description' => '用户的昵称。',
+ 'type' => 'string',
+ 'example' => 'user-001',
+ ],
+ ],
+ ],
+ ],
+ 'RealDesktopId' => [
+ 'title' => '【桌面组】真实桌面ID,当桌面组存在会话时存在。',
+ 'description' => 'The real ID of the cloud computer (from a share). This parameter is returned only when the cloud computer share has ongoing sessions.'."\n",
+ 'type' => 'string',
+ 'example' => 'ecd-0001',
+ ],
+ 'UserCustomName' => [
+ 'title' => '用户自定义名称。',
+ 'description' => 'The custom name of the resource.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'FotaUpdate' => [
+ 'title' => '',
+ 'description' => 'The update info of the cloud computer.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Project' => [
+ 'description' => 'The project name.'."\n",
+ 'type' => 'string',
+ 'example' => 'wuying-asp_single_session_desktop_win_x64',
+ ],
+ 'Channel' => [
+ 'description' => 'The channel.'."\n",
+ 'type' => 'string',
+ 'example' => 'aliyun',
+ ],
+ 'CurrentAppVersion' => [
+ 'description' => 'The current version number of the cloud computer\'s image.'."\n",
+ 'type' => 'string',
+ 'example' => '2.7.0-R-20250122.154826',
+ ],
+ 'NewAppVersion' => [
+ 'description' => 'The target version number of the cloud computer\'s image.'."\n",
+ 'type' => 'string',
+ 'example' => '2.7.0-R-20250125.154826',
+ ],
+ 'Force' => [
+ 'description' => 'Specifies whether to implement a forced update.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'false',
+ ],
+ 'ReleaseNote' => [
+ 'description' => 'The version description of the cloud computer\'s image.'."\n",
+ 'type' => 'string',
+ 'example' => 'up',
+ ],
+ 'Size' => [
+ 'description' => 'The size of the update package for the cloud computer image. Unit: KB.'."\n",
+ 'type' => 'string',
+ 'example' => '474981930',
+ ],
+ 'ReleaseNoteEn' => [
+ 'title' => '',
+ 'description' => 'The English release note for the new image version.'."\n",
+ 'type' => 'string',
+ 'example' => 'up',
+ ],
+ 'ReleaseNoteJp' => [
+ 'description' => 'The Japanese release note for the new image version.'."\n",
+ 'type' => 'string',
+ 'example' => 'up',
+ ],
+ 'NewDcdVersion' => [
+ 'description' => 'The latest version available for updating the component disk.'."\n",
+ 'type' => 'string',
+ 'example' => '2.6.9-R-20250123.153415',
+ ],
+ ],
+ ],
+ 'OsUpdate' => [
+ 'description' => 'The update info of the OS.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'CheckId' => [
+ 'description' => 'The ID of the check task.'."\n",
+ 'type' => 'string',
+ 'example' => 'wua-1740652957251743***',
+ ],
+ 'PackageCount' => [
+ 'description' => 'The number of packets.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'Packages' => [
+ 'description' => 'The patch packages.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The patch package.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Kb' => [
+ 'description' => 'The patch number.'."\n",
+ 'type' => 'string',
+ 'example' => 'KB2267***',
+ ],
+ 'Title' => [
+ 'description' => 'The patch title.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ 'Description' => [
+ 'description' => 'The patch description.'."\n",
+ 'type' => 'string',
+ 'example' => '',
+ ],
+ ],
+ ],
+ ],
+ 'KbListString' => [
+ 'description' => 'The patch numbers.'."\n",
+ 'type' => 'string',
+ 'example' => 'KB2267***',
+ ],
+ 'UpdateCatalogUrl' => [
+ 'description' => 'The update categorization URL.'."\n",
+ 'type' => 'string',
+ 'example' => 'https://catalog.update.microsoft.com/home.aspx',
+ ],
+ ],
+ ],
+ 'HasUpgrade' => [
+ 'description' => 'Indicates whether an update exists.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'true',
+ ],
+ 'DesktopDurationList' => [
+ 'description' => 'The cloud computer plans.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The cloud computer plan.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'PackageCreationTime' => [
+ 'title' => '创建时间',
+ 'description' => 'The time when the package was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-17T07:01Z',
+ ],
+ 'PackageStatus' => [
+ 'title' => '状态。',
+ 'description' => 'The package status.'."\n",
+ 'type' => 'string',
+ 'example' => 'Available',
+ ],
+ 'UsedDuration' => [
+ 'title' => '已使用时长',
+ 'description' => 'The subscription duration consumed.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '16850',
+ ],
+ 'PackageExpiredTime' => [
+ 'title' => '过期时间',
+ 'description' => 'The expiration time of the package.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-02-17T15:59Z',
+ ],
+ 'PackageId' => [
+ 'title' => '套餐包ID。',
+ 'description' => 'The package ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'mdp-0bxls4qpi6bl6****',
+ ],
+ 'TotalDuration' => [
+ 'title' => '总时长',
+ 'description' => 'The total duration.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '432000',
+ ],
+ 'PackageType' => [
+ 'title' => '时长包类型'."\n"
+ .' * Duration:时长包'."\n"
+ .' * NORMAL_PACKAGE:付费包(120小时包)'."\n"
+ .' * POSTPAID_PACKAGE:用于记录后付费额度包(200小时包)'."\n"
+ .' * FREE_PACKAGE:免费包',
+ 'description' => 'The package type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* FREE_PACKAGE: a free package.'."\n"
+ .'* NORMAL_PACKAGE: a paid package (120-hour computing plan).'."\n"
+ .'* POSTPAID_PACKAGE: a pay-as-you-go package (200-hour computing plan).'."\n"
+ .'* Duration: an hourly package.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'FREE_PACKAGE' => '',
+ 'NORMAL_PACKAGE' => '',
+ 'POSTPAID_PACKAGE' => '',
+ 'Duration' => '',
+ ],
+ 'example' => 'NORMAL_PACKAGE',
+ ],
+ 'PeriodStartTime' => [
+ 'title' => '当月包开始时间',
+ 'description' => 'The package\'s effective start time for the current month.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-01-17T07:01Z',
+ ],
+ 'PeriodEndTime' => [
+ 'title' => '当月包结束时间',
+ 'description' => 'The package\'s effective end time for the current month.'."\n",
+ 'type' => 'string',
+ 'example' => '2025-02-17T15:59Z',
+ ],
+ 'PostPaidLimitFee' => [
+ 'title' => '第二阶段包的封顶金额'."\n"
+ .' * 仅ResourceType为POSTPAID_PACKAG 和 FREE_PACKAGE时会返回',
+ 'description' => 'The maximum fee for the package in the second phase.'."\n"
+ ."\n"
+ .'> This parameter is returned if you set ResourceType to `POSTPAID_PACKAG` or `FREE_PACKAGE`.'."\n",
+ 'type' => 'number',
+ 'format' => 'float',
+ 'example' => '199',
+ ],
+ 'OrderInstanceId' => [
+ 'title' => '订单实例ID',
+ 'description' => 'The ID of the instance order.'."\n",
+ 'type' => 'string',
+ 'example' => 'mdp-0bxls4qpi6bl6****',
+ ],
+ 'PackageUsedUpStrategy' => [
+ 'title' => '包用尽策略'."\n"
+ .' * "Postpaid" //用尽扣费'."\n"
+ .' * "Shutdown" //用尽关机或休眠',
+ 'description' => 'The policy for the cloud computer status once the monthly package quota is exhausted.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* Shutdown: The cloud computer enters the Stopped or Hibernated state.'."\n"
+ .'* PostPaid: The cloud computer continues providing services that are billed on the pay-as-you-go basis.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Shutdown' => '',
+ 'Postpaid' => '',
+ ],
+ 'example' => 'Postpaid',
+ ],
+ ],
+ ],
+ ],
+ 'ConnectionProperties' => [
+ 'title' => '连接属性,JSON格式。',
+ 'description' => 'The connection attributes in JSON format. The client does not need to process the attributes; they are directly passed to the resource management center when the app resource is created.'."\n",
+ 'type' => 'string',
+ 'example' => '{"authMode":"App"}',
+ ],
+ 'SupportedActions' => [
+ 'title' => '支持的操作类型列表,目前只支持安卓云。',
+ 'description' => 'The supported actions. This parameter is returned only for cloud computers or phones.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '操作类型。',
+ 'description' => 'The support action.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* WakeUp: wakes up cloud computers or cloud phones.'."\n"
+ .'* Hibernate: hibernates cloud computers or cloud phones.'."\n"
+ .'* Start: starts cloud computers or cloud phones.'."\n"
+ .'* Stop: stops cloud computers or cloud phones.'."\n"
+ .'* Restart: restarts cloud computers or cloud phones.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'WakeUp' => '',
+ 'Hibernate' => '',
+ 'Start' => '',
+ 'Stop' => '',
+ 'Restart' => '',
+ ],
+ 'example' => 'Start',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'RankVersion' => [
+ 'title' => '排序数据版本号。',
+ 'description' => 'The version number of the ranking data.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1732869815062',
+ ],
+ 'TotalCount' => [
+ 'title' => '总数。',
+ 'description' => '总数。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '10',
+ ],
+ 'MaxResults' => [
+ 'title' => '返回最大数量。',
+ 'description' => '返回最大数量。',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QueryFailedResourceTypes\\": [\\n \\"CloudDesktop\\"\\n ],\\n \\"Resources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"Desktop\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionLocation\\": \\"Mainland\\",\\n \\"ResourceGroupId\\": \\"dg-0****\\",\\n \\"ResourceId\\": \\"ecd-d19tya8zi4****\\",\\n \\"ResourceLevel\\": \\"Center\\",\\n \\"CenterResourceId\\": \\"ecds-0****\\",\\n \\"ResourceName\\": \\"testName01\\",\\n \\"CreateTime\\": \\"2024-12-11T07:12:12Z\\",\\n \\"ProductType\\": \\"AndroidCloud\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-3367****\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"Os\\": \\"Windows Server 2022\\",\\n \\"OsDescription\\": \\"Windows 正版授权\\",\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": false,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SubPayType\\": \\"PrePaid\\",\\n \\"ExpiredTime\\": \\"2025-02-22T16:00:00Z\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"AppId\\": \\"app-0001\\",\\n \\"Version\\": \\"资源版本。\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 0,\\n \\"Icon\\": \\"http://example.com/icon.png\\",\\n \\"ThemeColor\\": \\"#FFFFFF\\",\\n \\"CdsName\\": \\"cn-shanghai+cds-695277****\\",\\n \\"ExternalDomainId\\": \\"stg114510\\",\\n \\"ExternalUserId\\": \\"test001\\",\\n \\"GlobalStatus\\": true,\\n \\"LocalName\\": \\"华东1(杭州)\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 30 13 ? * 1-7\\",\\n \\"Interval\\": 15,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": \\"false\\",\\n \\"OperationType\\": \\"Hibernate\\",\\n \\"ExecutionTime\\": \\"2025-01-21T11:37Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"ClientType\\": \\"windows\\",\\n \\"Status\\": \\"ON\\"\\n }\\n ],\\n \\"ResourceStatus\\": \\"Running\\",\\n \\"LastStartTime\\": \\"2025-01-24T03:12:04Z\\",\\n \\"OrderStatus\\": \\"Normal\\",\\n \\"ManagementStatuses\\": [\\n \\"NoFlag\\"\\n ],\\n \\"ResourceSessionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"UserId\\": \\"user001\\",\\n \\"UserPrincipalName\\": \\"[email protected]\\",\\n \\"ResourceSessionStartTime\\": \\"2025-01-22T11:03:36Z\\",\\n \\"NickName\\": \\"user-001\\"\\n }\\n ],\\n \\"RealDesktopId\\": \\"ecd-0001\\",\\n \\"UserCustomName\\": \\"我的云电脑\\",\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"wuying-asp_single_session_desktop_win_x64\\",\\n \\"Channel\\": \\"aliyun\\",\\n \\"CurrentAppVersion\\": \\"2.7.0-R-20250122.154826\\",\\n \\"NewAppVersion\\": \\"2.7.0-R-20250125.154826\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"新版本\\",\\n \\"Size\\": \\"474981930\\",\\n \\"ReleaseNoteEn\\": \\"new version\\",\\n \\"ReleaseNoteJp\\": \\"新バージョン\\",\\n \\"NewDcdVersion\\": \\"2.6.9-R-20250123.153415\\"\\n },\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"wua-1740652957251743***\\",\\n \\"PackageCount\\": 1,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"KB2267***\\",\\n \\"Title\\": \\"用于****的补丁。\\",\\n \\"Description\\": \\"安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装,便无法删除。\\"\\n }\\n ],\\n \\"KbListString\\": \\"KB2267***\\",\\n \\"UpdateCatalogUrl\\": \\"https://catalog.update.microsoft.com/home.aspx\\"\\n },\\n \\"HasUpgrade\\": true,\\n \\"DesktopDurationList\\": [\\n {\\n \\"PackageCreationTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PackageStatus\\": \\"Available\\",\\n \\"UsedDuration\\": 16850,\\n \\"PackageExpiredTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PackageId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"TotalDuration\\": 432000,\\n \\"PackageType\\": \\"NORMAL_PACKAGE\\",\\n \\"PeriodStartTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PeriodEndTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PostPaidLimitFee\\": 199,\\n \\"OrderInstanceId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"PackageUsedUpStrategy\\": \\"Postpaid\\"\\n }\\n ],\\n \\"ConnectionProperties\\": \\"{\\\\\\"authMode\\\\\\":\\\\\\"App\\\\\\"}\\",\\n \\"SupportedActions\\": [\\n \\"Start\\"\\n ]\\n }\\n ],\\n \\"RankVersion\\": 1732869815062,\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 100\\n}","type":"json"}]',
+ 'title' => 'DescribeUserResources',
+ 'description' => 'Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.'."\n",
+ 'responseParamsDescription' => 'This response parameter is not available for all resources. Ensure you know the fields for each resource.'."\n",
+ ],
+ 'UnbindUserDesktop' => [
+ 'summary' => 'Unbinds end users from cloud computers.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'v12307f5e0****',
+ ],
+ ],
+ [
+ 'name' => 'ClientType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client type.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'windows',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '58f96f67-7944-4f97-9342-****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '3b053331-dc98-43d8-b247-****',
+ ],
+ ],
+ [
+ 'name' => 'UserDesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'ud-sdfs****',
+ ],
+ ],
+ [
+ 'name' => 'Force',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to enable forced unbinding.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* true: Even when end users connect to cloud computers, the forced unbinding is still enforced.'."\n"
+ .'* false: Forced unbinding is only enforced when end users are disconnected from cloud computers.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ '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' => 'D5B7CF35-E078-5EBF-A010-****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'IdempotentParameterMismatch',
+ 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]',
+ 'title' => 'UnbindUserDesktop',
+ ],
+ 'GetConnectionTicket' => [
+ 'summary' => 'Retrieves the credential that is used to connect to a cloud computer.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ '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' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the cloud computer connection task.\\'."\n"
+ .'The first time you call the GetConnectionTicket operation, you do not need to configure this parameter. When you call the GetConnectionTicket operation later, set this parameter to the value of the `TaskId` parameter returned from the previous invocation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2afbad19-778a-4fc5-9674-1f19c638****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud compute ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.18363 x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2.1.0-R-20210731.151756',
+ ],
+ ],
+ [
+ 'name' => 'ClientType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the client.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* html5: web client'."\n"
+ .'* Linux: self-developed hardware terminal'."\n"
+ .'* android: Android client'."\n"
+ .'* windows: Windows client'."\n"
+ .'* ios: iOS client'."\n"
+ .'* macos: macOS client'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'html5' => '',
+ 'linux' => '',
+ 'android' => '',
+ 'windows' => '',
+ 'ios' => '',
+ 'macos' => '',
+ ],
+ 'example' => 'windows',
+ ],
+ ],
+ [
+ 'name' => 'CommandContent',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'schema' => [
+ 'title' => '乐播需求,获取Tickek成功后自动在session里启动乐播应用。',
+ 'description' => '',
+ '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"
+ .'}',
+ 'maxLength' => 1024000,
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949',
+ ],
+ ],
+ [
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The tags. You can specify 1 to 20 tags.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The tag.'."\n",
+ '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",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestKey',
+ ],
+ 'Value' => [
+ 'description' => 'The tag value. You can specify an empty string as a tag value. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TestValue',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ 'maxItems' => 20,
+ ],
+ ],
+ [
+ 'name' => 'AccessType',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ 'required' => false,
+ ],
+ ],
+ [
+ 'name' => 'TicketBlackList',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'string',
+ ],
+ 'maxItems' => 100,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'TaskStatus' => [
+ 'description' => '',
+ '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 task to connect to the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da',
+ ],
+ 'TaskCode' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********',
+ ],
+ 'TaskMessage' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '2afbad19-778a-4fc5-9674-1f19c638****',
+ ],
+ 'P2PToken' => [
+ 'type' => 'string',
+ ],
+ 'DesktopId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ [
+ 'errorCode' => 'DesktopMemoryHighLoad%s',
+ 'errorMessage' => 'The specified desktop memory high load.',
+ ],
+ [
+ 'errorCode' => 'DesktopCpuHighLoad%s',
+ 'errorMessage' => 'The specified desktop cpu high load.',
+ ],
+ [
+ 'errorCode' => 'InvalidClientIp.Policy',
+ 'errorMessage' => 'Client ip %s is not in white list.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c63862da\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"P2PToken\\": \\"\\",\\n \\"DesktopId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetConnectionTicketResponse>\\n <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>\\n <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TaskStatus>Finished</TaskStatus>\\n</GetConnectionTicketResponse>","errorExample":""}]',
+ 'title' => 'GetConnectionTicket',
+ 'description' => 'The first time you call this operation, the system returns a task ID in the `TaskID` parameter. Use the task ID indicated in the `TaskID` parameter to continue calling this operation until the value of the `TaskStatus` parameter becomes `FINISHED` or `FAILED`. When `TaskStatus` becomes `FINISHED`, the value of the `Ticket` parameter is the ticket that is used to connect the client to the cloud computer.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StartDesktops' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client). The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operating system (OS) of the device that run the client.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.18363 x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client version. If you use a WUYING client, you can click **About** on the client logon page to view the version of the client.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => ' 2.1.0-R-20210731.151756',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The ID of the cloud computer.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-cg27ufmapab08****',
+ ],
+ 'required' => true,
+ 'example' => 'ecd-cg27ufmapab08****',
+ 'maxItems' => 100,
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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 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~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UUID of the client.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '71F6A700735E74A61161A53F0C47****',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","errorExample":""}]',
+ 'title' => 'StartDesktops',
+ 'summary' => 'Start cloud computers.',
+ 'description' => 'The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'StopDesktops' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.18363 x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2.1.0-R-20210731.151756',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 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,
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the 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 do I ensure the idempotence of a request?](~~25693~~)'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '6ce412a8-399f-49f9-9518-66ee028a****',
+ ],
+ ],
+ [
+ 'name' => 'SessionToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40',
+ ],
+ ],
+ [
+ 'name' => 'OsUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ '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":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","errorExample":""}]',
+ 'title' => 'StopDesktops',
+ 'summary' => 'Stops cloud computers.',
+ 'description' => 'The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.'."\n",
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RebootDesktops' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ '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' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.18363 x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2.1.0-R-20210731.151756',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'style' => 'repeatList',
+ 'schema' => [
+ 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 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,
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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 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 do I ensure the idempotence of a request?](~~25693~~)'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '40401e62-5caf-4508-8de7-bf98af12****',
+ ],
+ ],
+ [
+ 'name' => 'SessionToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The UUID of the client.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '91761ED27169E2FC564F29388E2D****',
+ ],
+ ],
+ [
+ 'name' => 'OsUpdate',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'boolean',
+ ],
+ ],
+ ],
+ '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":"<RebootDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</RebootDesktopsResponse>","errorExample":""}]',
+ 'title' => 'RebootDesktops',
+ 'summary' => 'Restart cloud computers.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'ReportSessionStatus' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-beijing',
+ ],
+ ],
+ [
+ 'name' => 'InstanceId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'i-bp167fcodoa90ixn****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2',
+ ],
+ ],
+ [
+ 'name' => 'SessionStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'enumValueTitles' => [
+ 'SessionLogOff' => '',
+ 'DesktopTimerDisconnection' => '',
+ 'SessionReboot' => '',
+ 'DesktopTimerShutdown' => '',
+ 'SessionLock' => '',
+ 'SessionShutdown' => '',
+ 'SessionUnLock' => '',
+ 'DesktopTimerReboot' => '',
+ 'ConsoleConnect' => '',
+ 'SessionLogOn' => '',
+ 'SessionPopup' => '',
+ 'SessionDisconnect' => '',
+ 'ConsoleDisconnect' => '',
+ ],
+ 'example' => 'SessionLogOn',
+ ],
+ ],
+ [
+ 'name' => 'SessionChangeTime',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '9223372036854775807',
+ 'minimum' => '0',
+ 'example' => '1642909143781',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'liming',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]',
+ 'title' => 'ReportSessionStatus',
+ 'summary' => 'Reports session status.',
+ ],
+ 'ApproveFotaUpdate' => [
+ 'summary' => 'Enables OTA updates for cloud computers.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'd4452bd7-88df-4b90-a409-806da674****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '4771b873-c757-4893-973c-7f5beejh****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-138dsptkrt00u****',
+ ],
+ ],
+ [
+ 'name' => 'AppVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The application version.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '0.0.1-D-20220513.14****',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the client. To view the unique identifier of an Alibaba Cloud Workspace client, go to the client logon page and click on "About."'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '28c80e90-f71e-4c23-93d6-1225329c****',
+ ],
+ ],
+ [
+ 'name' => 'TargetStatus',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The state of the cloud computer after the OTA update.'."\n"
+ ."\n"
+ .'> This parameter is not publicly available. After the OTA update is complete, the state of the cloud computer changes to `RUNNING`.'."\n"
+ ."\n"
+ .'* Set the value to running.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'running' => '',
+ ],
+ 'example' => 'running',
+ ],
+ ],
+ ],
+ '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****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'ApproveFotaUpdate',
+ ],
+ 'DescribeSnapshots' => [
+ 'summary' => 'Queries the snapshots that are created based on a cloud computer and the details of the snapshots.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'list',
+ ],
+ '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' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-gx2x1dhsmucyy****',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The snapshot ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 's-2ze81owrnv9pity4****',
+ ],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The number of entries per page. 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.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****',
+ ],
+ ],
+ ],
+ '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' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****',
+ ],
+ 'Snapshots' => [
+ 'description' => 'The snapshots.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreationTime' => [
+ 'description' => 'The time when 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 snapshot status.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* PROGRESSING: The snapshot is being created.'."\n"
+ .'* FAILED: The snapshot failed to be created.'."\n"
+ .'* ACCOMPLISHED: The snapshot is created.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'PROGRESSING' => '',
+ 'FAILED' => '',
+ 'ACCOMPLISHED' => '',
+ ],
+ 'example' => 'ACCOMPLISHED',
+ ],
+ 'SnapshotType' => [
+ 'description' => 'The snapshot type.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* AUTO: an automatic snapshot.'."\n"
+ .'* USER: a manual snapshot.'."\n",
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'AUTO' => '',
+ 'USER' => '',
+ ],
+ 'example' => 'USER',
+ ],
+ 'SnapshotName' => [
+ 'description' => 'The snapshot name.'."\n",
+ 'type' => 'string',
+ 'example' => 'testSnapshotName',
+ ],
+ 'Progress' => [
+ 'description' => 'The progress of creating the cloud computer.'."\n",
+ 'type' => 'string',
+ 'example' => '100%',
+ ],
+ 'Description' => [
+ 'description' => 'The snapshot description.'."\n",
+ 'type' => 'string',
+ 'example' => 'testDescription',
+ ],
+ 'SnapshotId' => [
+ 'description' => 'The snapshot ID.'."\n",
+ 'type' => 'string',
+ 'example' => 's-2zeipxmnhej803x7****',
+ ],
+ 'RemainTime' => [
+ 'description' => 'The remaining time required to complete snapshot creation. Unit: seconds.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '30',
+ ],
+ 'SourceDiskSize' => [
+ 'description' => 'The size 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: a system disk.'."\n"
+ .'* DATA: a data disk.'."\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****',
+ ],
+ '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' => 'Data Disk Backup'."\n",
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ '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 \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeSnapshots',
+ ],
+ 'ResetSnapshot' => [
+ 'summary' => 'Restores the data of a disk from a snapshot.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ '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 list of regions where Elastic Desktop Service (EDS) Enterprise is available.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'SnapshotId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The snapshot ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 's-2zeipxmnhej803x7****',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****',
+ ],
+ ],
+ [
+ 'name' => 'DesktopId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The cloud computer ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'ecd-e964cr92klwqb****',
+ ],
+ ],
+ [
+ 'name' => 'StopDesktop',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to stop the cloud computer.'."\n",
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
+ 'title' => 'ResetSnapshot',
+ ],
+ 'GetCloudDriveServiceMountToken' => [
+ 'summary' => 'Retrieves the logon tokens for enterprise drives.',
+ 'methods' => [
+ 'get',
+ 'post',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-7186763****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****',
+ ],
+ 'Token' => [
+ 'description' => 'The tokens.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Token' => [
+ 'description' => 'The token.'."\n",
+ 'type' => 'string',
+ 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****',
+ ],
+ 'ExpiredAfter' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '2022-10-10T04:41:35Z',
+ ],
+ 'UsedSize' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '605089',
+ ],
+ 'TotalSize' => [
+ 'description' => 'The total capacity of the enterprise drive. Unit: GiB'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '6050416754750',
+ ],
+ 'DomainId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'h****',
+ ],
+ 'Status' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'disabled' => '',
+ 'enabled' => '',
+ ],
+ 'example' => 'enabled',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC27288A-F9E1-5092-9B5B-71C27D15****\\",\\n \\"Token\\": {\\n \\"Token\\": \\"7836fa6eced7dc8d54c775k34iu3h4i2kh534f****\\",\\n \\"ExpiredAfter\\": \\"2022-10-10T04:41:35Z\\",\\n \\"UsedSize\\": 605089,\\n \\"TotalSize\\": 6050416754750,\\n \\"DomainId\\": \\"h****\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]',
+ 'title' => 'GetCloudDriveServiceMountToken',
+ ],
+ 'VerifyCredential' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-beijing',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai+dir-227468****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****',
+ ],
+ ],
+ [
+ 'name' => 'CredentialType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of the logon credential that you want to clear.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* MfaPasscode: the multi-factor verification code.'."\n"
+ .'* FingerPrint: the fingerprint.'."\n"
+ .'* Password: the password.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'enumValueTitles' => [
+ 'MfaPasscode' => '',
+ 'FingerPrint' => '',
+ 'Password' => '',
+ ],
+ 'example' => 'Password',
+ ],
+ ],
+ [
+ 'name' => 'Credential',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The credential.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123456789cyG',
+ ],
+ ],
+ [
+ 'name' => 'EncryptedKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the key that you want to encrypt.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'drjfs****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]',
+ 'title' => 'VerifyCredential',
+ 'summary' => 'Validates credentials to lock on-premises sessions on clients.',
+ ],
+ 'GetLoginToken' => [
+ 'summary' => 'Obtains logon credentials.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ '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 regions supported by EDS.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-885351****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-885351****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the session.'."\n"
+ ."\n"
+ .'* If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.'."\n"
+ .'* If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'CurrentStage',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon authentication stage. Valid values:'."\n"
+ ."\n"
+ .'* `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.'."\n"
+ .'* `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`'."\n"
+ .'* `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`'."\n"
+ .'* `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).'."\n"
+ .'* `ChangePassword`: the stage to change the password of the user.'."\n"
+ .'* `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'ADPassword',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'alice',
+ ],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'Password1234',
+ ],
+ ],
+ [
+ 'name' => 'OldPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'OldPassword',
+ ],
+ ],
+ [
+ 'name' => 'NewPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'NewPassword',
+ ],
+ ],
+ [
+ 'name' => 'AuthenticationCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '47****',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.1**** x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2.1.0-R-20210731.1****',
+ ],
+ ],
+ [
+ 'name' => 'TokenCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => '63****',
+ ],
+ ],
+ [
+ 'name' => 'KeepAlive',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'Specifies whether to keep the user logged on to the client. '."\n"
+ .'Valid values:'."\n"
+ .'* null: Default value. Do not keep the user logged on to the client.'."\n"
+ .'* true: Keep the user logged on to the client.'."\n"
+ .'* false: Do not keep the user logged on to the client.',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'null' => '',
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'false',
+ ],
+ ],
+ [
+ 'name' => 'KeepAliveToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'hide',
+ ],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'C78CA9E99315687575DD2844C1F3****',
+ ],
+ ],
+ [
+ 'name' => 'ClientType',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The type of Alibaba Cloud Workspace clients.'."\n"
+ ."\n"
+ .'Valid values:'."\n"
+ ."\n"
+ .'* HTML5: web client.'."\n"
+ ."\n"
+ .'* WINDOWS: Windows client.'."\n"
+ ."\n"
+ .'* MACOS: macOS client.'."\n"
+ ."\n"
+ .'* IOS: iOS client.'."\n"
+ ."\n"
+ .'* ANDROID: Android client.',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [
+ 'HTML5' => 'HTML5',
+ 'WINDOWS' => 'WINDOWS',
+ 'MACOS' => 'MACOS',
+ 'IOS' => 'IOS',
+ 'ANDROID' => 'ANDROID',
+ ],
+ 'example' => 'Windows',
+ ],
+ ],
+ [
+ 'name' => 'AvailableFeatures',
+ 'in' => 'query',
+ 'style' => 'json',
+ 'schema' => [
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ [
+ 'name' => 'ClientName',
+ 'in' => 'query',
+ 'schema' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Email' => [
+ 'description' => 'The email address of the user. The system returns the email address in the return value of the LoginToken parameter after the user logs on to the client.'."\n"
+ ."\n"
+ .'* For a convenience user, the return value is the email address specified when the administrator creates the convenience user.'."\n"
+ .'* For an AD user, the return value is in the following format: `Username@Name of the AD domain`.'."\n",
+ 'type' => 'string',
+ 'example' => 'alice',
+ ],
+ 'Secret' => [
+ 'description' => 'The key that is generated when you bind the virtual MFA device. This parameter is required when the CurrentStage parameter is set to `MFABind`.'."\n"
+ ."\n"
+ .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n",
+ 'type' => 'string',
+ 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****',
+ ],
+ 'RequestId' => [
+ 'description' => 'The ID of the request.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'EndUserId' => [
+ 'description' => 'The account of the convenience user or the AD user.'."\n",
+ 'type' => 'string',
+ 'example' => 'alice',
+ ],
+ 'LoginToken' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ 'NextStage' => [
+ 'description' => 'The next stage that is expected to enter. For example, an administrator enables MFA in the EDS console. When an end user enters the password, that is, the end user completes the `ADPassword` stage, this parameter returns `MFAVerify`. This indicates that MFA is required.'."\n"
+ ."\n"
+ .'> For more information about the authentication stages, see the `CurrentStage` parameter.',
+ 'type' => 'string',
+ 'example' => 'MFAVerify',
+ ],
+ 'QrCodePng' => [
+ 'description' => 'The QR code that is generated when the virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty. This parameter is required only when the CurrentStage parameter is set to `MFABind`.'."\n"
+ ."\n"
+ .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n",
+ 'type' => 'string',
+ 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******',
+ ],
+ 'Label' => [
+ 'description' => 'The attribute of the convenience user. For an AD user, null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => 'test:sample',
+ ],
+ 'SessionId' => [
+ 'description' => 'The ID of the session. The ID is returned the first time you call the `GetLoginToken` operation in the session. If MFA is required, you must specify this parameter in subsequent stages.'."\n"
+ ."\n"
+ .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n",
+ 'type' => 'string',
+ 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****',
+ ],
+ 'Phone' => [
+ 'description' => 'Enter the mobile number of the convenience user. For an AD user, null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '1381111****',
+ ],
+ 'TenantId' => [
+ 'description' => 'The ID of the Alibaba Cloud account. The ID is used for hardware client authentication.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '166353906220****',
+ ],
+ 'KeepAliveToken' => [
+ 'description' => 'The token used to keep the user logged on. After the user logs on to the client and select the Keep Logon option, `KeepAliveToken` is returned when you call the operation. If the user does not select the Keep Logon option, null is returned.'."\n",
+ 'type' => 'string',
+ 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW',
+ ],
+ 'Industry' => [
+ 'description' => '> This is a parameter only for internal use.'."\n",
+ 'type' => 'string',
+ 'example' => 'edu',
+ ],
+ 'Props' => [
+ 'description' => '> This is a parameter only for internal use.'."\n",
+ 'type' => 'object',
+ 'additionalProperties' => [
+ 'type' => 'string',
+ 'description' => '> This is a parameter only for internal use.'."\n",
+ 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}',
+ ],
+ ],
+ 'WindowDisplayMode' => [
+ 'description' => '> This is a parameter only for internal use.'."\n",
+ 'type' => 'string',
+ 'example' => 'mode',
+ ],
+ 'RiskVerifyInfo' => [
+ 'description' => 'Risk identification information regarding the signin process.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Email' => [
+ 'description' => 'The email used for authentication.',
+ 'type' => 'string',
+ 'example' => '[email protected]',
+ ],
+ 'LastLockDuration' => [
+ 'description' => 'The duration of the lock.',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1713749778',
+ ],
+ 'Locked' => [
+ 'description' => 'Whether the account is locked or not.',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'true' => '',
+ 'false' => '',
+ ],
+ 'example' => 'true',
+ ],
+ 'Phone' => [
+ 'description' => 'The mobile number used for authentication.',
+ 'type' => 'string',
+ 'example' => '1388888****',
+ ],
+ ],
+ ],
+ 'Reason' => [
+ 'description' => '> This is a parameter only for internal use.',
+ 'type' => 'string',
+ 'example' => 'null',
+ ],
+ 'PasswordStrategy' => [
+ 'description' => '> This is a parameter only for internal use.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TenantPasswordLength' => [
+ 'description' => '> This is a parameter only for internal use.',
+ 'type' => 'string',
+ 'example' => 'null',
+ ],
+ 'TenantAlternativeChars' => [
+ 'description' => '> This is a parameter only for internal use.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '> This is a parameter only for internal use.',
+ 'type' => 'string',
+ 'example' => 'null',
+ ],
+ ],
+ ],
+ ],
+ 'NickName' => [
+ 'type' => 'string',
+ ],
+ 'WyId' => [
+ 'type' => 'string',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"alice\\",\\n \\"Secret\\": \\"5OCLLKKOJU5HPBX66H3QCTWYI7MH****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\",\\n \\"NextStage\\": \\"MFAVerify\\",\\n \\"QrCodePng\\": \\"5OCLLKKOJU5HPBX66H3QCTWY******\\",\\n \\"Label\\": \\"test:wuying\\",\\n \\"SessionId\\": \\"d6ec166d-ab93-4286-bf7f-a18bb929****\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"TenantId\\": 0,\\n \\"KeepAliveToken\\": \\"006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW\\",\\n \\"Industry\\": \\"edu\\",\\n \\"Props\\": {\\n \\"key\\": \\"{\'dingUserName\': u\'\\\\\\\\u674e\\\\\\\\u66fc\', \'role\': \'student\'}\\"\\n },\\n \\"WindowDisplayMode\\": \\"mode\\",\\n \\"RiskVerifyInfo\\": {\\n \\"Email\\": \\"[email protected]\\",\\n \\"LastLockDuration\\": 1713749778,\\n \\"Locked\\": \\"true\\",\\n \\"Phone\\": \\"1381111****\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"PasswordStrategy\\": {\\n \\"TenantPasswordLength\\": \\"null\\",\\n \\"TenantAlternativeChars\\": [\\n \\"null\\"\\n ]\\n },\\n \\"NickName\\": \\"\\",\\n \\"WyId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetLoginTokenResponse>\\n <Email>alice</Email>\\n <Secret>5OCLLKKOJU5HPBX66H3QCTWYI7MH****</Secret>\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>\\n <EndUserId>alice</EndUserId>\\n <LoginToken>v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****</LoginToken>\\n <NextStage>MFAVerify</NextStage>\\n <QrCodePng>5OCLLKKOJU5HPBX66H3QCTWY******</QrCodePng>\\n <Label>test:wuying</Label>\\n <SessionId>d6ec166d-ab93-4286-bf7f-a18bb929****</SessionId>\\n <Phone>1381111****</Phone>\\n <KeepAliveToken>006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW</KeepAliveToken>\\n <Industry>edu</Industry>\\n <Props>\\n <key>{\'dingUserName\': u\'\\\\u674e\\\\u66fc\', \'role\': \'student\'}</key>\\n </Props>\\n</GetLoginTokenResponse>","errorExample":""}]',
+ 'title' => 'GetLoginToken',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'RefreshLoginToken' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [
+ 'operationType' => 'update',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai+dir-238191****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'alice',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****',
+ ],
+ 'LoginToken' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshLoginTokenResponse>\\r\\n <RequestId>FE379906-08A4-5893-9C18-77C32566D944</RequestId>\\r\\n</RefreshLoginTokenResponse>","errorExample":""}]',
+ 'title' => 'RefreshLoginToken',
+ 'summary' => 'Refreshes a logon token.',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ ],
+ 'SendTokenCode' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-2925105532',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cd45e873-650d-4d70-acb9-f996187a****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The username of the account.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'alice',
+ ],
+ ],
+ [
+ 'name' => 'ClientOS',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The operating system on which the client runs.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Windows_NT 10.0.18363 x64',
+ ],
+ ],
+ [
+ 'name' => 'ClientVersion',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client version. If you use an Alibaba Cloud Workspace client, you can view the client version in the "About" dialog box on the client logon page.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '2.1.0-R-20210731.151756',
+ ],
+ ],
+ [
+ 'name' => 'TokenCode',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'If two-factor authentication is enabled for clients in the Elastic Desktop Service (EDS) Enterprise console, the system will send a verification code to the user\'s email address if it detects that the current logged-on user is at risk. This parameter is required if you set `CurrentStage` to `TokenVerify`.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '63****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n",
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]',
+ 'title' => 'SendTokenCode',
+ 'summary' => 'Sends a logon verification code.',
+ ],
+ 'ChangePassword' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-shanghai+dir-227468****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'liming',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ [
+ 'name' => 'OldPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The current password.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '12345678',
+ ],
+ ],
+ [
+ 'name' => 'NewPassword',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The new password.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '67436290',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****',
+ ],
+ 'LoginToken' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]',
+ 'title' => 'ChangePassword',
+ 'summary' => 'Changes the password of a user account.',
+ ],
+ 'ResetPassword' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '95e41934-383e-4c9f-824f-3b93b19b****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou+dir-899235****',
+ ],
+ ],
+ [
+ 'name' => 'EndUserId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'liming',
+ ],
+ ],
+ [
+ 'name' => 'Email',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The email address of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'a***@example.edu',
+ ],
+ ],
+ [
+ 'name' => 'phone',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The phone number of the user.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => '1827912****',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ '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 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~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]',
+ 'title' => 'ResetPassword',
+ 'summary' => 'Resets a password.',
+ ],
+ 'EncryptPassword' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.',
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-beijing',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The ID of the client. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****',
+ ],
+ ],
+ [
+ 'name' => 'DirectoryId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The directory ID.',
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => false,
+ 'example' => 'cn-beijing+dir-131196****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'cn-beijing+dir-131196****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****',
+ ],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password that you want to encrypt.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Ab123456',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'EncryptedPassword' => [
+ 'description' => 'The encrypted password.'."\n",
+ 'type' => 'string',
+ 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]',
+ 'title' => 'EncryptPassword',
+ 'summary' => 'Encrypts a password.',
+ ],
+ 'DescribeFingerPrintTemplates' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '61e39dc6-0450-45f6-a372-2a09e938****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****',
+ ],
+ 'FingerPrintTemplates' => [
+ 'description' => 'The fingerprint templates.'."\n",
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The fingerprint template.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => [
+ 'description' => 'The index.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1',
+ ],
+ 'CreationTime' => [
+ 'description' => 'The time when the template was created.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-03-13T13:26:29Z',
+ ],
+ 'LoginTime' => [
+ 'description' => 'The logon time.'."\n",
+ 'type' => 'string',
+ 'example' => '2022-03-13T13:26:29Z',
+ ],
+ 'EndUserId' => [
+ 'description' => 'The user ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'liming',
+ ],
+ 'Description' => [
+ 'description' => 'The description of the template.'."\n",
+ 'type' => 'string',
+ 'example' => 'Finger 1',
+ ],
+ 'OfficeSiteId' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-074949****',
+ ],
+ 'ClientId' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C1D3FBE-84E1-5ABB-AD98-2003AC71****\\",\\n \\"FingerPrintTemplates\\": [\\n {\\n \\"Index\\": 1,\\n \\"CreationTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"LoginTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"Description\\": \\"Finger 1\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-074949****\\",\\n \\"ClientId\\": \\"2258a3d5-b8f8-4d79-a221-eaecf211****\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'DescribeFingerPrintTemplates',
+ 'summary' => 'Queries fingerprint templates.',
+ ],
+ 'SetFingerPrintTemplate' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '347431a9-90f6-448e-82c4-42bc84a9****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon credentials.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****',
+ ],
+ ],
+ [
+ 'name' => 'FingerPrintTemplate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The fingerprint template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'goG3gG8AAABhujtscn',
+ ],
+ ],
+ [
+ 'name' => 'EncryptedFingerPrintTemplate',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The encrypted fingerprint template.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'AAAAAAAAAAAAAA',
+ ],
+ ],
+ [
+ 'name' => 'EncryptedKey',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The encryption key.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'drjfspchj',
+ ],
+ ],
+ [
+ 'name' => 'Password',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The password that you want to encrypt.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'As53328794',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description of the node.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'docRequired' => true,
+ 'example' => 'testDescription',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token to ensure the idempotency of the request. You can use the client to generate the 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~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '123e4567-e89b-12d3-a456-42665544****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => [
+ 'description' => 'The index.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ ],
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****',
+ ],
+ 'EncryptedPassword' => [
+ 'description' => 'The encrypted password.'."\n",
+ 'type' => 'string',
+ 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Index\\": 1,\\n \\"RequestId\\": \\"CDE666EA-4FCD-5024-895C-8698E3D3****\\",\\n \\"EncryptedPassword\\": \\"0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==\\"\\n}","type":"json"}]',
+ 'title' => 'SetFingerPrintTemplate',
+ ],
+ 'SetFingerPrintTemplateDescription' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => false,
+ 'example' => 'd28520d4-da0b-4a97-981d-683db865****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****',
+ ],
+ ],
+ [
+ 'name' => 'Index',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The index.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The description.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'Finger 1',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'title' => '',
+ 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the 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~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '40401e62-5caf-4508-8de7-bf98af12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]',
+ 'title' => 'SetFingerPrintTemplateDescription',
+ ],
+ 'DeleteFingerPrintTemplate' => [
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The region ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****',
+ ],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The session ID.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '6df06330-3b75-4768-b334-41a73a64****',
+ ],
+ ],
+ [
+ 'name' => 'LoginToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The logon token.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****',
+ ],
+ ],
+ [
+ 'name' => 'Index',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The index.'."\n",
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'docRequired' => true,
+ 'maximum' => '4',
+ 'minimum' => '1',
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the value, but you ensure sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => '40401e62-5caf-4508-8de7-bf98af12****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'description' => 'The response parameters.'."\n",
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]',
+ 'title' => 'DeleteFingerPrintTemplate',
+ ],
+ 'IsKeepAlive' => [
+ 'summary' => 'Verifies whether the client\'s logon session is still active.',
+ 'methods' => [
+ 'post',
+ 'get',
+ ],
+ 'schemes' => [
+ 'http',
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'Anonymous' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [],
+ 'parameters' => [
+ [
+ 'name' => 'ClientId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The client ID. The system generates a unique ID for each client.'."\n",
+ 'type' => 'string',
+ 'required' => true,
+ 'docRequired' => true,
+ 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****',
+ ],
+ ],
+ [
+ 'name' => 'OfficeSiteId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'cn-hangzhou+dir-885351****',
+ ],
+ ],
+ [
+ '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' => false,
+ 'example' => 'cn-hangzhou',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'description' => 'The request ID.'."\n",
+ 'type' => 'string',
+ 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'."\n",
+ ],
+ 'OfficeSiteId' => [
+ 'description' => 'The office network ID.'."\n",
+ 'type' => 'string',
+ 'example' => 'cn-hangzhou+dir-885351****'."\n",
+ ],
+ 'TenantId' => [
+ 'description' => 'The unique ID (UID) of the Alibaba Cloud account.'."\n",
+ 'type' => 'string',
+ 'example' => '141631846826****',
+ ],
+ 'IsKeepAlive' => [
+ 'description' => 'Identifies whether the user should remain logged on to the client.'."\n",
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\\\n\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-885351****\\\\n\\",\\n \\"TenantId\\": \\"141631846826****\\",\\n \\"IsKeepAlive\\": true\\n}","type":"json"}]',
+ 'title' => 'IsKeepAlive',
+ ],
+ ],
+ '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',
+ ],
+ ],
+];
diff --git a/data/en_us/ecd/2023-06-27/api-docs.php b/data/en_us/ecd/2023-06-27/api-docs.php
new file mode 100644
index 0000000..0c66871
--- /dev/null
+++ b/data/en_us/ecd/2023-06-27/api-docs.php
@@ -0,0 +1,359 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'RPC',
+ 'product' => 'ecd',
+ 'version' => '2023-06-27',
+ ],
+ 'directories' => [
+ 'DescribeBenefits',
+ 'GetRedeemCodes',
+ 'GetRequestToken',
+ ],
+ 'components' => [
+ 'schemas' => [],
+ ],
+ 'apis' => [
+ 'DescribeBenefits' => [
+ 'summary' => '查询权益',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ChannelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'wuying****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '25BB1CE-6B47-12DC-9FE6-03726****'."\n",
+ ],
+ 'Benefits' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'BenefitId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '6a79****',
+ ],
+ 'BenefitType' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'enumValueTitles' => [
+ 'Desktop.TimePack' => '',
+ ],
+ 'example' => 'Desktop.TimePack',
+ ],
+ 'TotalAmount' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '100',
+ ],
+ 'AvailableAmount' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '80',
+ ],
+ 'SpecInfo' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'CpuCore' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '4',
+ ],
+ 'AvailableHours' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '800',
+ ],
+ 'MemorySize' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '8192',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25BB1CE-6B47-12DC-9FE6-03726****\\",\\n \\"Benefits\\": [\\n {\\n \\"BenefitId\\": \\"6a79****\\",\\n \\"BenefitType\\": \\"Desktop.TimePack\\",\\n \\"TotalAmount\\": 100,\\n \\"AvailableAmount\\": 80,\\n \\"SpecInfo\\": {\\n \\"CpuCore\\": 4,\\n \\"AvailableHours\\": 800,\\n \\"MemorySize\\": 8192\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetRedeemCodes' => [
+ 'summary' => '获取渠道兑换码',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'CodeQuantity',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => true,
+ 'example' => '1',
+ ],
+ ],
+ [
+ 'name' => 'BenefitId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '6a79****'."\n",
+ ],
+ ],
+ [
+ 'name' => 'RequestToken',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '8789d7271c36979****'."\n",
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '25BB1CE-6B47-12DC-9FE6-03726****'."\n",
+ ],
+ 'RedeemCodes' => [
+ 'description' => '',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '068c8-55a1a-*****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25BB1CE-6B47-12DC-9FE6-03726****\\",\\n \\"RedeemCodes\\": [\\n \\"068c8-55a1a-*****\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetRequestToken' => [
+ 'summary' => '获取渠道接口操作凭证',
+ 'methods' => [
+ 'get',
+ ],
+ 'schemes' => [
+ 'https',
+ ],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'ChannelId',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'wuying****',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '25BB1CE-6B47-12DC-9FE6-03726****',
+ ],
+ 'RequestToken' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '8789d7271c36979****',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => [
+ 'returnType' => 'synchronous',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"25BB1CE-6B47-12DC-9FE6-03726****\\",\\n \\"RequestToken\\": \\"8789d7271c36979****\\"\\n}","type":"json"}]',
+ ],
+ ],
+ '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',
+ ],
+ ],
+];