'1.0',
'info' => ['style' => 'RPC', 'product' => 'ecd', 'version' => '2020-09-30'],
'directories' => [
[
'children' => ['DescribeModificationPrice', 'DescribeRefundPrice'],
'type' => 'directory',
'title' => '询价',
'id' => 427181,
],
[
'children' => [
[
'children' => ['ListOfficeSiteOverview', 'DescribeOfficeSites', 'ModifyOfficeSiteAttribute', 'ModifyOfficeSiteCrossDesktopAccess', 'DeleteOfficeSites', 'ModifyOfficeSiteDnsInfo', 'CreateOfficeSiteAccelerator', 'DeleteOfficeSiteAccelerator', 'ModifyOfficeSiteAccelerator'],
'type' => 'directory',
'title' => '办公网络通用',
'id' => 427187,
],
[
'children' => ['CreateSimpleOfficeSite', 'ActivateOfficeSite'],
'type' => 'directory',
'title' => '基于便捷账号的办公网络',
'id' => 427197,
],
[
'children' => ['CreateADConnectorOfficeSite', 'ListUserAdOrganizationUnits', 'ListOfficeSiteUsers', 'ModifyADConnectorOfficeSite', 'ModifyOfficeSiteMfaEnabled', 'ConfigADConnectorTrust', 'ConfigADConnectorUser'],
'type' => 'directory',
'title' => '基于企业AD账号的办公网络',
'id' => 427200,
],
],
'type' => 'directory',
'title' => '办公网络(原工作区)',
'id' => 427186,
],
[
'children' => ['CreateADConnectorDirectory', 'CreateRAMDirectory', 'DescribeDirectories', 'ListDirectoryUsers', 'ModifyADConnectorDirectory', 'DeleteDirectories'],
'type' => 'directory',
'title' => '目录',
'id' => 427208,
],
[
'children' => [
[
'children' => [
'CreateDesktops', 'CreateDiskEncryptionService', 'DescribeKmsKeys', 'DescribeDesktopInfo', 'DescribeDesktops', 'DescribeDesktopTypes', 'DescribeCustomizedListHeaders', 'ExportDesktopListInfo', 'StartDesktops', 'HibernateDesktops', 'WakeupDesktops', 'StopDesktops', 'RebootDesktops', 'RebuildDesktops', 'SetDesktopMaintenance', 'ModifyDesktopName', 'ModifyDesktopChargeType', 'ModifyDesktopSpec', 'ModifyDesktopTimer', 'ModifyDesktopHostName',
'ModifyCustomizedListHeaders', 'MigrateDesktops', 'RenewDesktops', 'DeleteDesktops', 'DescribeDesktopMetadata',
],
'type' => 'directory',
'title' => '云电脑资源',
'id' => 427216,
],
[
'children' => ['DescribeUsersPassword', 'DescribeGuestApplications', 'ModifyUserEntitlement', 'ModifyEntitlement', 'BatchModifyEntitlement'],
'type' => 'directory',
'title' => '云电脑授权用户',
'id' => 427243,
],
],
'type' => 'directory',
'title' => '云电脑',
'id' => 427215,
],
[
'children' => [
[
'children' => ['CreateDesktopGroup', 'GetDesktopGroupDetail', 'DescribeDesktopGroups', 'ExportDesktopGroupInfo', 'DescribeDesktopsInGroup', 'DisableDesktopsInGroup', 'ModifyDesktopGroup', 'ResetDesktops', 'SetDesktopGroupScaleTimer', 'SetDesktopGroupTimer', 'SetDesktopGroupTimerStatus', 'RenewDesktopGroup', 'DeleteDesktopGroup'],
'type' => 'directory',
'title' => '共享型云电脑资源',
'id' => 427251,
],
[
'children' => ['AddUserToDesktopGroup', 'DescribeUsersInGroup', 'DescribeUserConnectionRecords', 'ModifyUserToDesktopGroup', 'RemoveUserFromDesktopGroup'],
'type' => 'directory',
'title' => '共享型云电脑用户',
'id' => 427265,
],
],
'type' => 'directory',
'title' => '共享型云电脑',
'id' => 427250,
],
[
'children' => ['CreateNetworkPackage', 'DescribeNetworkPackages', 'DescribeFlowMetric', 'DescribeAclEntries', 'ModifyAclEntries', 'AssociateNetworkPackage', 'DissociateNetworkPackage', 'RenewNetworkPackages', 'ModifyNetworkPackageBandwidth', 'ModifyNetworkPackageEnabled', 'DeleteNetworkPackages'],
'type' => 'directory',
'title' => '公网精品带宽',
'id' => 427271,
],
[
'children' => ['DescribeCens', 'VerifyCen', 'SendVerifyCode', 'AttachCen', 'DetachCen'],
'type' => 'directory',
'title' => '云企业网',
'id' => 427284,
],
[
'children' => [
'CreateDrive',
'DeleteDrive',
'DescribeDrives',
[
'children' => [
[
'children' => ['CreateCloudDriveService'],
'type' => 'directory',
'title' => '网盘',
'id' => 427295,
],
[
'children' => ['DescribeCloudDiskGroupDrives', 'DescribeCloudDiskGroups', 'CreateCloudDriveGroup', 'DescribeCloudDriveGroups', 'ModifyCloudDriveGroups', 'DeleteCloudDriveGroups'],
'type' => 'directory',
'title' => '团队共享盘',
'id' => 427297,
],
[
'children' => ['CreateCloudDriveUsers', 'DescribeCloudDriveUsers', 'ModifyCloudDriveUsers', 'DeleteCloudDriveUsers'],
'type' => 'directory',
'title' => '用户个人盘',
'id' => 427304,
],
[
'children' => ['DescribeCloudDrivePermissions', 'ModifyCloudDrivePermission'],
'type' => 'directory',
'title' => '权限',
'id' => 427309,
],
[
'children' => ['CreateCdsFile', 'CompleteCdsFile', 'CopyCdsFile', 'ListCdsFiles', 'GetAsyncTask', 'ModifyCdsFile', 'MoveCdsFile', 'DownloadCdsFile', 'DeleteCdsFile'],
'type' => 'directory',
'title' => '文件管理',
'id' => 427312,
],
[
'children' => ['CreateCdsFileShareLink', 'DescribeCdsFileShareLinks', 'ModifyCdsFileShareLink', 'CancelCdsFileShareLink'],
'type' => 'directory',
'title' => '文件分享',
'id' => 427322,
],
[
'children' => ['AddFilePermission', 'ListFilePermission', 'RemoveFilePermission'],
'type' => 'directory',
'title' => '文件夹共享',
'id' => 427327,
],
],
'type' => 'directory',
'title' => '企业网盘(原无影云盘)',
'id' => 427294,
],
[
'children' => ['CreateAndBindNasFileSystem', 'ModifyNASDefaultMountTarget', 'ResetNASDefaultMountTarget', 'DeleteNASFileSystems'],
'type' => 'directory',
'title' => '共享存储NAS',
'id' => 427331,
],
],
'type' => 'directory',
'title' => '存储',
'id' => 427290,
],
[
'children' => ['ModifyTemplate', 'DeleteTemplates', 'ModifyTemplateBaseInfo'],
'type' => 'directory',
'title' => '模板(新版)',
'id' => 427338,
],
[
'children' => ['CreateBundle', 'DescribeBundles', 'ModifyBundle', 'DeleteBundles'],
'type' => 'directory',
'title' => '模板(旧版)',
'id' => 427344,
],
[
'children' => ['UploadImage', 'DescribeImageModifiedRecords', 'DescribeImagePermission', 'ModifyImagePermission', 'MigrateImageProtocol'],
'type' => 'directory',
'title' => '镜像',
'id' => 427349,
],
[
'children' => [
[
'children' => ['ResetSnapshot'],
'type' => 'directory',
'title' => '快照管理',
'id' => 427362,
],
[
'children' => ['DescribeAutoSnapshotPolicy'],
'type' => 'directory',
'title' => '自动快照策略',
'id' => 427367,
],
],
'type' => 'directory',
'title' => '快照',
'id' => 427361,
],
[
'children' => [
[
'children' => ['DeleteCenterPolicy', 'ModifyResourceCenterPolicy', 'ModifyCenterPolicy', 'DescribeResourceByCenterPolicyId', 'DescribeCenterPolicyList', 'CreateCenterPolicy', 'CloneCenterPolicy'],
'type' => 'directory',
'title' => '无地域策略',
'id' => 427375,
],
'DeletePolicyGroups',
'ModifyDesktopsPolicyGroup',
'DescribePolicyGroups',
'ClonePolicyGroup',
],
'type' => 'directory',
'title' => '策略',
'id' => 427374,
],
[
'children' => ['CreateConfigGroup', 'ModifyConfigGroup', 'DeleteConfigGroup', 'BindConfigGroup', 'UnbindConfigGroup', 'DescribeConfigGroup', 'ModifyTimerGroup', 'DescribeTimerGroup', 'DescribeGlobalTimerBatches', 'DescribeGlobalTimerRecords'],
'type' => 'directory',
'title' => '配置组',
'id' => 427389,
],
[
'children' => ['DeleteVirtualMFADevice', 'DescribeVirtualMFADevices', 'UnlockVirtualMFADevice', 'LockVirtualMFADevice'],
'type' => 'directory',
'title' => 'MFA',
'id' => 427400,
],
[
'children' => ['DescribeFotaTasks', 'DescribeFotaPendingDesktops', 'UpdateFotaTask', 'ApproveFotaUpdate'],
'type' => 'directory',
'title' => '镜像升级OTA',
'id' => 427405,
],
[
'children' => ['SetOfficeSiteSsoStatus', 'SetIdpMetadata', 'SetDirectorySsoStatus', 'GetOfficeSiteSsoStatus', 'GetSpMetadata'],
'type' => 'directory',
'title' => 'SSO设置',
'id' => 427410,
],
[
'children' => ['DescribeClientEvents', 'ExportClientEvents', 'DescribeRecordings', 'DescribeRecordFile', 'DescribeGlobalDesktopRecords'],
'type' => 'directory',
'title' => '审计',
'id' => 427424,
],
[
'children' => ['AddDevices', 'DeleteDevices', 'AttachEndUser', 'DetachEndUser', 'DescribeDevices'],
'type' => 'directory',
'title' => '终端管理',
'id' => 427430,
],
[
'children' => ['DescribeDesktopSessions', 'DescribeDesktopGroupSessions', 'DescribeSessionStatistic', 'DisconnectDesktopSessions', 'ApplyCoordinationForMonitoring', 'GetCoordinateTicket', 'CancelCoordinationForMonitoring', 'ApplyCoordinatePrivilege', 'RevokeCoordinatePrivilege'],
'type' => 'directory',
'title' => '监控运维',
'id' => 427436,
],
[
'children' => ['CreateBandwidthResourcePackages'],
'type' => 'directory',
'title' => '流量包',
'id' => 427446,
],
[
'children' => ['ListTransferFileDownloadUrl', 'ListTransferFiles', 'TransferTaskApprovalCallback'],
'type' => 'directory',
'title' => '文件传输',
'id' => 427448,
],
[
'children' => ['ListInstalledApps'],
'type' => 'directory',
'title' => '应用',
'id' => 427452,
],
[
'children' => ['DescribeEcdReportTasks', 'CreateEcdReportTask'],
'type' => 'directory',
'title' => '报表',
'id' => 427454,
],
[
'children' => [
'CreateQosRule', 'DeleteQosRules', 'ModifyQosEntries', 'ModifyQosRule', 'DescribeOnlineUserCount', 'QueryHistoryActiveUserCount', 'QueryHistoryAvgMetricList', 'QueryHistoryMetricDistribution', 'QueryHistoryUsageDurationRank', 'ApplyAutoSnapshotPolicy', 'CancelAutoSnapshotPolicy', 'CancelCopyImage', 'CopyImage', 'CreateAutoSnapshotPolicy', 'CreateImage', 'CreateNASFileSystem', 'CreatePolicyGroup', 'CreateSnapshot', 'CreateTemplate', 'DeleteAutoSnapshotPolicy',
'DeleteImages', 'DeleteSnapshot', 'DescribeImages', 'DescribeInvocations', 'DescribeNASFileSystems', 'DescribePrice', 'DescribeQosRules', 'DescribeRegions', 'DescribeRenewalPrice', 'DescribeSnapshots', 'DescribeTemplates', 'DescribeZones', 'GetConnectionTicket', 'ListTagResources', 'ModifyAutoSnapshotPolicy', 'ModifyDiskSpec', 'ModifyImageAttribute', 'ModifyPolicyGroup', 'RunCommand', 'StopInvocation',
'TagResources', 'UntagResources',
],
'type' => 'directory',
'title' => '其他',
'id' => 427457,
],
],
'components' => [
'schemas' => [
'CdsFileShareLinkModel' => [
'title' => '文件分享链接数据实体',
'description' => '文件分享链接数据实体。',
'type' => 'object',
'properties' => [
'Description' => ['title' => '描述', 'description' => '描述。', 'type' => 'string', 'example' => '文件分享链接。'],
'SaveLimit' => ['title' => '分享转存次数限制', 'description' => '分享转存次数限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'DownloadCount' => ['title' => '下载次数', 'description' => '下载次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Creator' => ['title' => '创建者', 'description' => '创建者。', 'type' => 'string', 'example' => 'user01'],
'SaveCount' => ['title' => '转存次数', 'description' => '转存次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'DisableSave' => ['title' => '禁止转存分享中的文件', 'description' => '禁止转存分享中的文件。', 'type' => 'boolean', 'example' => 'false'],
'SharePwd' => ['title' => '提取码,0-64个字符。长度0表示没有提取码。', 'description' => '提取码,0-64个字符。长度0表示没有提取码。', 'type' => 'string', 'example' => '12345678'],
'DisablePreview' => ['title' => '禁止预览分享中的文件', 'description' => '禁止预览正在分享的文件。', 'type' => 'boolean', 'example' => 'false'],
'AccessCount' => ['title' => '访问次数', 'description' => '访问次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'ShareId' => ['title' => '分享id', 'description' => '分享ID。', 'type' => 'string', 'example' => '7JQX1Fs****'],
'DownloadLimit' => ['title' => '分享下载次数限制', 'description' => '分享下载次数限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Status' => [
'title' => '状态。 枚举值如下: forbidden(被禁用) forbidden_disabled(被禁用后取消) disabled(已取消) enabled(有效)',
'description' => '状态。',
'type' => 'string',
'enumValueTitles' => [' forbidden_disabled' => '被禁用后取消', 'forbidden' => '被禁用', ' disabled' => '已取消', 'enabled' => '有效'],
'example' => 'disabled',
],
'DriveId' => ['title' => '空间id', 'description' => '空间ID。', 'type' => 'string', 'example' => 'dri-g0877jp3hu1ox****'],
'ModifiyTime' => ['title' => '修改时间', 'description' => '修改时间。', 'type' => 'string', 'example' => '2021-09-04T04:30:36Z'],
'DisableDownload' => ['title' => '禁止下载分享中的文件', 'description' => '禁止下载正在分享的文件。', 'type' => 'boolean', 'example' => 'false'],
'Expiration' => ['title' => '失效时间点。 RFC3339格式,比如:"2020-06-28T11:33:00.000+08:00"。 永久有效:""', 'description' => '失效时间点。'."\n"
.'> FC3339格式。例如:"2020-06-28T11:33:00.000+08:00"。 永久有效:""', 'type' => 'string', 'example' => '2020-06-28T11:33:00.000+08:00'],
'Expired' => ['title' => '是否过期', 'description' => '是否过期。', 'type' => 'boolean', 'example' => 'False'],
'PreviewCount' => ['title' => '预览次数', 'description' => '预览次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PreviewLimit' => ['title' => '分享预览次数限制', 'description' => '分享预览次数限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'VideoPreviewCount' => ['title' => '音视频播放次数', 'description' => '音视频播放次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ReportCount' => ['title' => '被举报次数', 'description' => '被举报次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'FileIds' => ['title' => '分享父路径文件id列表', 'description' => '分享父路径文件ID列表。', 'type' => 'string', 'example' => '[\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\"]'],
'ShareName' => ['title' => '分享名,默认使用第一个文件名', 'description' => '分享名,默认使用第一个文件名。', 'type' => 'string', 'example' => 'view.txt'],
'CreateTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2021-09-04T03:30:36Z'],
'ShareLink' => ['title' => '分享链接', 'description' => '分享链接。', 'type' => 'string', 'example' => 'https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****'],
],
],
'FilePermissionMember' => [
'title' => '文件授权对象',
'description' => '文件授权对象。',
'type' => 'object',
'properties' => [
'RoleId' => [
'title' => '角色ID',
'description' => '角色ID。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'SystemFileEditorWithoutShareLink' => '无分享编辑者', 'SystemFileUploaderAndDownloaderWithShareLink' => '上传/下载/分享者', 'SystemFileDownloader' => '下载者', 'SystemFileEditorWithoutDelete' => '无删除编辑者', 'SystemFileOwner' => '文件协同', 'SystemFileDownloaderWithShareLink' => '下载/分享者', 'SystemFileUploaderAndViewer' => '预览/上传者', 'SystemFileViewer' => '预览者', 'SystemFileEditor' => '编辑者', 'SystemFileUploaderWithShareLink' => '上传/分享者',
'SystemFileUploader' => '上传者', 'SystemFileUploaderAndDownloader' => '上传/下载者', 'SystemFileMetaViewer' => '可见列表',
],
'example' => 'SystemFileEditor',
],
'ExpireTime' => ['title' => '过期时间', 'description' => '过期时间,从1970年1月1日0点到目标时间的毫秒数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633598866642'],
'DisinheritSubGroup' => ['title' => '子用户组是否继承', 'description' => '是否禁用子群组下的用户继承此权限。', 'type' => 'boolean', 'example' => 'true'],
'CdsIdentity' => [
'title' => '用户对象',
'description' => '被授权对象,可以是用户或群组。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '用户ID', 'description' => '用户ID或者团队ID。', 'type' => 'string', 'required' => true, 'example' => '16435bdf934248b788b7b3771ee9****'],
'Type' => [
'title' => '用户类型',
'description' => '对象类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['IT_Group' => '团队', 'IT_User' => '用户'],
'example' => 'IT_User',
],
],
'required' => true,
],
],
],
],
],
'apis' => [
'ActivateOfficeSite' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '已锁定的便捷办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-803704****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
],
],
],
],
'title' => '解锁办公网络',
'summary' => '基于便捷账号的办公网络闲置一定时间后将被自动锁定。调用本接口可解锁。',
'description' => '对于基于便捷账号的办公网络,若连续15个自然日内未创建任何云电脑,则该办公网络将被自动锁定,VPC相关资源将被释放。如需重新使用,可以调用本接口进行解锁。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ActivateOfficeSite'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\r\\n","errorExample":""}]',
],
'AddDevices' => [
'summary' => '添加可信设备。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DeviceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备ID列表。可配置1\\~200个。',
'type' => 'array',
'items' => ['description' => '无影硬件终端的SN,或者无影软件客户端的UUID。', 'type' => 'string', 'required' => false, 'example' => '5F52817BE267A43C608D245070D2****'],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '设备类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [1 => '无影硬件终端', '无影软件客户端'],
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07****'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', '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' => '添加可信设备',
'description' => '每个设备只能注册在一个阿里云账号下。若尝试注册的设备已经被其他阿里云账号注册,则会报错。',
'changeSet' => [
['createdAt' => '2024-03-25T11:43:53.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddDevices'],
],
],
'ramActions' => [],
],
'AddFilePermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-352282****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****'],
],
[
'name' => 'MemberList',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
'description' => '授权用户列表。',
'type' => 'array',
'items' => [
'description' => '授权用户。',
'type' => 'object',
'properties' => [
'RoleId' => [
'title' => '角色ID ',
'description' => '目前支持两种方式设置权限,一种是通过指定角色设置权限,另一种是自定义设置操作权限,该字段用于指定角色设置权限,与`ActionList`互斥,当两个字段同时设置时,以该字段为准。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'SystemFileEditorWithoutShareLink' => '无分享编辑者', 'SystemFileUploaderAndDownloaderWithShareLink' => '上传/下载/分享者', 'SystemFileDownloader' => '下载者', 'SystemFileEditorWithoutDelete' => '无删除编辑者', 'SystemFileOwner' => '文件协同', 'SystemFileDownloaderWithShareLink' => '下载/分享者', 'SystemFileUploaderAndViewer' => '预览/上传者', 'SystemFileViewer' => '预览者', 'SystemFileEditor' => '编辑者', 'SystemFileUploaderWithShareLink' => '上传/分享者',
'SystemFileUploader' => '上传者', 'SystemFileUploaderAndDownloader' => '上传/下载者', 'SystemFileMetaViewer' => '可见列表',
],
'example' => 'SystemFileUploaderAndDownloader',
],
'ExpireTime' => ['title' => '过期时间', 'description' => '授权过期的时间。 从1970年1月1日0点到目标时间,单位:毫秒。 永久有效可以设置为系统预定义的一个值。例如:4775500800000。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4775500800000'],
'DisinheritSubGroup' => ['title' => '子用户组是否继承', 'description' => '子用户组是否继承。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'CdsIdentity' => [
'title' => '用户对象',
'description' => '用户对象。',
'type' => 'object',
'properties' => [
'Id' => ['title' => '用户ID', 'description' => '用户ID。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
'Type' => [
'title' => '用户类型',
'description' => '用户类型。',
'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' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '新增网盘共享文件夹',
'summary' => '在网盘内新增共享的文件夹。',
'description' => '可以指定某个文件夹共享给其他用户使用,也可以设置文件夹的访问权限。',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddFilePermission'],
],
],
'ramActions' => [],
],
'AddUserToDesktopGroup' => [
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '要添加授权用户的共享型云电脑ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要授权的用户列表。',
'type' => 'array',
'items' => ['description' => '要授权的用户。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 10000,
],
],
[
'name' => 'DesktopGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'UserOuPath',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'UserGroupName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'SimpleUserGroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'OrgId',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为共享型云电脑添加授权用户',
'summary' => '为共享型云电脑添加授权用户。共享型云电脑内的云电脑会按照管理员设置的规则自动分配给授权用户使用。',
'changeSet' => [
['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddUserToDesktopGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\n","errorExample":""}]',
],
'ApplyAutoSnapshotPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => true, 'example' => 'sp-ejtum8j5tfcw7****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1\\~20个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-2h7u3ymhm33qy****'],
'required' => true,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****'],
],
'description' => '',
],
],
],
'title' => '将自动快照策略关联至云电脑',
'summary' => '为云电脑绑定自动快照策略。绑定后,云电脑将按照自动快照策略规定的时间自动创建快照。',
'changeSet' => [
['createdAt' => '2025-01-15T02:17:22.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\"\\n}","type":"json"}]',
],
'ApplyCoordinatePrivilege' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => '设备的UUID(设备唯一标识)。', 'type' => 'string', 'required' => false, 'example' => '3E14A18BD4D088504B9F8A8751AB****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户的用户名。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'CoId',
'in' => 'query',
'schema' => ['description' => '协同流ID。来自接口[ApplyCoordinationForMonitoring](~~ApplyCoordinationForMonitoring~~)返回的`Coid`。', 'type' => 'string', 'required' => true, 'example' => 'co-fqsm6e8ee75w6****'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '协同用户类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['TENANT_ADMIN' => '租户管理员'],
'example' => 'TENANT_ADMIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C43EEAC3-84F8-5C1E-A067-4751C3D1422E'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C43EEAC3-84F8-5C1E-A067-4751C3D1422E\\"\\n}","type":"json"}]',
'title' => '申请流协同操作权限',
'summary' => '申请流协同操作权限。',
'changeSet' => [
['createdAt' => '2022-09-16T02:33:57.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2022-09-16T02:33:57.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinatePrivilege'],
],
],
'ramActions' => [],
],
'ApplyCoordinationForMonitoring' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => '设备的UUID(设备唯一标识)。', 'type' => 'string', 'required' => true, 'example' => '3E14A18BD4D088504B9F8A8751AB****'],
],
[
'name' => 'InitiatorType',
'in' => 'query',
'schema' => [
'description' => '发起者类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ADMIN_INITIATE' => '管理员发起'],
'example' => 'ADMIN_INITIATE',
],
],
[
'name' => 'CoordinatePolicyType',
'in' => 'query',
'schema' => [
'description' => '远程协助过程中的权限策略。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['FULL_CONTROL' => '共享桌面和桌面控制'],
'example' => 'FULL_CONTROL',
],
],
[
'name' => 'ResourceCandidates',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需接受远程协助的云电脑列表。',
'type' => 'array',
'items' => [
'description' => '需接受远程协助的云电脑。',
'type' => 'object',
'properties' => [
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'ResourceRegionId' => ['description' => '资源所在地域。'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
'ResourceProperties' => ['description' => '云电脑属性。', 'type' => 'string', 'required' => false, 'example' => 'TestProperty'],
'OwnerEndUserId' => ['description' => '云电脑当前使用者的用户名。'."\n"
."\n"
.'> 该字段为必填项。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'ResourceId' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'ecd-08zhejm3h7ilr****'],
'ResourceName' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => true, 'example' => 'DemoComputer'],
'OwnerAliUid' => ['description' => '云电脑管理员的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '130247021517****'],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '发起流协同的终端用户ID。若管理员发起,则不需要填写。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'CoordinateFlowModels' => [
'description' => '协同流数据信息列表。',
'type' => 'array',
'items' => [
'description' => '协同流数据信息。',
'type' => 'object',
'properties' => [
'CoordinateStatus' => [
'description' => '当前协同状态。',
'type' => 'string',
'enumValueTitles' => ['COORDINATING ' => '协同中', 'TERMINATING ' => ' 终止中', 'TERMINATED ' => '已终止', 'PENDING ' => '待接受'],
'example' => 'PENDING',
],
'InitiatorType' => [
'description' => '发起者类型。',
'type' => 'string',
'enumValueTitles' => ['ADMIN_INITIATE_FORCE' => '管理者强制', 'ADMIN_INITIATE' => '管理员发起', 'COORDINATOR_INITIATE_FORCE' => '协同者强制'],
'example' => 'COORDINATOR_INITIATE_FORCE',
],
'OwnerUserId' => ['description' => '用户侧用户的阿里云账号ID。', 'type' => 'string', 'example' => 'alice'],
'CoordinateTicket' => ['description' => 'ASP建立连接使用的Ticket。', 'type' => 'string', 'example' => '1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****'],
'CoId' => ['description' => '协同流ID。', 'type' => 'string', 'example' => 'co-0sot77uale3****'],
'ResourceId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-96vi03f9emqnl****'],
'ResourceName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
],
],
],
],
],
],
],
'title' => '向终端用户发起远程协助请求',
'summary' => '管理员向终端用户发起远程协助请求。主要用于管理员协助场景和教育场景。',
'changeSet' => [
['createdAt' => '2022-07-07T03:54:26.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinationForMonitoring'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ApplyCoordinationForMonitoring',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"CoordinateFlowModels\\": [\\n {\\n \\"CoordinateStatus\\": \\"PENDING\\",\\n \\"InitiatorType\\": \\"COORDINATOR_INITIATE_FORCE\\",\\n \\"OwnerUserId\\": \\"alice\\",\\n \\"CoordinateTicket\\": \\"1VDQ0VTUw0KW0Rlc2t0b3BdDQpHV1Rva2VuPTAwTzgwL3liS25zUEVGdkF6eU1Pc1ExeHZWdmk4VEE3NFJvU1V1d0dPYm1BNkNJWklDMHVNQklWcjU2NS80S0ZQekQ4aGFTR0ZHelZqMTFGbkRpWWgvUFF1Zm1xSXNGdFRFNFRWMExJNit3TkU0L2RMb04wNXBBSE5Tc3M4dWFXY3lwWE****\\",\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"ResourceId\\": \\"ecd-96vi03f9emqnl****\\",\\n \\"ResourceName\\": \\"DemoComputer\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ApproveFotaUpdate' => [
'summary' => '允许升级镜像。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'ecd-138dsptkrt00u****'],
],
[
'name' => 'AppVersion',
'in' => 'query',
'schema' => ['description' => '镜像版本。可调用[DescribeImages](~~188895~~)获取该参数。', '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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '允许升级镜像',
'description' => '云电脑的状态必须为运行中(Running)。',
'changeSet' => [
['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'AssociateNetworkPackage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => true, 'example' => 'np-e0iodl3yzb62q****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。可调用[DescribeNetworkPackages](~~216079~~)获取与公网精品带宽绑定的办公网络ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-*********'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为办公网络绑定公网精品带宽',
'summary' => '将公网精品带宽绑定至办公网络。公网精品带宽和办公网络是一对一的绑定关系。',
'changeSet' => [
['createdAt' => '2022-05-30T01:26:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateNetworkPackage'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'AttachCen' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CenId',
'in' => 'query',
'schema' => ['description' => '云企业网实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cen-3gwy16dojz1m65****'],
],
[
'name' => 'CenOwnerId',
'in' => 'query',
'schema' => ['description' => '云企业网实例所属的阿里云账号ID。'."\n"
."\n"
.'- 如果配置的CenId属于本阿里云账号,该参数无需配置。'."\n"
."\n"
.'- 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****'],
],
[
'name' => 'VerifyCode',
'in' => 'query',
'schema' => ['description' => '验证码。如果配置的CenId属于其他阿里云账号,必须先调用[SendVerifyCode](~~436847~~)获取验证码。', 'type' => 'string', 'required' => false, 'example' => '12****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '将高级办公网络与云企业网实例绑定',
'summary' => '将高级办公网络与云企业网实例绑定。',
'description' => '前提条件:'."\n"
.'- 已有云企业网实例。'."\n"
.'- 办公网络的类型为高级办公网络,且账号系统类型为便捷账号。'."\n"
."\n"
.'> AD办公网络在创建时已经加入到云企业网实例中。一个办公网络只能加入到一个云企业网实例中。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachCen'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]',
],
'AttachEndUser' => [
'summary' => '如果希望硬件终端只能被指定的终端用户登录,您需要开启可信设备认证功能,并为硬件终端添加绑定用户。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '无影硬件终端的SN。', 'type' => 'string', 'required' => true, 'example' => '12OERSLDO7M3****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '需要为无影硬件终端添加的绑定用户ID。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '便捷办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'],
],
[
'name' => 'AdDomain',
'in' => 'query',
'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '用户账号类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['AD' => '企业AD账号', 'SIMPLE' => '便捷账号'],
'example' => 'SIMPLE',
],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '设备类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [1 => '无影硬件终端'],
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '为无影硬件终端添加绑定用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachEndUser'],
],
],
'ramActions' => [],
],
'BatchModifyEntitlement' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用DescribeRegions获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxUserPerDesktop',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '每台云电脑分配用户数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '500', 'example' => '1'],
],
[
'name' => 'MaxDesktopPerUser',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '每个用户分配云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '500', 'example' => '0'],
],
[
'name' => 'Strategy',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '无法按比例匹配策略:'."\n"
."\n"
.'AVERAGE:优先给每个用户分配云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给每个用户分配云电脑。'."\n"
."\n"
.'CENTRAL:优先给用户分配指定数量的云电脑,当所选云电脑数与用户数无法按比例匹配时,优先给用户分配指定数量的云电脑。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['AVERAGE' => 'AVERAGE', 'CENTRAL' => 'CENTRAL'],
'example' => 'AVERAGE',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要修改授权用户的云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '要修改授权用户的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'."\n"],
'required' => true,
'docRequired' => true,
'maxItems' => 500,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户ID(即用户名)列表。',
'type' => 'array',
'items' => ['description' => '用户ID(即用户名)。', 'type' => 'string', 'required' => false, 'example' => 'Alice'."\n"],
'required' => false,
'docRequired' => true,
'maxItems' => 500,
],
],
[
'name' => 'Preview',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '是否预览,预览不会真正分配。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
'Entitlements' => [
'description' => '集合',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '整体分配结果。',
'type' => 'string',
'enumValueTitles' => ['FAILED' => 'FAILED', 'NOT_STARTED' => 'NOT_STARTED', 'STARTED' => 'STARTED', 'PROCESSING' => 'PROCESSING', 'FINISHED' => 'FINISHED'],
'example' => 'FINISHED',
],
'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'B2F4F018-0EDF-159C-B285-117B5F1C****'],
'AssignModels' => [
'description' => '分配结果集合',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-e94kzikmpljjx99pl'],
'InnerStatus' => [
'description' => '单台云电脑分配结果',
'type' => 'string',
'enumValueTitles' => ['FAILED' => 'FAILED', 'NOT_STARTED' => 'NOT_STARTED', 'STARTED' => 'STARTED', 'PROCESSING' => 'PROCESSING', 'FINISHED' => 'FINISHED'],
'example' => 'FINISHED',
],
'EndUserIds' => [
'description' => '云电脑授权的用户ID(即用户名)列表。',
'type' => 'array',
'items' => ['description' => '云电脑授权的用户ID(即用户名)', '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' => '批量修改云电脑的用户授权',
'summary' => '批量分配用户到多台云电脑。',
'description' => '- 云电脑的状态必须为运行中(Running)。'."\n"
.'- 本接口立刻返回结果,如需查询分配是否成功,请调用[DescribeDesktops](~~436815~~),并根据其返回参数`ManagementFlags`判断是否分配完成:`ASSIGNING`表示正在分配中,其他表示分配完成。'."\n"
.'- 建议每2\\~5秒检查一次是否分配完成,最多累计检查50秒。一般情况下,1~5秒可完成分配。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchModifyEntitlement'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:BatchModifyEntitlement',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'BindConfigGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '配置组ID。', 'type' => 'string', 'required' => true, 'example' => 'ccg-0chlk9b65lj8z****'],
],
[
'name' => 'ResourceInfos',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定的资源信息。',
'type' => 'array',
'items' => [
'description' => '需要绑定的资源信息。',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-1bo4xotjvwyon****'],
'ResourceRegionId' => ['description' => '资源所在地域。'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESOURCE_GROUP' => '资源组', 'CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'ProductType' => [
'description' => '资源所属的产品类型。',
'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' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******'],
'GroupId' => ['description' => '配置组ID。', 'type' => 'string', 'example' => 'ccg-0chlk9b65lj****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '绑定配置组',
'summary' => '将配置组与云电脑或资源组绑定。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:BindConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"GroupId\\": \\"ccg-0chlk9b65lj****\\"\\n}","type":"json"}]',
],
'CancelAutoSnapshotPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-78lhzpe7kjfnd****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可以设置1\\~50个。一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-itcmrhqt01tdl****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]',
'title' => '取消自动快照策略',
'summary' => '取消云电脑的自动快照策略。',
'changeSet' => [
['createdAt' => '2024-07-22T02:11:42.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'],
],
],
'ramActions' => [],
],
'CancelCdsFileShareLink' => [
'summary' => '取消文件分享。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'deprecated' => false, 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****'],
],
[
'name' => 'ShareId',
'in' => 'query',
'schema' => ['description' => '分享ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7JQX1Fsw****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'Data' => ['description' => '数据信息。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '取消文件分享',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCdsFileShareLink'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CancelCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CancelCoordinationForMonitoring' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CoIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '协同流ID列表。',
'type' => 'array',
'items' => ['description' => '协同流ID。来自接口[ApplyCoordinationForMonitoring](~~ApplyCoordinationForMonitoring~~)返回的`Coid`。', 'type' => 'string', 'required' => true, 'example' => 'co-fojvd9sg7whrk****'],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '用户类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TENANT_ADMIN' => '管理员'],
'example' => 'TENANT_ADMIN',
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '发起流协同的终端用户ID。若管理员发起,则不需要填写。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '取消向终端用户发起的远程协助请求',
'summary' => '取消向终端用户发起的远程协助请求。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCoordinationForMonitoring'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'CancelCopyImage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '复制镜像的目标地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '目标地域下正在通过复制而生成的新镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BEFE642-A383-4A18-8939-FB7DE452****\\"\\n}","type":"json"}]',
'title' => '取消跨地域复制镜像',
'summary' => '取消将镜像复制至另一地域的操作。',
'changeSet' => [
['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCopyImage'],
],
],
'ramActions' => [],
],
'CloneCenterPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。该功能无地域属性,该字段固定填写cn-shanghai。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['cn-shanghai' => '华东2(上海)'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => false,
'enumValueTitles' => [1 => '公共云', 8 => '商业版'],
'example' => '1',
],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '需要克隆的目标云电脑策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'testPolicyGroupName'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyGroupId' => ['description' => '克隆出的云电脑策略ID。', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
'description' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '克隆无地域策略',
'summary' => '基于现有无地域策略克隆出一个策略。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CloneCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ClonePolicyGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '需要克隆的目标云电脑策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '新的云电脑策略的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testPolicyGroupName'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'PolicyGroupId' => ['description' => '新的云电脑策略ID。', 'type' => 'string', 'example' => 'pg-7jcaznnx6go6n****'],
'RequestId' => ['description' => '请求ID。', '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.', 'description' => '目标策略组正在创建中,请稍后再试。'],
],
],
'title' => '克隆云电脑策略',
'summary' => '通过克隆云电脑策略来实现快速创建自定义云电脑策略的目的。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ClonePolicyGroup'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ClonePolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyGroupId\\": \\"pg-7jcaznnx6go6n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'CompleteCdsFile' => [
'summary' => '创建文件上传任务后,调用本接口完成上传动作。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '用户名。`EndUserId`和`GroupId`必须至少传入一个。', 'type' => 'string', 'required' => false, 'example' => 'test0'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai+cds-465878****'],
],
[
'name' => 'UploadId',
'in' => 'query',
'schema' => ['description' => '文件上传任务的ID。可调用接口[CreateCdsFile](~~2247619~~)获取。', 'type' => 'string', 'required' => true, 'example' => '6C48B55A1FAC4E1A9E0579059514****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件ID。', 'type' => 'string', 'required' => true, 'example' => '635a316c94f40f35f5354da29b2aee88c9d1****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。`EndUserId`和`GroupId`必须至少传入一个。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05C2791F-41A7-5E7C-B5E4-1401FD0E****'],
],
'description' => '',
],
],
],
'title' => '完成文件上传',
'changeSet' => [
['createdAt' => '2023-09-25T12:03:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteCdsFile'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\"\\n}","type":"json"}]',
],
'ConfigADConnectorTrust' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => 'AD办公网络的ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-778418****'],
],
[
'name' => 'TrustKey',
'in' => 'query',
'schema' => ['description' => '信任密码。该密码为AD域中配置信任关系(即与无影ecd.acs建立信任关系)时设置的密码。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password123***'],
],
[
'name' => 'RdsLicenseDomain',
'in' => 'query',
'schema' => [
'description' => '判断是否是为AD办公网络的RDS License Domain配置信任密码。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '为AD办公网络的RDS License Domain配置信任密码', 'false' => '为普通AD办公网络设置信任密码'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n ECFA4A91-136C-5A58-9C77-858A84D60032\\r\\n","errorExample":""}]',
'title' => '为AD办公网络配置信任关系',
'summary' => '对于采用HDX协议的办公网络(原工作区),需要配置条件转发器和信任关系后方可正常使用。可调用本接口为AD办公网络配置信任关系。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-04-19T03:15:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorTrust'],
],
],
'ramActions' => [],
],
'ConfigADConnectorUser' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => 'AD办公网络的ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-778418****'],
],
[
'name' => 'OUName',
'in' => 'query',
'schema' => ['description' => 'AD域的组织单元OU。您可以调用[ListUserAdOrganizationUnits](~~311259~~)获取。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example.com/Domain Controllers'],
],
[
'name' => 'DomainUserName',
'in' => 'query',
'schema' => ['description' => '具有加域权限的AD用户的用户名。 '."\n"
.'此处配置的AD用户需具备将计算机加入域的权限。配置成功后,在对应AD办公网络下创建的云电脑将加入到指定的组织单元OU中。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Administrator'],
],
[
'name' => 'DomainPassword',
'in' => 'query',
'schema' => ['description' => '具有加域权限的AD用户的密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testPassword'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '配置AD办公网络的组织单元OU和管理员',
'summary' => '为AD办公网络(原工作区)指定组织单元OU和管理员。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n BB4B415B-A9CA-5A13-8E52-D6D3C24BE140\\r\\n","errorExample":""}]',
],
'CopyCdsFile' => [
'summary' => '为网盘中的文件或文件夹制作一个副本。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '640985a0ca2f71f489d2497682ca0bf468de****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '登录网盘的用户ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user01'],
],
[
'name' => 'ParentFolderId',
'in' => 'query',
'schema' => ['description' => '复制目的地位置的父文件夹ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。当复制进根目录时,填`root`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'root'],
],
[
'name' => 'AutoRename',
'in' => 'query',
'schema' => [
'description' => '当目标文件夹下存在同名文件时,是否自动重命名。',
'type' => 'boolean',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['true' => '自动重命名', 'false' => '不自动重命名 [默认值]'],
'example' => 'true',
],
],
[
'name' => 'FileReceiverId',
'in' => 'query',
'schema' => ['description' => '复制目的地所在的个人盘ID(可以通过[DescribeCloudDriveUsers](~~2357237~~)接口的返回参数`UserId`获取)或者团队空间ID(可以通过[DescribeCloudDriveGroups](~~609896~~)接口的返回参数`GroupId`获取)。'."\n"
.'> `FileReceiverId`和`FileReceiverType`都为空时,默认复制到文件当前所在的个人盘。', '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' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-hs3i1w39o68ma****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '93AD30C1-16B8-5C54-AD23-A51FF53F****'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'string',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'CopyCdsFileModel' => [
'description' => '复制文件结果。',
'type' => 'object',
'properties' => [
'AsyncTaskId' => ['description' => '异步任务ID。当复制文件时,不返回该字段;当复制文件夹时,因为是后台异步复制,所以会返回该字段,调用[GetAsyncTask](~~2357404~~)并传入该异步任务ID即可获取任务详细信息。', 'type' => 'string', 'example' => '4221bf6e6ab43a255edc4463bffa6f5f5d31****'],
'FileId' => ['description' => '复制后的新文件或文件夹ID。', 'type' => 'string', 'example' => '6400727cb878821bcb414615a609b4072463****'],
],
],
],
'description' => '',
],
],
],
'title' => '复制文件或文件夹',
'changeSet' => [
['createdAt' => '2023-09-25T12:03:08.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-16T10:59:10.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyCdsFile'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CopyCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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"}]',
],
'CopyImage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '待复制的镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****'],
],
[
'name' => 'DestinationImageName',
'in' => 'query',
'schema' => ['description' => '复制出来的新镜像的名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Office_Shanghai'],
],
[
'name' => 'DestinationDescription',
'in' => 'query',
'schema' => ['description' => '复制镜像目标地域的描述。长度为2\\~256个英文或中文字符,不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'This is a test.'],
],
[
'name' => 'DestinationRegionId',
'in' => 'query',
'schema' => ['description' => '复制镜像目标地域的ID,必须与镜像的当前地域ID不同。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'ImageId' => ['description' => '目标地域镜像ID。', 'type' => 'string', 'example' => 'm-2g65ljy3ynrdq****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '28A40F12-F340-442B-A35F-46EF6A03****'],
],
],
],
],
'title' => '跨地域复制镜像',
'summary' => '将镜像复制到另一地域。如需跨地域分享镜像,可以先调用本接口将镜像复制到新地域再进行分享。',
'changeSet' => [
['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyImage'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ImageId\\": \\"m-2g65ljy3ynrdq****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03****\\"\\n}","type":"json"}]',
],
'CreateADConnectorDirectory' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '输入企业AD的全限定域名(FQDN),同时带有主机名和域名。相同的域名只能注册一次。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'corp.example.com'],
],
[
'name' => 'DomainUserName',
'in' => 'query',
'schema' => ['description' => '域管理员的用户名。最长支持64个英文字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sAMAccountName'],
],
[
'name' => 'DomainPassword',
'in' => 'query',
'schema' => ['description' => '域管理员的用户密码。最长支持64个英文字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testPassword'],
],
[
'name' => 'DirectoryName',
'in' => 'query',
'schema' => ['description' => '目录名称。长度为2~255个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => true, 'example' => 'testDirectoryName'],
],
[
'name' => 'EnableAdminAccess',
'in' => 'query',
'schema' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'true',
],
],
[
'name' => 'DesktopAccessType',
'in' => 'query',
'schema' => [
'description' => '连接云电脑时允许使用的方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['VPC' => 'VPC连接', 'Internet' => '公网连接 [默认值]', 'Any' => '公网和VPC均可'],
'example' => 'Internet',
],
],
[
'name' => 'SubDomainName',
'in' => 'query',
'schema' => ['description' => '企业已有AD子域的全限定域名(FQDN),同时带有主机名和域名。', 'type' => 'string', 'required' => false, 'example' => 'child.example.com'],
],
[
'name' => 'MfaEnabled',
'in' => 'query',
'schema' => [
'description' => '是否启用MFA认证。开启后,该目录下的所有AD用户登录云电脑时,输入正确密码后,还需输入虚拟MFA设备生成的动态验证码。'."\n"
."\n"
.'> 首次登录时,需绑定MFA设备。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '启用MFA认证', 'false' => '不启用MFA认证 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'DnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业AD对应DNS的IP地址。目前仅支持设置一个。请确保该IP地址在所选的交换机网络下可以访问。',
'type' => 'array',
'items' => ['description' => '企业AD对应DNS的IP地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => true,
'example' => '127.0.**.**',
'maxItems' => 1,
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '交换机ID。目前仅支持设置一个。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp19ocz3erfx15uon****'],
'required' => true,
'example' => 'vsw-bp19ocz3erfx15uon****',
'maxItems' => 1,
],
],
[
'name' => 'SubDomainDnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业已有AD子域的DNS地址。 '."\n"
.'如果设置了`SubDomainName`,而未设置此参数,则认为子域DNS和父域一致。',
'type' => 'array',
'items' => ['description' => '企业已有AD子域的DNS地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => false,
'example' => '127.0.**.**',
'maxItems' => 1,
],
],
[
'name' => 'Specification',
'in' => 'query',
'schema' => [
'description' => 'AD Connector规格。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '通用型', '高级型'],
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'TrustPassword' => ['description' => 'AD信任密码。', 'type' => 'string', 'example' => '82Tg****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF'],
'DirectoryId' => ['description' => 'AD类型的目录ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'],
'AdConnectors' => [
'description' => 'AD Connector的信息集合。',
'type' => 'array',
'items' => [
'description' => 'AD Connector。',
'type' => 'object',
'properties' => [
'Address' => ['description' => '连接地址。', 'type' => 'string', 'example' => '127.0.XX.XX'],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"RequestId\\": \\"3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"AdConnectors\\": [\\n {\\n \\"Address\\": \\"127.0.XX.XX\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\n \\n 127.0.**.**\\n \\n","errorExample":""}]',
'title' => '创建AD类型的目录',
'summary' => '创建AD类型的目录。',
'description' => 'AD目录用于对接企业自有AD(Active Directory),适合较大规模的云电脑部署。对接企业AD需要支付目录费用,详细信息请参见[计费概述](~~188395~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-11-14T06:21:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorDirectory'],
],
],
'ramActions' => [],
],
'CreateADConnectorOfficeSite' => [
'summary' => '无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于企业AD账号的办公网络(原工作区)。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CidrBlock',
'in' => 'query',
'schema' => ['description' => '办公网络VPC包含的IPv4网段。系统将根据输入的IPv4网段,自动创建一个专有网络VPC。建议您使用以下网段及其子网作为IPv4网段:'."\n"
."\n"
.'- `10.0.0.0/12`(掩码有效范围为12\\~24位)'."\n"
.'- `172.16.0.0/12`(掩码有效范围为12\\~24位)'."\n"
.'- `192.168.0.0/16`(掩码有效范围为16\\~24位)', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX'],
],
[
'name' => 'CenOwnerId',
'in' => 'query',
'schema' => ['description' => '云企业网实例所属的阿里云账号ID。'."\n"
."\n"
.'- 如果未配置CenId,或者配置的CenId属于本阿里云账号,该参数无需配置。'."\n"
.'- 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****'],
],
[
'name' => 'CenId',
'in' => 'query',
'schema' => ['description' => '云企业网实例ID。', 'type' => 'string', 'required' => false, 'example' => 'cen-3gwy16dojz1m65****'],
],
[
'name' => 'VerifyCode',
'in' => 'query',
'schema' => ['description' => '验证码。如果配置的CenId属于其他阿里云账号,必须先调用[SendVerifyCode](~~436847~~)获取验证码。', 'type' => 'string', 'required' => false, 'example' => '12****'],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网带宽峰值。取值范围:0~200。 '."\n"
.'不设置该参数或者设置为0表示不开通互联网访问功能。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '企业AD的域名。相同的域名只能注册一次。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
[
'name' => 'DomainUserName',
'in' => 'query',
'schema' => ['description' => '域管理员的用户名。最长支持64个英文字符。'."\n"
."\n"
.'> 用户名请使用sAMAccountName,不能使用userPrincipalName。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Administrator'],
],
[
'name' => 'DomainPassword',
'in' => 'query',
'schema' => ['description' => '域管理员的用户密码。最长支持64个英文字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testPassword'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 '."\n"
.'默认值:空。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'EnableAdminAccess',
'in' => 'query',
'schema' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'true',
],
],
[
'name' => 'DesktopAccessType',
'in' => 'query',
'schema' => [
'description' => '连接云电脑时允许使用的接入方式。'."\n"
."\n"
.'> VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为`VPC`或者`Any`时,系统将自动为您开通私网连接服务。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['VPC' => '只允许处于VPC网络内的客户端连接云电脑', 'Internet' => '只允许客户端通过公网连接云电脑 [默认值]', 'Any' => '不限制方式。使用客户端连接云电脑时可以自行选择连接方式'],
'example' => 'Internet',
],
],
[
'name' => 'EnableInternetAccess',
'in' => 'query',
'schema' => ['description' => '是否开通公网访问功能。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SubDomainName',
'in' => 'query',
'schema' => ['description' => '企业AD子域的域名。', 'type' => 'string', 'required' => false, 'example' => 'child.example.com'],
],
[
'name' => 'MfaEnabled',
'in' => 'query',
'schema' => ['description' => '是否开启多因素认证MFA。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'DnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业AD对应DNS的IP地址。目前仅支持设置一个。',
'type' => 'array',
'items' => ['description' => '企业AD对应DNS的IP地址。目前仅支持设置一个。', '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' => '企业AD子域的DNS地址。如果设置了`SubDomainName`,而未设置此参数,则认为子域DNS和父域一致。',
'type' => 'array',
'items' => ['description' => '企业AD子域的DNS地址。如果设置了`SubDomainName`,而未设置此参数,则认为子域DNS和父域一致。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'],
'required' => false,
'example' => '192.168.XX.XX',
'maxItems' => 1,
],
],
[
'name' => 'Specification',
'in' => 'query',
'schema' => [
'description' => 'AD Connector规格。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '通用型', '高级型'],
'example' => '1',
],
],
[
'name' => 'AdHostname',
'in' => 'query',
'schema' => ['description' => '域控主机名。'."\n"
.'必须符合Windows主机命名规范。', 'type' => 'string', 'required' => false, 'example' => 'beijing-ad01'],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ASP' => 'ASP协议'],
'example' => 'ASP',
],
],
[
'name' => 'BackupDns',
'in' => 'query',
'schema' => ['description' => '备用域控DNS地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.2.100'],
],
[
'name' => 'BackupDCHostname',
'in' => 'query',
'schema' => ['description' => '备用域控主机名。', 'type' => 'string', 'required' => false, 'example' => 'dc002'],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '交换机ID列表。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf68bgq7rjwbqpg0****'],
'required' => false,
'maxItems' => 2,
],
],
[
'name' => 'AccessAttribute',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NetworkSpace.VpcInfoExist', 'errorMessage' => 'vpc info already exist.', 'description' => '对应VPC已存在办公网络'],
],
],
'title' => '创建基于企业AD账号的办公网络',
'description' => '创建AD办公网络时,系统将自动创建AD Connector来对接企业AD,您需要支付AD Connector的费用。更多信息,请参见[计费概述](~~188395~~)。'."\n"
."\n"
.'调用本接口创建AD办公网络后,您还需要完成AD域的相关配置。操作流程如下:'."\n"
."\n"
.'1. 在DNS服务器中完成条件转发器。'."\n"
.'1. 在AD域服务器中完成信任关系配置,然后调用[ConfigADConnectorTrust](~~311258~~)为AD办公网络配置信任关系。'."\n"
.'1. 调用[ListUserAdOrganizationUnits](~~311259~~)获取AD域的组织单元OU信息,然后调用[ConfigADConnectorUser](~~311262~~)为AD办公网络指定组织单元OU和管理员。'."\n"
.' '."\n"
.' > 创建AD办公网络时,如果传入了域管理员和密码(DomainUserName和DomainPassword),则后续只需要配置条件转发器;如果未传入域管理员和密码,则后续需要按照流程完成条件转发器、信任关系和指定OU的配置,'."\n"
."\n"
.'更多信息,请参见[创建和管理基于企业AD账号的办公网络](~~214469~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-10-23T08:47:39.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2024-06-26T07:31:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorOfficeSite'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateADConnectorOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]',
],
'CreateAndBindNasFileSystem' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'FileSystemName',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'szy-asp-upm-test'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统描述。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'newDescription'],
],
[
'name' => 'StorageType',
'in' => 'query',
'schema' => [
'description' => 'NAS文件系统的存储规格类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['Capacity' => '容量型 [默认值]', 'Performance' => '性能型'],
'example' => 'Capacity',
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'schema' => [
'description' => '文件系统是否使用KMS服务托管密钥,对文件系统落盘数据进行加密存储。在读写加密数据时,无需解密。'."\n"
."\n"
.'> 当`FileSystemType`为`standard`或`extreme`时,支持NAS托管密钥;当`FileSystemType`为`extreme`时,支持用户管理密钥。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['不加密 [默认值]', 'NAS托管密钥', '用户管理密钥'],
'example' => '0',
],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing+dir-15657*****'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-fh0vdzyh6rdc*****'],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户ID列表。',
'type' => 'array',
'items' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 10000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'],
],
'description' => '',
],
],
],
'title' => '创建并绑定NAS文件系统',
'summary' => '创建NAS文件系统并且绑定到共享型云电脑的办公网络。',
'changeSet' => [
['createdAt' => '2022-09-05T12:56:12.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAndBindNasFileSystem'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateAndBindNasFileSystem',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]',
],
'CreateAutoSnapshotPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => '自动快照策略的名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。默认值:空。', 'type' => 'string', 'required' => true, 'example' => 'test_auto_policy', 'maxLength' => 64, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'RetentionDays',
'in' => 'query',
'schema' => ['description' => '自动快照的保留时间,单位为天。取值范围:1\\~180。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
[
'name' => 'CronExpression',
'in' => 'query',
'schema' => ['description' => '时间周期调度的Cron表达式。', 'type' => 'string', 'required' => true, 'example' => '0 0 2 ? * 1-7'],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyId' => ['description' => '自动快照策略ID。', 'type' => 'string', 'example' => 'sp-3hpa78d0qyt99****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
],
'description' => '',
],
],
],
'title' => '创建自动快照策略',
'summary' => '创建自动快照策略,让云电脑按照Cron表达式对应的时间自动创建快照。',
'changeSet' => [
['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-12T07:12:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-02-04T08:50:06.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-02T02:41:20.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PolicyId\\": \\"sp-3hpa78d0qyt99****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]',
],
'CreateBandwidthResourcePackages' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PackageSize',
'in' => 'query',
'schema' => ['description' => '流量包容量大小。取值范围:10\\~10000。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '12000', 'minimum' => '10', 'example' => '100'],
],
[
'name' => 'Amount',
'in' => 'query',
'schema' => ['description' => '创建的流量包数量。取值范围:1\\~20,默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '购买时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、3、6。'."\n"
."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '时长单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => '是否自动支付。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24251717783****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AE7B699F-625C-587E-BC5F-1395CA969681'],
],
'description' => '',
],
],
],
'title' => '创建无影流量包',
'summary' => '创建无影流量包。',
'changeSet' => [
['createdAt' => '2021-12-10T09:24:41.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBandwidthResourcePackages'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": 0,\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA969681\\"\\n}","type":"json"}]',
],
'CreateBundle' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-4zfb6zj728hhr****'],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['description' => '云电脑规格。您可以调用[DescribeBundles](~~436974~~)查询云电脑模板,从返回的`DesktopType`参数获取当前支持的云电脑规格。'."\n"
."\n"
.'> 非GPU镜像只能选择非GPU规格,GPU镜像只能选择GPU规格。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eds.enterprise_office.2c4g'],
],
[
'name' => 'RootDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '系统盘大小。单位:GiB。支持设置的系统盘大小与规格相对应。更多信息,请参见[云电脑规格概述](~~188609~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '80'],
],
[
'name' => 'BundleName',
'in' => 'query',
'schema' => ['description' => '云电脑模板名称。', 'type' => 'string', 'required' => false, 'example' => 'testBundleName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '云电脑模板描述。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '操作系统语言。目前只支持系统镜像。取值如下:'."\n"
."\n"
.'- zh-CN:简体中文'."\n"
.'- zh-HK:繁体中文(香港)'."\n"
.'- en-US:英文'."\n"
.'- ja-JP:日文 ',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en-US' => '英文', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日文'],
'example' => 'zh-CN',
],
],
[
'name' => 'UserDiskSizeGib',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '数据盘大小列表。目前只能设置一个数据盘。',
'type' => 'array',
'items' => ['description' => '数据盘大小。目前只能设置一个数据盘。单位:GiB。支持设置的数据盘大小与规格相对应。更多信息,请参见[云电脑规格概述](~~188609~~)。'."\n"
."\n"
.'> 模板中设置的数据盘大小(UserDiskSizeGib)必须大于镜像中的数据盘大小(DataDiskSize)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
'required' => true,
'example' => '70',
'maxItems' => 1,
],
],
[
'name' => 'RootDiskPerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '系统盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL1',
],
],
[
'name' => 'UserDiskPerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '数据盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'BundleId' => ['description' => '云电脑模板ID。', 'type' => 'string', 'example' => 'b-cezrnfgecbich****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '创建自定义云电脑模板',
'summary' => '创建自定义的云电脑模板。',
'description' => '云电脑模板分为系统模板和自定义模板,其中系统模板是阿里云提供的默认模板,调用本接口可以创建自定义模板。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBundle'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateBundle',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"BundleId\\": \\"b-cezrnfgecbich****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\nb-cezrnfgecbich****\\nA90B77D3-261E-4AB2-A860-2FA2098D****\\n","errorExample":""}]',
],
'CreateCdsFile' => [
'summary' => '在网盘中创建文件夹或者创建文件上传任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test1'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-82414*****'],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => '文件名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testFile.txt', 'maxLength' => 256, 'minLength' => 1],
],
[
'name' => 'FileType',
'in' => 'query',
'schema' => [
'description' => '文件类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['file' => '文件', 'folder' => '文件夹'],
'example' => 'file',
],
],
[
'name' => 'ParentFileId',
'in' => 'query',
'schema' => ['description' => '父文件ID。可通过[ListCdsFiles](~~2247622~~)接口的返回参数`FileId`获取。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '637c9163b453b1a384874264ba79f3f9eab9****'],
],
[
'name' => 'FileLength',
'in' => 'query',
'schema' => ['description' => '文件大小。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1048576'],
],
[
'name' => 'FileHash',
'in' => 'query',
'schema' => ['description' => '基于SHA-1算法的文件哈希值。', 'type' => 'string', 'required' => false, 'example' => '7C4A8D09CA3762AF61E59520943DC26494F8****'],
],
[
'name' => 'ConflictPolicy',
'in' => 'query',
'schema' => [
'description' => '出现同名文件时的处理策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['refuse' => '当云端存在同名文件时,拒绝创建新文件,返回客户端已存在同名文件的详细信息 [默认值]', 'auto_rename' => '当发现同名文件时,自动重命名。默认为在原文件名末尾追加当前时间点,例如:xxx20240102_150405', 'ignore' => '允许文件同名', 'over_write' => '覆盖同名文件'],
'example' => 'ignore',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2BAFE05D-FFB9-5938-96D0-08017DB9****'],
'FileModel' => [
'description' => '返回的文件上传对象。',
'type' => 'object',
'properties' => [
'UploadUrl' => ['description' => '文件上传地址,默认有效时间15分钟。', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E26977****'],
'FileId' => ['description' => '文件ID。', 'type' => 'string', 'example' => '646ec2f662b1e08f7a2b4d648982f906****'],
'UploadId' => ['description' => '文件上传任务的ID。', 'type' => 'string', 'example' => '20BE155AC20943BE9D405B0997A9****'],
],
],
],
],
],
],
'title' => '创建文件夹或创建文件上传任务',
'description' => '调用本接口可以直接在企业网盘中创建文件夹。如需上传文件,也可以调用本接口来获取上传链接,然后配合[CompleteCdsFile](~~2247620~~)接口完成文件上传。',
'changeSet' => [
['createdAt' => '2025-11-03T09:38:47.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-11-03T08:19:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-25T11:13:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-26T07:14:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-10T12:50:19.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-03T07:00:37.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFile'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BAFE05D-FFB9-5938-96D0-08017DB9****\\",\\n \\"FileModel\\": {\\n \\"UploadUrl\\": \\"https://data.aliyunpds.com/xxx/xxx?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx&partNumber=1&uploadId=0CC175B9C0F1B6A831C399E26977****\\",\\n \\"FileId\\": \\"646ec2f662b1e08f7a2b4d648982f906****\\",\\n \\"UploadId\\": \\"20BE155AC20943BE9D405B0997A9****\\"\\n }\\n}","type":"json"}]',
],
'CreateCdsFileShareLink' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****'],
],
[
'name' => 'SharePwd',
'in' => 'query',
'schema' => ['description' => '提取码长度范围:0\\~64字节。不设置或者设置为空,表示无提取码,在获取分享令牌的时候也不用设置提取码参数。 要求使用ASCII可见字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12345678', 'maxLength' => 8, 'minLength' => 0],
],
[
'name' => 'Expiration',
'in' => 'query',
'schema' => ['description' => '失效时间点。 RFC3339格式。 当取值为空时,表示永久有效。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2020-06-28T11:33:00.000+08:00'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '分享描述。 长度范围为0\\~1024个字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SharedFile', 'maxLength' => 1024, 'minLength' => 0],
],
[
'name' => 'ShareName',
'in' => 'query',
'schema' => ['description' => '分享名。 如果未设置,默认使用`file_id_list`中的第一个ID对应的文件名。 长度范围为0\\~128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'view.txt', 'maxLength' => 128, 'minLength' => 0],
],
[
'name' => 'DisablePreview',
'in' => 'query',
'schema' => [
'description' => '是否禁止预览分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '禁止预览', 'false' => '允许预览'],
'example' => 'false',
],
],
[
'name' => 'DisableSave',
'in' => 'query',
'schema' => [
'description' => '是否禁止转存分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '禁止转存', 'false' => '允许转存'],
'example' => 'false',
],
],
[
'name' => 'DisableDownload',
'in' => 'query',
'schema' => [
'description' => '是否禁止下载分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '禁止下载', 'false' => '允许下载'],
'example' => 'false',
],
],
[
'name' => 'PreviewLimit',
'in' => 'query',
'schema' => ['description' => '分享预览次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'SaveLimit',
'in' => 'query',
'schema' => ['description' => '分享转存次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'DownloadLimit',
'in' => 'query',
'schema' => ['description' => '分享下载次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '99999', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'alice'],
],
[
'name' => 'FileIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '文件ID列表。',
'type' => 'array',
'items' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => false, 'example' => '['."\n"
.' "4221bf6e6ab43c255edc4463bf3a6f5f5d31****"'."\n"
.']'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'Data' => ['description' => '数据信息。', '$ref' => '#/components/schemas/CdsFileShareLinkModel'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建文件分享',
'summary' => '创建文件分享。',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFileShareLink'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CreateCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Description\\": \\"文件分享链接。\\",\\n \\"SaveLimit\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n },\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateCenterPolicy' => [
'summary' => '创建一条无地域的云电脑策略。',
'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' => '地域ID。该功能无地域属性,该字段固定填写cn-shanghai。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['cn-shanghai' => '华东2(上海)'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => false,
'enumValueTitles' => [1 => '公共云', 8 => '商业版'],
'example' => '1',
],
],
[
'name' => 'Clipboard',
'in' => 'query',
'schema' => [
'description' => '剪贴板权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地', 'readwrite' => '双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地', 'write' => '单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑', 'off' => '双向禁止。云电脑和本地之间无法进行复制操作 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'LocalDrive',
'in' => 'query',
'schema' => [
'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件', 'readwrite' => '读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件', 'off' => '关闭。云电脑上没有本地磁盘的映射 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'UsbRedirect',
'in' => 'query',
'schema' => [
'description' => 'USB重定向。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'PrinterRedirect',
'in' => 'query',
'schema' => [
'description' => '打印机重定向策略。当DeviceRedirects中没有打印机重定向策略时生效。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向[默认值]', 'usbRedirect' => 'USB重定向', 'off' => '关闭'],
'example' => 'off',
],
],
[
'name' => 'VisualQuality',
'in' => 'query',
'schema' => [
'description' => '图像显示质量策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['high' => '高清', 'low' => '流畅', 'lossless' => '无损', 'medium' => '自适应 [默认值]'],
'example' => 'low',
],
],
[
'name' => 'GpuAcceleration',
'in' => 'query',
'schema' => [
'description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'Html5FileTransfer',
'in' => 'query',
'schema' => [
'description' => 'Web客户端文件传输策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'Watermark',
'in' => 'query',
'schema' => [
'description' => '水印。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['blind' => '开启盲水印', 'off' => '关闭水印 [默认值]', 'on' => '开启明水印'],
'example' => 'off',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'testPolicyGroupName'],
],
[
'name' => 'WatermarkType',
'in' => 'query',
'schema' => [
'description' => '水印类型。最多可以选择3个类型,用半角逗号隔开。'."\n"
."\n"
.'> 若传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['EndUserId' => '用户名', 'Custom' => '自定义文本', 'DesktopIp' => '云电脑IP地址', 'ClientIp' => '客户端IP地址', 'HostName' => '云电脑ID的后15位', 'ClientTime' => '云电脑当前时间'],
'example' => 'EndUserId,HostName,ClientTime',
],
],
[
'name' => 'WatermarkCustomText',
'in' => 'query',
'schema' => ['description' => '若参数`WatermarkType`传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'WatermarkTransparencyValue',
'in' => 'query',
'schema' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkSecurity',
'in' => 'query',
'schema' => [
'description' => '盲水印安全优先规则。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'CameraRedirect',
'in' => 'query',
'schema' => [
'description' => '本地摄像头重定向。当DeviceRedirects中没有本地摄像头重定向策略时生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'off' => '关闭'],
'example' => 'off',
],
],
[
'name' => 'NetRedirect',
'in' => 'query',
'schema' => [
'description' => '是否开启网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['all' => '开启全局模式', 'off' => '关闭 [默认值]', 'on' => '开启白名单模式'],
'example' => 'off',
],
],
[
'name' => 'AppContentProtection',
'in' => 'query',
'schema' => [
'description' => '是否开启防截屏功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'RemoteCoordinate',
'in' => 'query',
'schema' => [
'description' => '远程协助时的键鼠控制权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['optionalControl' => '默认关闭(可以申请打开)', 'fullControl' => '完全控制', 'disableControl' => '不控制'],
'example' => 'fullControl',
],
],
[
'name' => 'InternetCommunicationProtocol',
'in' => 'query',
'schema' => [
'description' => '网络通信协议。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['tcp' => 'TCP模式适用于UDP/AST被限制场景', 'rtc' => 'AST模式适用于音视频高频使用场景', 'auto' => 'AUTO模式将依据桌面内容自动在AST和UDP模式间切换', 'both' => 'UDP模式适用于办公和高清图形设计场景'],
'example' => 'both',
],
],
[
'name' => 'VideoRedirect',
'in' => 'query',
'schema' => [
'description' => '多媒体重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭媒体重定向', 'on' => '打开媒体重定向'],
'example' => 'on',
],
],
[
'name' => 'WatermarkColor',
'in' => 'query',
'schema' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'WatermarkDegree',
'in' => 'query',
'schema' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10'],
],
[
'name' => 'WatermarkFontSize',
'in' => 'query',
'schema' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkFontStyle',
'in' => 'query',
'schema' => [
'description' => '水印字体样式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['plain' => '普通', 'bold' => '加粗'],
'example' => 'plain',
],
],
[
'name' => 'WatermarkRowAmount',
'in' => 'query',
'schema' => ['description' => '水印行数。取值范围:3~10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'WatermarkColumnAmount',
'in' => 'query',
'schema' => ['description' => '水印列数。取值范围:3~10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'CpuProtectedMode',
'in' => 'query',
'schema' => [
'description' => 'CPU保护模式开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'CpuRateLimit',
'in' => 'query',
'schema' => ['description' => 'CPU整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
'name' => 'CpuSampleDuration',
'in' => 'query',
'schema' => ['description' => 'CPU整体采样时长,取值范围: 10\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
[
'name' => 'CpuSingleRateLimit',
'in' => 'query',
'schema' => ['description' => 'CPU单核使用率百分比,取值范围: 70\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
'name' => 'CpuDownGradeDuration',
'in' => 'query',
'schema' => ['description' => 'CPU降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'MemoryProtectedMode',
'in' => 'query',
'schema' => [
'description' => '内存保护模式开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MemoryRateLimit',
'in' => 'query',
'schema' => ['description' => '内存整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
'name' => 'MemorySampleDuration',
'in' => 'query',
'schema' => ['description' => '内存整体采样时长,取值范围: 30\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'MemorySingleRateLimit',
'in' => 'query',
'schema' => ['description' => '单个进程内存使用率百分比,取值范围: 30\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'MemoryDownGradeDuration',
'in' => 'query',
'schema' => ['description' => '单个进程内存降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'EndUserApplyAdminCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户请求管理员协助。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'EndUserGroupCoordinate',
'in' => 'query',
'schema' => [
'description' => '同一个办公网络下用户共享云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IP' => '指定IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
],
[
'name' => 'Recording',
'in' => 'query',
'schema' => [
'description' => '是否开启录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['period' => '间隔录屏', 'session' => '会话录屏', 'off' => '关闭', 'alltime' => '全程录屏'],
'example' => 'off',
],
],
[
'name' => 'RecordingAudio',
'in' => 'query',
'schema' => [
'description' => '录制云电脑声音的选项。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '录制画面', 'on' => '录制系统及外设声音'],
'example' => 'on',
],
],
[
'name' => 'RecordingStartTime',
'in' => 'query',
'schema' => ['description' => '录屏开始时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:00:00'],
],
[
'name' => 'RecordingEndTime',
'in' => 'query',
'schema' => ['description' => '录屏结束时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:59:00'],
],
[
'name' => 'RecordingFps',
'in' => 'query',
'schema' => ['description' => '录屏帧率。单位:FPS(帧/秒)。', 'type' => 'string', 'required' => false, 'example' => '2'],
],
[
'name' => 'RecordingDuration',
'in' => 'query',
'schema' => ['description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。取值范围:10~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'RecordingExpires',
'in' => 'query',
'schema' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15'],
],
[
'name' => 'RecordingUserNotify',
'in' => 'query',
'schema' => [
'description' => '提示终端客户已开启录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不提示客户开启录屏', 'on' => '提示客户会开启录屏'],
'example' => 'off',
],
],
[
'name' => 'RecordingUserNotifyMessage',
'in' => 'query',
'schema' => ['description' => '提示终端客户开启录屏的信息。', 'type' => 'string', 'required' => false, 'example' => 'Screen recording is enabled.'],
],
[
'name' => 'AdminAccess',
'in' => 'query',
'schema' => [
'description' => '用户登录云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '强制允许', 'deny' => '强制拒绝', 'inherited' => '继承用户维度的管理员权限控制'],
'example' => 'deny',
],
],
[
'name' => 'EnableSessionRateLimiting',
'in' => 'query',
'schema' => [
'description' => '会话带宽限速。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'SessionMaxRateKbps',
'in' => 'query',
'schema' => ['description' => '会话带宽限速最大值。单位:Kbps。取值范围:2000~100000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'DisplayMode',
'in' => 'query',
'schema' => [
'description' => '显示模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['clientCustom' => '用户自主配置', 'adminOffice' => '日常办公场景', 'adminDesign' => '设计及3D应用', 'adminCustom' => '自定义'],
'example' => 'clientCustom',
],
],
[
'name' => 'StreamingMode',
'in' => 'query',
'schema' => [
'description' => '流模式适配场景。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['intelligent' => '智能模式', 'smooth' => '流畅优先'],
'example' => 'smooth',
],
],
[
'name' => 'ColorEnhancement',
'in' => 'query',
'schema' => [
'description' => '设计及3D应用场景选择是否开启色彩增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'SmoothEnhancement',
'in' => 'query',
'schema' => [
'description' => '日常办公场景选择,是否开启平滑度增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'QualityEnhancement',
'in' => 'query',
'schema' => [
'description' => '设计及3D应用场景选择是否开启画质增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'VideoEncPolicy',
'in' => 'query',
'schema' => [
'description' => '视频编码策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['qualityFirst' => '质量优先', 'bandwidthFirst' => '带宽优先'],
'example' => 'qualityFirst',
],
],
[
'name' => 'TargetFps',
'in' => 'query',
'schema' => ['description' => '目标帧率,取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncMinQP',
'in' => 'query',
'schema' => ['description' => '视频编码最小QP,最高质量。取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncMaxQP',
'in' => 'query',
'schema' => ['description' => '视频编码最大QP,画面最低质量,取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncAvgKbps',
'in' => 'query',
'schema' => ['description' => '视频编码平均码率。单位:Kbps。取值范围:1000\\~50000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'VideoEncPeakKbps',
'in' => 'query',
'schema' => ['description' => '视频编码峰值码率。单位:Kbps。取值范围:1000~50000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'MaxReconnectTime',
'in' => 'query',
'schema' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'WyAssistant',
'in' => 'query',
'schema' => [
'description' => '通过桌面端(包括Windows客户端和macOS客户端)连接云电脑时,是否在云电脑悬浮球内提供无影AI助手功能入口。'."\n"
."\n"
.'> 仅适用于V7.7或更高版本的桌面端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '打开'],
'example' => 'on',
],
],
[
'name' => 'CpuProcessors',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'required' => false, 'example' => 'notepad.exe'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'MemoryProcessors',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'required' => false, 'example' => 'chrome.exe'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'DomainResolveRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名解析策略。',
'type' => 'array',
'items' => [
'description' => '域名解析策略详情。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'],
'Policy' => [
'description' => '解析策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'required' => false, 'example' => '测试规则'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'NetRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'array',
'items' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'],
'RuleType' => [
'description' => '规则类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['prc' => '进程', 'domain' => '域名'],
'example' => 'domain',
],
'Policy' => ['description' => '重定向策略。', 'type' => 'string', 'required' => false, 'example' => 'allow'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ScopeValue',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '`Scope`取值为`IP`的时候填写。当`Scope`为`IP`时生效,否则不生效。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block范围。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24'],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '登录方式管控规则列表。用于控制可通过哪些客户端访问云电脑。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不允许', 'on' => '允许'],
'example' => 'off',
],
'ClientType' => [
'description' => '登录方式管控,设置客户端类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'ios' => 'iOS客户端', 'windows' => 'Windows客户端', 'macos' => 'macOS客户端'],
'example' => 'windows',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'UsbSupplyRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '04**'],
'UsbRuleType' => [
'description' => 'USB重定向规则类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [2 => '产品'],
'example' => '2',
],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'required' => false, 'example' => '测试规则'],
'UsbRedirectType' => [
'description' => 'USB重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [1 => '允许', '拒绝'],
'example' => '1',
],
'ProductId' => ['description' => '产品ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '08**'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthorizeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则列表。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'inflow',
],
'Policy' => [
'description' => '安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求 [默认值]'],
'example' => 'accept',
],
'PortRange' => ['description' => '安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(\\/)隔开起始端口和终止端口。例如:1\\/200。'."\n"
.'- ICMP协议:端口为-1\\/-1。'."\n"
.'- GRE协议:端口为-1\\/-1。'."\n"
.'- IpProtocol取值为all:端口为-1\\/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => 'TCP协议', 'UDP' => 'UDP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'TCP',
],
'Priority' => ['description' => '安全组管控规则的优先级。数字越小,代表优先级越高。 '."\n"
.'取值范围:1~60。 '."\n"
.'默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '10.0.XX.XX/8'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'AuthorizeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '客户端IP白名单列表。设置后,仅白名单网段内的IP地址可访问云电脑。',
'type' => 'array',
'items' => [
'description' => '客户端IP白名单列表。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'DeviceRedirects',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备重定向规则列表。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则列表。',
'type' => 'object',
'properties' => [
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'usb重定向', 'off' => '关闭'],
'example' => 'usbRedirect',
],
'DeviceType' => [
'description' => '设备类型',
'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' => '自定义外设规则列表。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则列表。',
'type' => 'object',
'properties' => [
'DeviceName' => ['description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'sandisk'],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '禁止'],
'example' => 'usbRedirect',
],
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['usbKey' => 'UKey', 'other' => '其他', 'graphicsTablet' => '手绘板', 'cardReader' => '读卡器', 'printer' => '打印机', 'scanner' => '扫描仪', 'storage' => '存储设备', 'camera' => '摄像头', 'networkInterfaceCard' => '网卡设备'],
'example' => 'storage',
],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'required' => false, 'example' => '2:0'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '0x55b1'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '0x0781'],
'Platforms' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'WatermarkAntiCam',
'in' => 'query',
'schema' => [
'description' => '盲水印防拍照功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'WatermarkPower',
'in' => 'query',
'schema' => [
'description' => '盲水印增强功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['high' => '高', 'low' => '低', 'medium' => '中'],
'example' => 'medium',
],
],
[
'name' => 'DomainResolveRuleType',
'in' => 'query',
'schema' => [
'description' => '域名解析策略类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'ClipboardScope',
'in' => 'query',
'schema' => [
'title' => '剪切板生效范围',
'description' => '剪切板生效范围',
'type' => 'string',
'required' => false,
'example' => 'GLOBAL',
'enum' => ['global', 'grained'],
],
],
[
'name' => 'ClipboardGraineds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '剪切板精细化控制配置',
'description' => '剪切板精细化控制配置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GrainedType' => [
'type' => 'string',
'required' => false,
'enum' => ['text', 'richtext', 'file', 'picture'],
'description' => '',
],
'ClipboardType' => [
'type' => 'string',
'required' => false,
'enum' => ['off', 'read', 'readwrite', 'write'],
'description' => '',
],
'ClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'ClipboardSizeUnit' => ['type' => 'string', 'required' => false, 'description' => ''],
'InClipboardSize' => ['type' => 'integer', 'format' => 'int32'],
'InClipboardSizeUnit' => ['type' => 'string'],
'OutClipboardSize' => ['type' => 'integer', 'format' => 'int32'],
'OutClipboardSizeUnit' => ['type' => 'string'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 4,
],
],
[
'name' => 'StatusMonitor',
'in' => 'query',
'schema' => [
'description' => '是否在云电脑悬浮球内提供状态监控功能入口。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MobileRestart',
'in' => 'query',
'schema' => [
'description' => '通过移动端(Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供重启按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MobileShutdown',
'in' => 'query',
'schema' => [
'description' => '通过移动端(Android客户端和iOS客户端),是否在云电脑悬浮球内提供关机按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'ResolutionModel',
'in' => 'query',
'schema' => [
'description' => '分辨率类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['adaptive' => '自适应分辨率', 'customer' => '固定分辨率'],
'example' => 'adaptive',
],
],
[
'name' => 'ResolutionWidth',
'in' => 'query',
'schema' => ['description' => '分辨率的宽度。单位:像素。云应用取值范围:500\\~50000, 云电脑取值范围:640\\~4096。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
],
[
'name' => 'ResolutionHeight',
'in' => 'query',
'schema' => ['description' => '分辨率的高度。单位:像素。云应用取值范围:500\\~50000, 云电脑取值范围:480\\~4096。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280'],
],
[
'name' => 'Taskbar',
'in' => 'query',
'schema' => [
'description' => '应用任务栏。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'NoOperationDisconnect',
'in' => 'query',
'schema' => [
'description' => '无操作断连。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'NoOperationDisconnectTime',
'in' => 'query',
'schema' => ['description' => '无操作断连时长。取值范围:120\\~7200。单位:秒。'."\n"
."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'DisconnectKeepSession',
'in' => 'query',
'schema' => [
'description' => '会话断连保留。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['customTime' => '固定时间', 'persistent' => '不断连'],
'example' => 'customTime',
],
],
[
'name' => 'DisconnectKeepSessionTime',
'in' => 'query',
'schema' => ['description' => '会话断连保留时长。取值范围:30\\~7200。单位:秒。'."\n"
."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'RecordEvents',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏事件列表。',
'type' => 'array',
'items' => [
'description' => '录屏事件。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['transferWithLocal' => '剪贴板及文件传输操作', 'userInput' => '用户输入', 'usbRedirect' => 'USB外设插拔'],
'example' => 'transferWithLocal',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RecordEventFilePaths',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏审计中的文件监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的文件监控绝对路径。', 'type' => 'string', 'required' => false, 'example' => 'C://test.txt'],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'RecordEventRegisters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏审计中的注册表监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的注册表监控绝对路径。', 'type' => 'string', 'required' => false, 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR'],
'required' => false,
'maxItems' => 10,
'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR',
],
],
[
'name' => 'RecordEventDuration',
'in' => 'query',
'schema' => ['description' => '录屏审计中检测到事件发生后录屏的时长。单位:分钟。取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'ResetDesktop',
'in' => 'query',
'schema' => ['description' => '重置云电脑。', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'DeviceConnectHint',
'in' => 'query',
'schema' => ['description' => '外设连接提示控制。', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'FileMigrate',
'in' => 'query',
'schema' => ['description' => '文件迁移。', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'WuyingKeeper',
'in' => 'query',
'schema' => ['description' => '无影管家开关。', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'InternetPrinter',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'SafeMenu',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ScreenDisplayMode',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientControlMenu',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FileTransferSpeedLocation',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FileTransferSpeed',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FileTransferAddress',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'CpdDriveClipboard',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'UseTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AutoReconnect',
'in' => 'query',
'schema' => ['title' => '客户端自动重连开关', 'description' => '客户端自动重连开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileWuyingKeeper',
'in' => 'query',
'schema' => ['title' => '移动端无影管家开关', 'description' => '移动端无影管家开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileSafeMenu',
'in' => 'query',
'schema' => ['title' => '移动端Windows 安全控制开关', 'description' => '移动端Windows 安全控制开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileWyAssistant',
'in' => 'query',
'schema' => ['title' => '移动端小颖的开关', 'description' => '移动端小颖的开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'RecordEventLevels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '录屏事件的级别',
'description' => '录屏事件的级别',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'required' => false, 'example' => 'StartApplication'],
'EventLevel' => ['title' => '事件等级', 'description' => '事件等级', 'type' => 'string', 'required' => false, 'example' => 'HIGH'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'RecordEventFileExts',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '录屏事件文件扩展名',
'description' => '录屏事件文件扩展名',
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'example' => 'txt', 'description' => ''],
'required' => false,
'maxItems' => 6,
],
],
[
'name' => 'ExternalDrive',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'WatermarkShadow',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientCreateSnapshot',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AcademicProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ModelLibrary',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'PortProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'DiskOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'CpuOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'MemoryOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'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'],
],
[
'name' => 'KeyboardControl',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'AdminKeyboardOnWindows',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'AdminKeyboardOnFullScreen',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyGroupId' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****'],
'RequestId' => ['description' => '请求ID。', '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' => '创建无地域策略',
'changeSet' => [
['createdAt' => '2025-12-10T02:25:36.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-23T13:39:02.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CreateCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateCloudDriveGroup' => [
'summary' => '云盘组织授权。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '无影云盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '组织团队ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7f4bbccda0cf40bb85981b65fb5e****', 'minLength' => 0],
],
[
'name' => 'TotalSize',
'in' => 'query',
'schema' => ['description' => '无影云盘团队空间的容量。单位为Byte,默认不限大小。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1024000'],
],
[
'name' => 'AdminUserIds',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => '要设置成团队空间管理员的用户Id列表。',
'type' => 'array',
'items' => ['description' => '用户Id。', 'type' => 'string', 'required' => false, 'example' => 'admin1'],
'required' => false,
'maxItems' => 100,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FD14D2A1-CC39-5ED3-8EE7-11FDF4B9D6D2'],
'Code' => ['description' => '修改结果。返回success表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'True'],
'Data' => ['description' => '数据信息。', 'type' => 'string', 'example' => '[]'],
'Message' => ['description' => '错误信息。当Code为success时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
],
'description' => '',
],
],
],
'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' => '添加团队空间',
'description' => '云盘团队列表是从无影客户端->用户管理->组织结构同步过来的,如果用户想要使用团队空间,需要在用户管理界面将用户移动到指定组织下,用户在云盘客户端可看到团队空间的菜单栏。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveGroup'],
],
],
'ramActions' => [],
],
'CreateCloudDriveService' => [
'summary' => '创建企业网盘(原无影云盘)。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '企业网盘名称。', 'type' => 'string', 'required' => false, 'example' => 'wuying-cds'],
],
[
'name' => 'OfficeSiteType',
'in' => 'query',
'schema' => [
'description' => '办公网络类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SIMPLE' => '便捷办公网络', 'AD_CONNECTOR' => 'AD办公网络'],
'example' => 'SIMPLE',
'default' => 'SIMPLE',
],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID,当办公网络类型为`AD_CONNECTOR`时有效。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****'],
],
[
'name' => 'CenId',
'in' => 'query',
'schema' => ['description' => '当`OfficeSiteType`为`AD_CONNECTOR`时,表示AD办公网络的云企业网实例ID。当`OfficeSiteId`不为空时,此值可不填写。', 'type' => 'string', 'required' => false, 'example' => 'cen-g4ba1mkji8nj6****'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '当`OfficeSiteType`为`AD_CONNECTOR`时,表示AD办公网络对应的域控名称。当`OfficeSiteId`不为空时,此值可不填写。', 'type' => 'string', 'required' => false, 'example' => 'test.local'],
],
[
'name' => 'UserMaxSize',
'in' => 'query',
'schema' => ['description' => '分配用户个人盘时,个人盘的存储峰值。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '104857600'],
],
[
'name' => 'MaxSize',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '网盘存储空间最大峰值。'."\n"
."\n"
.'- 创建按量付费网盘时,单位为Byte(字节)。'."\n"
.'- 创建预付费网盘时,单位为GiB。例如,如需创建500GiB的预付费网盘,则填写500;如需创建2TiB的预付费网盘,则填写2048。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '536870912000'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户ID列表。',
'type' => 'array',
'items' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'docRequired' => false,
'maxItems' => 100,
],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => ['description' => '> 该参数不开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
],
[
'name' => 'SolutionId',
'in' => 'query',
'schema' => ['description' => '> 该参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'CdsChargeType',
'in' => 'query',
'schema' => [
'description' => '网盘付费类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '预付费'],
'example' => 'PostPaid',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。[默认值]'],
'example' => 'false',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '是否自动续费。仅当付费类型为`PrePaid`时,该参数才生效且为可选参数。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '自动续费', 'false' => '不自动续费 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '购买资源的时长。单位由`PeriodUnit`指定。当参数`CdsChargeType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '1', '2', '3'],
'example' => '1',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '预付费网盘的购买时长单位。当参数`CdsChargeType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Year' => '年'],
'example' => 'Year',
],
],
[
'name' => 'UserCount',
'in' => 'query',
'schema' => [
'description' => '预付费网盘的用户数量限额。当参数`CdsChargeType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [5 => '当MaxSize为500GiB时,限额为5人', 20 => '当MaxSize为2TiB时,限额为20人', 50 => '当MaxSize为5TiB时,限额为50人'],
'example' => '5',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A156****'],
'CdsId' => ['description' => '企业网盘ID。', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****'],
'CdsName' => ['description' => '云存储服务名称。', 'type' => 'string', 'example' => 'CDS_Windows_1126'],
'MaxSize' => ['description' => '企业网盘最大存储峰值。单位:Byte(字节)。', 'type' => 'string', 'example' => '5368709120'],
'OfficeSiteType' => [
'description' => '办公网络类型。',
'type' => 'string',
'enumValueTitles' => ['SIMPLE' => '便捷办公网络', 'AD_CONNECTOR' => 'AD办公网络'],
'example' => 'AD_CONNECTOR',
],
'CenId' => ['description' => '云企业网CEN实例ID。'."\n"
."\n"
.'> 如果想要通过VPC连接的方式接入云电脑,可以将办公网络加入到云企业网实例中。该云企业网实例为本地网络通过VPN或者专线接入的云企业网实例。', 'type' => 'string', 'example' => 'cen-638u3wxds9snyc****'],
'DomainName' => ['description' => 'AD办公网络对应的AD域名称。', 'type' => 'string', 'example' => 'test1.local'],
'OrderId' => ['description' => '订单ID。您可以在阿里云用户中心的订单管理页面获取。', 'type' => 'string', 'example' => '214552063030752'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'ExistConflictCds'],
'ConflictCdsAndOrder' => [
'description' => '与当前要创建的网盘冲突的存量网盘或网盘订单。',
'type' => 'object',
'properties' => [
'ConflictCds' => [
'description' => '冲突的网盘信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CdsId' => ['description' => '企业网盘ID。', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****'],
'RegionId' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'description' => '',
],
],
'ConflictOrder' => [
'description' => '冲突的未支付的网盘订单信息(预付费网盘的订单)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CdsId' => ['description' => '企业网盘ID(订单尚未支付,网盘不可使用)。', 'type' => 'string', 'example' => 'cn-hangzhou+cds-778205****'],
'OrderId' => ['description' => '订单ID。您可以在阿里云用户中心的**订单管理**页面获取。', 'type' => 'string', 'example' => '22442411898****'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'title' => '创建企业网盘',
'description' => '请确保在使用该接口前,已充分了解企业网盘的收费方式和价格。详细信息请参见[企业网盘概述](~~386301~~)。',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-19T03:11:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-03-12T12:16:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-12-11T14:21:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T14:32:34.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveService'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateCloudDriveService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A156****\\",\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"CdsName\\": \\"CDS_Windows_1126\\",\\n \\"MaxSize\\": \\"5368709120\\",\\n \\"OfficeSiteType\\": \\"AD_CONNECTOR\\",\\n \\"CenId\\": \\"cen-638u3wxds9snyc****\\",\\n \\"DomainName\\": \\"test1.local\\",\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"ErrorCode\\": \\"ExistConflictCds\\",\\n \\"ConflictCdsAndOrder\\": {\\n \\"ConflictCds\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"ConflictOrder\\": [\\n {\\n \\"CdsId\\": \\"cn-hangzhou+cds-778205****\\",\\n \\"OrderId\\": \\"22442411898****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'CreateCloudDriveUsers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-352282****'],
],
[
'name' => 'UserMaxSize',
'in' => 'query',
'schema' => ['description' => '用户个人盘的存储峰值。该值不可大于企业网盘中可分配的剩余容量。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '209715200'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回消息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05F0A7AE-17F1-53DF-BD99-ABF936FA****'],
],
],
],
],
'title' => '添加用户个人盘',
'summary' => '在企业网盘中添加用户个人盘。',
'changeSet' => [
['createdAt' => '2025-10-16T08:02:13.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveUsers'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05F0A7AE-17F1-53DF-BD99-ABF936FA****\\"\\n}","type":"json"}]',
],
'CreateConfigGroup' => [
'summary' => '创建配置组。配置组中包含云电脑中心定时任务的配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'Name',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '配置组名称。', 'type' => 'string', 'required' => true, 'example' => 'Scheduled task group'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '配置组描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task description content', 'maxLength' => 500],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '配置组类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Timer' => '定时任务'],
'example' => 'Timer',
'enum' => ['Timer'],
],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '配置组使用的产品类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
],
[
'name' => 'ConfigTimers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '定时任务的配置信息,列表结构。',
'type' => 'array',
'items' => [
'description' => '定时任务配置信息。',
'type' => 'object',
'properties' => [
'TimerType' => [
'description' => '定时任务类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['NoOperationDisconnect' => '无操作断连', 'NoConnect' => '断连任务(需指定OperationType)', 'TimerBoot' => '定时开机', 'TimerReset' => '定时重置', 'NoOperationShutdown' => '无操作关机', 'NoOperationHibernate' => '无操作休眠', 'TimerShutdown' => '定时关机', 'NoOperationReboot' => '无操作重启', 'TimerReboot' => '定时重启'],
'example' => 'TIMER_BOOT',
],
'CronExpression' => ['description' => '定时任务Cron表达式。'."\n"
."\n"
.'>需要传入UTC标准时间,即北京时间每天0点应该传入0 0 16 ? * 1,2,3,4,5,6,7>', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'],
'Interval' => ['description' => '时间间隔,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
'Enforce' => ['description' => '是否强制执行。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'ResetType' => [
'description' => '云电脑重置类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '只重置系统盘', 'RESET_TYPE_USER_DISK' => '只重置数据盘', 'RESET_TYPE_BOTH' => '同时重置系统盘和数据盘'],
'example' => 'RESET_TYPE_SYSTEM',
],
'AllowClientSetting' => ['description' => '是否允许终端用户自行配置定时任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'OperationType' => [
'description' => '定时任务操作类型,目前仅断连定时任务支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hibernate' => '休眠', 'Shutdown' => '关机'],
'example' => 'Shutdown',
],
'TriggerType' => [
'description' => '无操作定时任务触发配置类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Advanced' => '智能判断', 'Standard' => '标准判断'],
'example' => 'Standard',
],
'ProcessWhitelist' => [
'description' => '无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。',
'type' => 'array',
'items' => ['description' => '进程名称。', 'type' => 'string', 'required' => false, 'example' => 'chrome'],
'required' => false,
'maxItems' => 30,
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'SegmentTimers' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperationType' => ['type' => 'string', 'required' => false, 'description' => ''],
'StartCronExpression' => ['type' => 'string', 'required' => false, 'description' => ''],
'EndCronExpression' => ['type' => 'string', 'required' => false, 'description' => ''],
'Interval' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'TriggerType' => ['type' => 'string', 'required' => false, 'description' => ''],
'ProcessWhitelist' => [
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'maxItems' => 30,
'description' => '',
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'Timezone' => ['type' => 'string', 'required' => false, 'description' => ''],
'Enforce' => ['type' => 'boolean', 'required' => false, 'description' => ''],
'ResetType' => ['type' => 'string', 'required' => false, 'description' => ''],
'ImageId' => ['title' => '变更镜像定时任务使用,指定需要变更的镜像ID', 'type' => 'string', 'required' => false, 'example' => 'm-5b0vjqbiqu010XXXXXX', 'description' => '变更镜像定时任务使用,指定需要变更的镜像ID'],
'LockScreenTime' => ['title' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1800', 'description' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用'],
'AppointmentTimer' => ['title' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1764660600967', 'description' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务'],
'PatchId' => ['title' => '补丁ID', 'type' => 'string', 'example' => 'KB5082063'],
'CreateSnapshot' => ['title' => '是否创建快照', 'type' => 'boolean', 'default' => 'false'],
'VerificationTime' => ['type' => 'integer', 'format' => 'int32'],
'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32'],
'IpSegments' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 10,
],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 10,
'description' => '',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '创建结果',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'EE9472BC-0B5D-5458-85CD-C52BDD******'],
'GroupId' => ['description' => '配置组ID。', 'type' => 'string', 'example' => 'ccg-0ctwi5zbswtql****'],
'Message' => ['description' => '创建结果。', 'type' => 'string', 'example' => '无'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TestCode%sTestCode%sTestCode%s', 'errorMessage' => 'TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s.', 'description' => ''],
],
],
'title' => '创建配置组',
'changeSet' => [
['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-08-22T12:24:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-26T02:20:25.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE9472BC-0B5D-5458-85CD-C52BDD******\\",\\n \\"GroupId\\": \\"ccg-0ctwi5zbswtql****\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]',
],
'CreateDesktopGroup' => [
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'BundleId',
'in' => 'query',
'schema' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'b-je9hani001wfn****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑所属的办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-9c2d6t2dwflqr****'],
],
[
'name' => 'DesktopGroupName',
'in' => 'query',
'schema' => ['description' => '共享型云电脑名称。不超过30个字符。必须以大小字母或中文开头,不能以`http://`和`https://`开头。可以包含中文、英文、数字、半角冒号(:)、下划线(\\_)、点号(.)或者短划线(-)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SharedComputers01'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '目录ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dri-uf62w3qzt4aigvlcb****'],
],
[
'name' => 'ScaleStrategyId',
'in' => 'query',
'schema' => ['description' => '伸缩策略ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ss-f9dkjz6vw3aaw****'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑的办公网络所在的VPC ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vpc-uf6w8u60n8xbkg5el****'],
],
[
'name' => 'DefaultInitDesktopCount',
'in' => 'query',
'schema' => ['description' => '创建多台共享型云电脑时默认创建的云电脑数量。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'KeepDuration',
'in' => 'query',
'schema' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '180000'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '云电脑的付费类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '包年包月共享型云电脑的购买时长。当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。单位由`PeriodUnit`指定。'."\n"
.'- 如果`PeriodUnit`为`Month`,该参数的取值范围:'."\n"
.' - 1'."\n"
.' - 2'."\n"
.' - 3'."\n"
.' - 6'."\n"
.'- 如果`PeriodUnit`为`Year`,该参数的取值范围:'."\n"
.' - 1'."\n"
.' - 2'."\n"
.' - 3'."\n"
.' - 4'."\n"
.' - 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月计费方式的时长单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'OwnType',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑类型。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['个人型(单会话)', '共享型(多会话)'],
'example' => '0',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => ['description' => '是否自动支付包年包月订单。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'comment'],
],
[
'name' => 'MinDesktopsCount',
'in' => 'query',
'schema' => ['description' => '包年包月的多台共享型云电脑的自动创建数量上限。即当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。默认值为1,取值范围为0~`MaxDesktopsCount`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'MaxDesktopsCount',
'in' => 'query',
'schema' => ['description' => '按量付费的多台共享型云电脑的最大数量。取值范围:0~500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '50'],
],
[
'name' => 'AllowAutoSetup',
'in' => 'query',
'schema' => [
'description' => '是否允许包年包月的多台共享型云电脑内自动创建云电脑。即当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '1',
'minimum' => '0',
'enumValueTitles' => ['不允许', '允许'],
'example' => '1',
],
],
[
'name' => 'AllowBufferCount',
'in' => 'query',
'schema' => ['description' => '按量付费的多台共享型云电脑内允许预留的云电脑数量。当参数`ChargeType`取值为`PostPaid`时才生效,且为必选值。取值范围: '."\n"
.'- 0:不预留'."\n"
.'- N:预留N台(1≤N≤100)'."\n"
."\n"
.'> 如果不预留可用云电脑,当终端用户发起连接请求时,系统需要先创建并启动云电脑,然后分配给用户,所需时间相对较长。建议您根据需要预留一定数量的云电脑,保证终端用户的使用体验。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑的用户ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 1000,
],
],
[
'name' => 'ResetType',
'in' => 'query',
'schema' => [
'description' => '云电脑重置类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['不重置', '只重置系统盘', '只重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '0',
],
],
[
'name' => 'LoadPolicy',
'in' => 'query',
'schema' => [
'description' => '多会话共享型云电脑的负载均衡策略。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '0',
],
],
[
'name' => 'BindAmount',
'in' => 'query',
'schema' => ['description' => '多会话共享型云电脑中每台云电脑允许的并发会话数。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'Classify',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑的类型。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['teacher' => '教师共享型云电脑', 'student' => '学生共享型云电脑'],
'example' => 'teacher',
],
],
[
'name' => 'AllClassifyUsers',
'in' => 'query',
'schema' => ['description' => '所有共享型云电脑分类的用户。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'boolean', 'required' => false, 'example' => 'Alice'],
],
[
'name' => 'VolumeEncryptionEnabled',
'in' => 'query',
'schema' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'VolumeEncryptionKey',
'in' => 'query',
'schema' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
],
[
'name' => 'RatioThreshold',
'in' => 'query',
'schema' => ['description' => '会话占用率阈值,用作多会话共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5'],
],
[
'name' => 'ConnectDuration',
'in' => 'query',
'schema' => ['description' => '会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。取值范围:900000(15分钟)~345600000(4天)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900000'],
],
[
'name' => 'IdleDisconnectDuration',
'in' => 'query',
'schema' => ['description' => '用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。取值范围为360000(6分钟)~3600000(60分钟)。'."\n"
."\n"
.'在达到该时长的30秒前,会话中的终端用户将收到保存文档数据的提示消息,此时终端用户需及时保存文档数据,避免丢失。'."\n"
."\n"
.'> 仅适用于镜像版本号不低于1.0.2的云电脑。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360000'],
],
[
'name' => 'StopDuration',
'in' => 'query',
'schema' => ['description' => '空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300000'],
],
[
'name' => 'ProfileFollowSwitch',
'in' => 'query',
'schema' => ['description' => '是否开启用户数据漫游。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'schema' => ['description' => '用户数据漫游功能使用的NAS文件系统ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'example' => 'kegd-nas-****'],
],
[
'name' => 'BuyDesktopsCount',
'in' => 'query',
'schema' => ['description' => '- 对于包年包月多台共享型云电脑:初始创建云电脑的数量。取值范围:0\\~200。'."\n"
.'- 对于按量付费多台共享型云电脑:初始创建云电脑的最小数量。默认值为1,取值范围为0\\~`MaxDesktopsCount`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'GroupVersion',
'in' => 'query',
'schema' => ['description' => '共享型云电脑版本。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '是否为包年包月共享型云电脑开启自动续费。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开启自动续费', 'false' => '不开启自动续费'],
'example' => 'false',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表,最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。可以为空字符串。最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => true, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠券ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_*****'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****'],
],
[
'name' => 'SystemDiskCategory',
'in' => 'query',
'schema' => [
'description' => '系统盘类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cloud_auto' => 'SSD极速云盘', 'cloud_essd' => 'ESSD云盘'],
'example' => 'cloud_auto',
],
],
[
'name' => 'SystemDiskSize',
'in' => 'query',
'schema' => ['description' => '系统盘大小,单位:GiB。'."\n"
."\n"
.'> 系统盘大小不能小于镜像文件。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
],
[
'name' => 'SystemDiskPerLevel',
'in' => 'query',
'schema' => [
'description' => 'ESSD磁盘性能等级,默认为PL0。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0'],
'example' => 'PL0',
],
],
[
'name' => 'DataDiskCategory',
'in' => 'query',
'schema' => [
'description' => '数据盘类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cloud_auto' => 'SSD极速云盘', 'cloud_essd' => 'ESSD云盘'],
'example' => 'cloud_auto',
],
],
[
'name' => 'DataDiskSize',
'in' => 'query',
'schema' => ['description' => '挂载的数据盘容量大小。单位:GB。取值范围:0~16380,取值必须是20的整数倍。'."\n"
."\n"
.''."\n"
.'- 取值为0时,表示不挂载数据盘。'."\n"
."\n"
.'- 如果您选择的套餐使用的是ESSD云盘(性能级别PL0),则挂载的数据盘容量最小值为40 GB。'."\n"
."\n"
.'- 如果您选择的套餐使用的是SSD云盘,则挂载的数据盘容量最小值为20 GB。'."\n"
."\n"
.''."\n"
."\n"
.''."\n"
.'- 取值为0时,表示不挂载数据盘。'."\n"
."\n"
.'- 如果您选择的套餐使用的是SSD云盘,则挂载的数据盘容量最小值为20 GB。'."\n"
."\n"
.''."\n"
."\n"
.'默认值:0', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
],
[
'name' => 'DataDiskPerLevel',
'in' => 'query',
'schema' => [
'description' => 'ESSD磁盘性能等级,默认为PL0。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0'],
'example' => 'PL0',
],
],
[
'name' => 'DefaultLanguage',
'in' => 'query',
'schema' => [
'description' => '系统语言。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en-US' => '英语', 'zh-HK' => '繁体中文', 'zh-CN' => '简体中文', 'ja-JP' => '日语'],
'example' => 'zh-CN',
],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['description' => '云电脑规格。您可以调用[DescribeDesktopTypes](~~DescribeDesktopTypes~~)查询云电脑支持的规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.16c64g'],
],
[
'name' => 'Hostname',
'in' => 'query',
'schema' => ['description' => '自定义设置云电脑的主机名称。仅支持设置AD办公网络下,操作系统类型是Windows的云电脑。'."\n"
."\n"
.'主机名称的命名规则如下:'."\n"
."\n"
.'- 长度为2~15个字符。'."\n"
.'- 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。'."\n"
."\n"
.'创建多台云电脑时,可以使用`name_prefix[begin_number,bits]name_suffix`的命名格式为多台云电脑统一命名。例如,设置Hostname的取值为ecd-[1,4]-test,则第一台云电脑主机名称为ecd-0001-test,第二台云电脑主机名称为ecd-0002-test,依次类推。'."\n"
."\n"
.'- ` name_prefix`:主机名称的前缀。'."\n"
.'- ` [begin_number,bits]`:主机名称中的有序数字。`begin_number`为起始数字,取值支持0\\~999999,默认值为0;`bits`为数字位数,取值支持1\\~6,默认值为6。'."\n"
.'- `name_suffix`:主机名称的后缀。', 'type' => 'string', 'required' => false, 'example' => 'testhost'],
],
[
'name' => 'MultiResource',
'in' => 'query',
'schema' => [
'description' => '是否为多台共享类型的共享型云电脑。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '多台共享型云电脑', 'false' => '单台共享型云电脑'],
'example' => 'false',
],
],
[
'name' => 'ExclusiveType',
'in' => 'query',
'schema' => ['description' => '创建静态池。当参数`SessionType`的值为`MultipleSession`时,必须传入此参数,值固定填写为`Exclusive`。', 'type' => 'string', 'required' => false, 'example' => 'Exclusive'],
],
[
'name' => 'GroupAmount',
'in' => 'query',
'schema' => ['description' => '创建单台共享型云电脑的数量。只有当`MultiResource`参数的值为`false`时才需要传入该参数。取值范围:1\\~5。默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'SessionType',
'in' => 'query',
'schema' => [
'description' => '会话类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SingleSession' => '单会话', 'MultipleSession' => '多会话'],
'example' => 'SingleSession',
],
],
[
'name' => 'TimerGroupId',
'in' => 'query',
'schema' => ['description' => '定时任务组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****'],
],
[
'name' => 'SnapshotPolicyId',
'in' => 'query',
'schema' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-28mp6my0l6zow****'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
[
'name' => 'UserOuPath',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'UserGroupName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'SimpleUserGroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'DeleteDuration',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-2i8qxpv6t1a03****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983'],
'OrderIds' => [
'description' => '订单ID。',
'type' => 'array',
'items' => ['description' => '订单ID。当请求参数`ChargeType`取值为`PrePaid`时,返回该参数。', 'type' => 'string', 'example' => '123456789'],
],
'DesktopGroupIds' => [
'description' => '共享型云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑ID列表。', 'type' => 'string', 'example' => '[\'dg-1np2yupx0uim****\']'],
],
],
],
],
],
'title' => '创建共享型云电脑',
'summary' => '创建共享型云电脑。',
'description' => '- 关于共享型云电脑的功能和应用场景、使用限制、伸缩策略等信息,请参见[共享型云电脑(原云电脑池)概述](~~290959~~)。'."\n"
.'- 调用本接口之前,请确保已创建办公网络、云电脑模板、策略等必需的前置资源。',
'changeSet' => [
['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-08-09T10:00:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-05T03:57:04.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-28T10:13:17.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-23T08:23:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-24T14:47:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-11T02:32:36.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-12T07:02:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktopGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopGroupId\\": \\"dg-2i8qxpv6t1a03****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\",\\n \\"OrderIds\\": [\\n \\"123456789\\"\\n ],\\n \\"DesktopGroupIds\\": [\\n \\"[\'dg-1np2yupx0uim****\']\\"\\n ]\\n}","type":"json"}]',
],
'CreateDesktops' => [
'summary' => '创建一台或多台云电脑。创建时若传入用户信息,可直接完成云电脑的分配。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '云电脑池ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5****'],
],
[
'name' => 'BundleId',
'in' => 'query',
'schema' => ['description' => '云电脑模板ID。未选择模版ID时,可以通过填充必备字段完成创建。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'b-je9hani001wfn****'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。命名规则如下:'."\n"
."\n"
.'- 不超过64个字符。'."\n"
.'- 必须以大小字母或中文开头,不能以`http://`和`https://`开头。'."\n"
.'- 可以包含中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01'],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'username'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6w8u60n8xbkg5el****'],
],
[
'name' => 'Amount',
'in' => 'query',
'schema' => ['description' => '创建的云电脑数量。取值范围为1~300,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-300943****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-387822****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'system-all-enabled-policy'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '云电脑的计费方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费 [默认值]', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '购买资源的时长。单位由`PeriodUnit`指定。当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。'."\n"
."\n"
.'- 如果`PeriodUnit`为`Month`,该参数的取值范围:'."\n"
."\n"
.' - 1'."\n"
.' - 2'."\n"
.' - 3'."\n"
.' - 6'."\n"
."\n"
.'- 如果`PeriodUnit`为`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' => '包年包月计费方式的时长单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单 [默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付'],
'example' => 'false',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '是否自动续费。当参数`ChargeType`取值为`PrePaid`时才生效。 ',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动续费。续费时长与购买设置的时长保持一致', 'false' => '不自动续费 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '23141'],
],
[
'name' => 'UserAssignMode',
'in' => 'query',
'schema' => [
'description' => '云电脑分配模式。'."\n"
."\n"
.'> 如果未设置`EndUserId`,创建的云电脑不会分配给用户。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['ALL' => '如果设置了EndUserId,则将创建的云电脑分配给每个指定的用户 [默认值]', 'PER_USER' => '如果设置了EndUserId,则将创建的云电脑平均分配给指定的用户。此时需确保Amount的值可以被EndUserId的个数(即N)整除'],
'example' => 'ALL',
],
],
[
'name' => 'Hostname',
'in' => 'query',
'schema' => ['description' => '自定义设置云电脑的主机名称。仅支持设置AD办公网络下,操作系统类型是Windows的云电脑。'."\n"
."\n"
.'主机名称的命名规则如下:'."\n"
."\n"
.'- 长度为2~15个字符。'."\n"
.'- 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。'."\n"
."\n"
.'创建多台云电脑时,可以使用`name_prefix[begin_number,bits]name_suffix`的命名格式为多台云电脑统一命名。例如,设置Hostname的取值为ecd-[1,4]-test,则第一台云电脑主机名称为ecd-0001-test,第二台云电脑主机名称为ecd-0002-test,依次类推。'."\n"
."\n"
.'- ` name_prefix`:主机名称的前缀。'."\n"
.'- ` [begin_number,bits]`:主机名称中的有序数字。`begin_number`为起始数字,取值支持0\\~999999,默认值为0;`bits`为数字位数,取值支持1\\~6,默认值为6。'."\n"
.'- `name_suffix`:主机名称的后缀。', 'type' => 'string', 'required' => false, 'example' => 'testhost'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '为云电脑添加的授权用户ID列表。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '为云电脑添加的授权用户ID。'."\n"
."\n"
.'- 在同一时段内,只有一个用户可以使用该云电脑。'."\n"
.'- 如果未设置`EndUserId`,创建的云电脑不会分配给任何用户。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'example' => '123456789',
'maxItems' => 300,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。可设置1~20个。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。可设置1~20个。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'DesktopNameSuffix',
'in' => 'query',
'schema' => [
'description' => '批量创建云电脑时,云电脑名称是否自动增加后缀。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '自动增加后缀 [默认值]', 'false' => '不增加后缀'],
'example' => 'false',
],
],
[
'name' => 'VolumeEncryptionEnabled',
'in' => 'query',
'schema' => [
'description' => '是否开启磁盘加密。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开启磁盘加密', 'false' => '不开启磁盘加密 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'VolumeEncryptionKey',
'in' => 'query',
'schema' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
],
[
'name' => 'DesktopMemberIp',
'in' => 'query',
'schema' => ['description' => '指定云电脑私网IP。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1'],
],
[
'name' => 'UserCommands',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户自定义命令脚本数据。'."\n",
'type' => 'array',
'items' => [
'description' => '用户自定义命令脚本数据。',
'type' => 'object',
'properties' => [
'ContentEncoding' => [
'title' => '自定义脚本命令编码,默认Base64编码',
'description' => '命令内容(CommandContent)的编码方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Base64' => 'Base64编码', 'PlainText' => '不编码,采用明文传输'],
'example' => 'Base64',
'default' => 'Base64',
],
'Content' => ['description' => '命令内容。', 'type' => 'string', 'required' => false, 'example' => 'bmV3LWl0ZW0gZDpcdGVzdF91c2VyX2NvbW1hbmRzLnR4dCAtdHlwZSBm****', 'maxLength' => 15000],
'ContentType' => [
'description' => '命令的语言类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RunPowerShellScript' => '适用于Windows实例的PowerShell命令', 'RunShellScript' => '适用于Linux实例Shell命令', 'RunBatScript' => '适用于Windows实例的Bat命令'],
'example' => 'RunPowerShellScript',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'BundleModels',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '云电脑模板列表。',
'type' => 'array',
'items' => [
'description' => '云电脑模板。',
'type' => 'object',
'properties' => [
'BundleId' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => false, 'example' => 'b-je9hani001wfn****'],
'Amount' => ['description' => '创建的云电脑数量。取值范围为1~300,默认值为0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'example' => '1'],
'EndUserIds' => [
'description' => '云电脑分配用户列表。',
'type' => 'array',
'items' => ['description' => '用户名称。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 100,
],
'DesktopName' => ['description' => '云电脑名称。命名规则如下:'."\n"
."\n"
.'- 不超过64个字符。'."\n"
.'- 必须以大小字母或中文开头,不能以`http://`和`https://`开头。'."\n"
.'- 可以包含中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer02'],
'Hostname' => ['description' => '自定义设置云电脑的主机名称。仅支持设置AD办公网络下,操作系统类型是Windows的云电脑。'."\n"
."\n"
.'主机名称的命名规则如下:'."\n"
."\n"
.'- 长度为2~15个字符。'."\n"
.'- 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。'."\n"
."\n"
.'创建多台云电脑时,可以使用`name_prefix[begin_number,bits]name_suffix`的命名格式为多台云电脑统一命名。例如,设置Hostname的取值为ecd-[1,4]-test,则第一台云电脑主机名称为ecd-0001-test,第二台云电脑主机名称为ecd-0002-test,依次类推。'."\n"
."\n"
.'- ` name_prefix`:主机名称的前缀。'."\n"
.'- ` [begin_number,bits]`:主机名称中的有序数字。`begin_number`为起始数字,取值支持0\\~999999,默认值为0;`bits`为数字位数,取值支持1\\~6,默认值为6。'."\n"
.'- `name_suffix`:主机名称的后缀。', 'type' => 'string', 'required' => false, 'example' => 'testhost'],
'VolumeEncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', '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' => '云电脑定时任务详情。该参数在逐步废弃中,请优先使用TImerGroupId参数进行设置。',
'type' => 'array',
'items' => [
'description' => '云电脑定时任务详情。',
'type' => 'object',
'properties' => [
'TimerType' => ['description' => '定时任务类型。', 'type' => 'string', 'required' => false, 'example' => 'NoOperationReboot'],
'CronExpression' => ['description' => '定时任务Cron表达式。'."\n"
."\n"
.'>需要传入UTC标准时间,即北京时间每天0点应该传入0 0 16 ? * 1,2,3,4,5,6,7>', 'type' => 'string', 'required' => false, 'example' => '0 40 7 ? * 1,2,3,4,5,6,7'],
'Interval' => ['description' => '时间间隔,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
'Enforce' => [
'description' => '是否强制执行。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '忽略云电脑及连接状态检测,强制执行定时任务', 'false' => '不强制执行'],
'example' => 'true',
],
'ResetType' => [
'description' => '云电脑重置类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '重置系统盘', 'RESET_TYPE_BOTH' => '重置系统盘和用户磁盘'],
'example' => 'RESET_TYPE_SYSTEM',
],
'OperationType' => [
'description' => '定时任务操作类型,目前仅断连定时任务支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hibernate' => '休眠', 'Shutdown' => '关机'],
'example' => 'Shutdown',
],
'AllowClientSetting' => ['description' => '是否允许终端用户自行配置定时任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'SubnetId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '子网ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1m*****'],
],
[
'name' => 'MonthDesktopSetting',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '按月小时包购买参数。',
'type' => 'object',
'properties' => [
'UseDuration' => ['description' => '购买按月小时包时的套餐选择,当前可选值为120/250/360。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
'BuyerId' => ['description' => '> 此字段暂不对外开放使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'null'],
'DesktopId' => ['description' => '> 此字段暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
'required' => false,
],
],
[
'name' => 'SnapshotPolicyId',
'in' => 'query',
'schema' => ['description' => '无影自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-28mp6my0l6zow****'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '无影资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-3mtuc28rx95lx****'],
],
[
'name' => 'DesktopAttachment',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '无模板方式入参,在传入BundleID参数时该参数无效。',
'type' => 'object',
'properties' => [
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-39ddhdb0ggzjx*****'],
'SystemDiskCategory' => ['description' => '系统盘类型。系统盘与数据盘类型需一致,取值范围:'."\n"
.'- cloud_auto:SSD极速云盘'."\n"
.'- cloud_essd:ESSD云盘', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'],
'SystemDiskSize' => ['description' => '系统盘容量。60~500GiB,每10GiB为一个步长,单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
'SystemDiskPerLevel' => ['description' => 'ESSD磁盘性能等级。如果选用了ESSD类型磁盘,则需要填入该参数,可选值:'."\n"
.'- PL0'."\n"
.'- PL1', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
'DataDiskSize' => ['description' => '用户磁盘容量。 40~2040GiB,每10GiB为一个步长,单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
'DataDiskCategory' => ['description' => '数据盘类型。系统盘与数据盘类型需一致,取值范围:'."\n"
.'- cloud_auto:SSD极速云盘'."\n"
.'- cloud_essd:ESSD云盘', 'type' => 'string', 'required' => false, 'example' => 'cloud_auto'],
'DataDiskPerLevel' => ['description' => 'ESSD磁盘性能等级。如果选用了ESSD类型磁盘,则需要填入该参数,可选值:'."\n"
.'- PL0'."\n"
.'- PL1', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
'DefaultLanguage' => ['description' => '语言选择,可选值:'."\n"
.'- zh-CN'."\n"
.'- zh-HK'."\n"
.'- en-US'."\n"
.'- ja-JP', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
'DesktopType' => ['description' => '云电脑规格。您可以调用[DescribeDesktopTypes](~~188882~~)查询云电脑支持的规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g'],
],
'required' => false,
],
],
[
'name' => 'TimerGroupId',
'in' => 'query',
'schema' => ['description' => '定时任务组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****'],
],
[
'name' => 'SavingPlanId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '> 此字段暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'spn-26c1b7bcrjcI****'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['description' => '转售模式的资源归属用户ID,非转售模式无需填写该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1828644634819902'],
],
[
'name' => 'ExtendInfo',
'in' => 'query',
'schema' => ['description' => 'JSON字符串扩展信息。仅内部客户可用。', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'AppRuleId',
'in' => 'query',
'schema' => ['description' => '应用管控策略ID', 'type' => 'string', 'required' => false, 'example' => 'bwr-245d4e0e6b7d42f5afa97eb3fbc7e488'],
],
[
'name' => 'QosRuleId',
'in' => 'query',
'schema' => ['description' => '公网限速规则ID。', 'type' => 'string', 'required' => false, 'example' => 'qos-52fqmg6kvyro7zu4l'],
],
[
'name' => 'ChannelCookie',
'in' => 'query',
'schema' => ['description' => '> 此字段暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'PBKB1QbqEl2tslEuU6gRrLxvCFBU2M%2FVD0Eru6Oo%2FI9LTU3XQhvq3PGMWarE%2BPJdkNvCqT3blqlRSthNy4A%2BJQ%3D%3D'],
],
[
'name' => 'PurchaseOptions',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '特定购买类型的额外参数。',
'type' => 'object',
'properties' => [
'MonthlyCredits' => ['description' => '月积分包,用于购买Agent资源时的积分套餐选择,当前可选值为200/1600/4000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200'],
],
'required' => false,
],
],
[
'name' => 'OuPath',
'in' => 'query',
'schema' => ['title' => 'OU路径,指定后,云电脑将加入AD对应的OU下', 'description' => 'OU路径,指定后,云电脑将加入AD对应的OU下', 'type' => 'string', 'required' => false, 'example' => 'test.com/wuyingtest/computers'],
],
[
'name' => 'SubPayType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。'."\n"
.'> 当请求参数ChargeType取值为PrePaid时,返回该参数。', 'type' => 'string', 'example' => '123456789'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'DesktopId' => [
'description' => '云电脑ID返回集合信息,如果一次调用创建了多个云电脑,将返回多个云电脑ID。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => '["ecd-gx2x1dhsmucyy****"]'],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidEncryptionKey.Missing', 'errorMessage' => 'Parameter VolumeEncryptionKey is missing.', 'description' => '开启磁盘加密功能时,加密密钥不可为空'],
['errorCode' => 'InvalidEncryptionKey.NotAuthorized', 'errorMessage' => 'Eds service cannot access the given VolumeEncryptionKey.', 'description' => '无法访问未经授权的加密密钥'],
['errorCode' => 'InvalidEncryptionKey.NotFound', 'errorMessage' => 'The specified VolumeEncryptionKey is not found.', 'description' => '找不到指定的磁盘加密密钥'],
['errorCode' => 'InvalidImageStatus.NotValid', 'errorMessage' => 'The specified image status is not valid.', 'description' => '指定镜像的状态不可用,不支持创建桌面'],
['errorCode' => 'InvalidImageVersion.NotSupported', 'errorMessage' => 'The specified image version is no longer supported.', 'description' => '指定的镜像版本已不再支持,请选择其他镜像'],
['errorCode' => 'InvalidMemberIp.DesktopAmount', 'errorMessage' => 'The desktop amount need to be 1.', 'description' => '指定IP创建桌面时,桌面数量仅可为1'],
['errorCode' => 'InvalidPolicyGroup.Status', 'errorMessage' => 'The target policy group is being created. Please try again later.', 'description' => '目标策略组正在创建中,请稍后再试。'],
['errorCode' => 'Protocol.NotAllowed', 'errorMessage' => 'Procotol of the image is not allowed.', 'description' => '不支持该镜像的协议类型,请检查镜像ID'],
['errorCode' => 'ExistedHostname', 'errorMessage' => 'The specified hostname is existed on the domain.', 'description' => '指定的主机名在当前工作区已存在'],
['errorCode' => 'HostnameCannotCustomizeForLinux', 'errorMessage' => 'Customizing hostname is not supported for Linux desktop.', 'description' => '自定义主机名功能不支持Linux桌面'],
['errorCode' => 'IncorrectDirectoryStatus', 'errorMessage' => 'Only registered directory can create desktop.', 'description' => '工作区状态错误,仅支持使用已注册的工作区创建桌面'],
['errorCode' => 'IncorrectDirectoryType', 'errorMessage' => 'The protocol type of directory and desktop do not match.', 'description' => '指定工作区和目标桌面的协议类型不匹配,请检查'],
['errorCode' => 'InvalidAmount', 'errorMessage' => 'The specified Amount is not a valid value.', 'description' => '指定的数量不合法'],
['errorCode' => 'InvalidAmount.NotTimesOfUsers', 'errorMessage' => 'The specified Amount is notmatch EndUserId size.', 'description' => '指定的桌面数量不等于待分配用户的数量,请重新指定'],
['errorCode' => 'InvalidDesktopBundle.NotFound', 'errorMessage' => 'The specified param BundleId is not found.', 'description' => '指定的BundleId找不到'],
['errorCode' => 'InvalidDirectoryId.NotFound', 'errorMessage' => 'The specified param DirectoryId is not found.', 'description' => '无法找到工作区ID,请检查工作区ID是否正确'],
['errorCode' => 'InvalidDirectoryType.NotSupported', 'errorMessage' => 'The specified DirectoryType is not supported.', 'description' => '指定的工作区类型不支持创建该桌面'],
['errorCode' => 'InvalidEncryptionEnabled.Invalid', 'errorMessage' => 'The parameter VolumeEncryptionEnabled is invalid.', 'description' => '指定加密密钥时,需开启磁盘加密功能'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 123456789\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n [\\"ecd-gx2x1dhsmucyy****\\"]\\n","errorExample":""}]',
'title' => '创建一台或多台云电脑',
'description' => '创建云电脑前,请先完成以下准备工作:'."\n"
.'- 已创建办公网络(原工作区)和用户。相关接口或文档请参见:'."\n"
.' - 便捷办公网络:[CreateSimpleOfficeSite](~~215416~~)、[CreateUsers](~~437832~~)。'."\n"
.' - AD办公网络:[CreateADConnectorOfficeSite](~~215417~~)、[创建AD用户](~~188619~~)。'."\n"
.'- 已调用[CreatePolicyGroup](~~188889~~)创建策略,或确认使用已有策略。'."\n"
."\n"
.'**调用示例:**'."\n"
.''."\n"
.'使用模板创建入参示例
'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "RegionId": "cn-hangzhou",'."\n"
.' "DesktopName": "test-desktop-name",'."\n"
.' "Amount": "1",'."\n"
.' "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前创建办公网络'."\n"
.' "PolicyGroupId": "system-all-enabled-policy",'."\n"
.' "ChargeType": "PostPaid",'."\n"
.' "BundleId": "b-enterprise_office_8c16g_windows2022"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' '."\n"
.''."\n"
.'无模板方式创建示例
'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "RegionId": "cn-hangzhou",'."\n"
.' "DesktopName": "test-desktop-name",'."\n"
.' "Amount": "1",'."\n"
.' "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前创建办公网络'."\n"
.' "PolicyGroupId": "system-all-enabled-policy",'."\n"
.' "ChargeType": "PostPaid",'."\n"
.' "DesktopAttachment": {'."\n"
.' "ImageId": "desktopimage-windows-server-2022-64-asp",'."\n"
.' "SystemDiskSize": "40",'."\n"
.' "DataDiskSize": "0",'."\n"
.' "DefaultLanguage": "zh-CN",'."\n"
.' "DesktopType": "eds.enterprise_office.4c8g"'."\n"
.' }'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' '."\n"
.''."\n"
.'创建按月小时包入参示例
'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "RegionId": "cn-hangzhou",'."\n"
.' "DesktopName": "test-desktop-name",'."\n"
.' "Amount": "1",'."\n"
.' "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前创建办公网络'."\n"
.' "PolicyGroupId": "system-all-enabled-policy",'."\n"
.' "ChargeType": "PostPaid",'."\n"
.' "DesktopAttachment": {'."\n"
.' "ImageId": "desktopimage-windows-server-2022-64-asp",'."\n"
.' "SystemDiskSize": "40",'."\n"
.' "DataDiskSize": "0",'."\n"
.' "DefaultLanguage": "zh-CN",'."\n"
.' "DesktopType": "eds.enterprise_office.4c8g"'."\n"
.' },'."\n"
.' "MonthDesktopSetting": {'."\n"
.' "UseDuration": "120"'."\n"
.' },'."\n"
.' "Period": "1",'."\n"
.' "PeriodUnit": "Month"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' '."\n"
.''."\n"
.'创建Agent资源入参示例
'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "RegionId": "cn-hangzhou",'."\n"
.' "BundleId": "b-openclaw-linux",'."\n"
.' "DesktopName": "test-desktop-name",'."\n"
.' "Amount": "1",'."\n"
.' "OfficeSiteId": "cn-hangzhou+dir-xxx",// 需要提前创建办公网络'."\n"
.' "ChargeType": "PostPaid",'."\n"
.' "DesktopAttachment": {'."\n"
.' "DesktopType": "cloud.space.4c.8g"'."\n"
.' },'."\n"
.' "PurchaseOptions": {'."\n"
.' "MonthlyCredits": "120"'."\n"
.' },'."\n"
.' "Period": "1",'."\n"
.' "PeriodUnit": "Month"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.' '."\n"
."\n\n"
.'如需让云电脑自动执行自定义命令脚本,可使用`UserCommands`字段配置自定义命令。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-10-16T07:32:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-29T08:05:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-22T02:00:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-07T09:58:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-26T07:06:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-24T06:10:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-17T06:49:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-11T09:32:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-10T07:45:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-31T10:03:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-22T02:11:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-29T13:57:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-21T14:36:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-15T13:06:19.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2023-11-15T12:06:54.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2023-05-24T02:48:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-24T02:38:08.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-24T07:40:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-03-14T11:45:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-08-08T06:45:17.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-09-24T05:56:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateDiskEncryptionService' => [
'summary' => '开启磁盘加密功能,在用户RAM下添加企业网盘加密的服务关联角色(SLR)。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '214552063030752'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => [
'description' => '请求是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '请求成功', 'false' => '请求失败'],
'example' => 'true',
],
],
],
],
],
'title' => '开启磁盘加密功能',
'changeSet' => [
['createdAt' => '2022-05-23T04:01:14.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDiskEncryptionService'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CreateDrive' => [
'summary' => '创建用户级别存储资源。',
'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' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'AliUid',
'in' => 'query',
'schema' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1202****'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'DomainId',
'in' => 'query',
'schema' => ['description' => '存储资源ID。'."\n"
.'> 可通过DescribeDrives接口获取。', 'type' => 'string', 'required' => false, 'example' => 'dom-aaaa****'],
],
[
'name' => 'ExternalDomainId',
'in' => 'query',
'schema' => ['description' => '外部存储资源ID。'."\n"
.'> 可通过DescribeDrives接口获取。', 'type' => 'string', 'required' => false, 'example' => '1234****'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '存储资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['NAS' => 'NAS存储', 'PDS' => 'PDS存储'],
'example' => 'NAS',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '存储资源用途。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DESKTOP' => '数据盘空间', 'USER_PROFILE' => '用户个人数据空间'],
'example' => 'USER_PROFILE',
],
],
[
'name' => 'DriveName',
'in' => 'query',
'schema' => ['description' => '用户级别存储资源名称。', 'type' => 'string', 'required' => false, 'example' => 'test01'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '用户级别存储资源简介。', 'type' => 'string', 'required' => false, 'example' => 'test01'],
],
[
'name' => 'ProfileRoaming',
'in' => 'query',
'schema' => ['description' => '> 此参数已废弃。', 'type' => 'boolean', 'required' => false, 'example' => '-'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B7AA****'],
'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'successful'],
'Code' => ['description' => '响应代码,200表示成功。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Drive' => [
'description' => '用户级别的存储资源。',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'ID。', 'type' => 'string', 'example' => '1'],
'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-07-02T08:42:26.000+00:00'],
'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-07-07T02:46:04.000+00:00'],
'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1202****'],
'DomainId' => ['description' => '存储资源ID。', 'type' => 'string', 'example' => 'dom-aaaa****'],
'DriveId' => ['description' => '用户级别的存储资源ID。', 'type' => 'string', 'example' => 'dri-aaaa****'],
'ExternalDriveId' => ['description' => '外部用户级别的存储资源ID。'."\n"
.'> 仅存储资源为PDS时返回此参数。', 'type' => 'string', 'example' => '1100****'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'user01'],
'ExternalUserId' => ['description' => '外部用户ID。', 'type' => 'string', 'example' => 'user01@cn-hangzhou.120****'],
'Name' => ['description' => '存储资源名称。', 'type' => 'string', 'example' => 'test****'],
'Description' => ['description' => '存储资源简介。', 'type' => 'string', 'example' => 'test****'],
'TotalSize' => ['description' => '用户级别存储资源总容量。'."\n"
.'> 单位:字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '536870912000'],
'UsedSize' => ['description' => '用户级别存储资源已用容量。'."\n"
.'> 单位:字节。', 'type' => 'integer', 'format' => 'int64', 'example' => '243175936'],
'Status' => [
'description' => '用户级别存储资源状态。',
'type' => 'string',
'enumValueTitles' => ['INIT' => '初始化', 'MAINTAIN' => '维护中', 'DELETING' => '删除中', 'INVALID' => '失效', 'NORMAL' => '正常', 'FAIL' => '失败'],
'example' => 'NORMAL',
],
'Type' => [
'description' => '存储资源用途。',
'type' => 'string',
'enumValueTitles' => ['DESKTOP' => '数据盘空间', 'USER_PROFILE' => '用户个人数据空间'],
'example' => 'USER_PROFILE',
],
'ProfileRoaming' => ['description' => '> 此参数已废弃。', 'type' => 'boolean', 'example' => '-'],
],
],
],
],
],
],
'title' => '创建用户级别存储资源',
'changeSet' => [
['createdAt' => '2022-08-31T07:11:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrive'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDrive',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Message\\": \\"successful\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Drive\\": {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": \\"1202****\\",\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true\\n }\\n}","type":"json"}]',
],
'CreateEcdReportTask' => [
'summary' => '创建数据报表导出任务。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'title' => '业务渠道, 取值:'."\n"
.'Enterprise:企业版'."\n"
.'Business:商业版',
'type' => 'string',
'enum' => ['Enterprise', 'Business'],
],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => [
'description' => '报表任务类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['RESOURCE_REPORT' => '资源报表'],
'example' => 'RESOURCE_REPORT',
],
],
[
'name' => 'SubType',
'in' => 'query',
'schema' => [
'description' => '报表任务子类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [' DESKTOP' => '云电脑'],
'example' => ' DESKTOP',
],
],
[
'name' => 'FilterList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '查询结果过滤条件列表,各个查询条件对象是“逻辑与”关系(&)。'."\n"
.'每个查询条件包含FilterKey、FilterValues,表示查询条件名称和具体取值。',
'type' => 'array',
'items' => [
'description' => '过滤条件对象',
'type' => 'object',
'properties' => [
'FilterKey' => ['description' => '报表查询过滤条件,根据SubType不同:'."\n"
.'1. 云电脑报表'."\n"
.'- KeyWord 云电脑关键字自动识别'."\n"
.'- RegionId 地域ID'."\n"
.'- DesktopId 云电脑ID'."\n"
.'- DesktopName 云电脑名称(模糊搜索)'."\n"
.'- OfficeSiteId 办公网络ID'."\n"
.'- OfficeSiteName 办公网络名称(模糊搜索)'."\n"
.'- Status 云电脑状态'."\n"
.'- DesktopType 桌面规格'."\n"
.'- DesktopIP 云电脑IP'."\n"
.'- SubPayType 购买方式'."\n"
.'- EndUserId 用户名称(模糊搜索)'."\n"
.'- ExpireTime 过期时间,格式为yyyy-MM-dd\'T\'HH:mm:ss\'Z\''."\n"
.'- IncludeAssignedUser 是否分配用户'."\n"
.'- ResourceGroupId 资源组ID'."\n"
.'- PolicyId 策略ID'."\n"
.'- Tag:{标签Key值} 云电脑标签(多标签查询时,传入多个Filter对象)', 'type' => 'string', 'required' => false, 'example' => 'Tag:TestKey'],
'FilterValues' => [
'description' => '过滤条件的值。'."\n"
.'当FilterKey是以下取值时,FIlterValues入参只取第一个值:'."\n"
.'- KeyWord'."\n"
.'- DesktopName'."\n"
.'- OfficeSiteName'."\n"
.'- DesktopIP'."\n"
.'- EndUserId'."\n"
.'- ExpireTime'."\n"
.'- IncludeAssignedUser',
'type' => 'array',
'items' => ['description' => '报表过滤条件查询具体值。', 'type' => 'string', 'required' => false, 'example' => '测试云电脑名称'],
'required' => false,
'maxItems' => 200,
'example' => 'Test cloud desktop name',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ReportFileName',
'in' => 'query',
'schema' => ['description' => '报表文件名称。', 'type' => 'string', 'required' => false, 'example' => 'Test report name'],
],
[
'name' => 'LangType',
'in' => 'query',
'schema' => [
'description' => '报表语言类型。枚举值。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['zh-CN' => '中文(默认)', 'en-GB' => '英文'],
'example' => 'zh-CN',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'True'],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为success时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'TaskId' => ['description' => '报表任务ID。', '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' => '创建无影报表任务',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateEcdReportTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CreateEcdReportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateImage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****'],
],
[
'name' => 'ImageName',
'in' => 'query',
'schema' => ['description' => '镜像名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testImageName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '镜像的描述信息。长度为2~256个英文或中文字符,不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'This is description.'],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-2zefuwk8l6ytcgd3bf4o'],
],
[
'name' => 'ImageResourceType',
'in' => 'query',
'schema' => ['description' => '此参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'deprecated'],
],
[
'name' => 'SnapshotIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '快照ID列表。',
'type' => 'array',
'items' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"s-2ze2ai7op1duq4mnx5ha\\"]'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AutoCleanUserdata',
'in' => 'query',
'schema' => [
'description' => '是否清除用户个人数据。若设为`true`,制作的镜像会清除`C:\\Users`目录下除`Administrator`、`Public`之外的其他目录的数据。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '清除用户个人数据', 'false' => '不清除用户个人数据 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => '镜像中包含的磁盘数据。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '仅保存系统盘数据', 'ALL' => '保存系统盘+数据盘数据 [默认值]'],
'example' => 'ALL',
],
],
[
'name' => 'DataSnapshotIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'maxItems' => 100,
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-gx2x1dhsmusr2****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '创建自定义镜像',
'summary' => '通过已部署好的云电脑创建自定义镜像,以便快速创建更多相同配置的云电脑,避免每次创建时重复配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-09T09:54:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-06-13T12:35:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-22T06:24:02.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateImage'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F5F82BA8-92FE-49E4-AEB9-9010CE7329F3\\n m-gx2x1dhsmusr2****\\n","errorExample":""}]',
],
'CreateNASFileSystem' => [
'summary' => '创建一个NAS文件系统。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统名称。文件名称需遵循以下规则:长度为2\\~128个英文或中文字符。必须以大小字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、下划线(_)或短划线(-)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testNAS'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统描述。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription'],
],
[
'name' => 'StorageType',
'in' => 'query',
'schema' => [
'description' => 'NAS文件系统的存储规格类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Capacity' => '容量型 [默认值]', 'Performance' => '性能型'],
'example' => 'Capacity',
],
],
[
'name' => 'EncryptType',
'in' => 'query',
'schema' => [
'description' => '文件系统是否使用KMS服务托管密钥,对文件系统落盘数据进行加密存储。在读写加密数据时,无需解密。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['不加密 [默认值]', '使用NAS托管密钥进行加密'],
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'FileSystemId' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'example' => '04f314****'],
'FileSystemName' => ['description' => 'NAS文件系统名称。', 'type' => 'string', 'example' => 'testNAS'],
'MountTargetDomain' => ['description' => '挂载点域名。', 'type' => 'string', 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
],
],
],
],
'title' => '创建NAS文件系统',
'description' => '- 每个标准办公网络可以创建一个NAS文件系统,用于满足办公网络内云电脑之间共享文件的需求。'."\n"
.'- 系统将自动创建一个通用型的NAS文件系统(存储规格为容量型和性能型,容量分别为10 PiB和1 PiB),并生成一个默认的挂载点。'."\n"
.'- NAS文件系统默认采用按量付费,您需要为实际使用的存储用量付费。您也可以搭配购买资源包来抵扣存储用量。'."\n"
."\n"
.'更多信息,请参见[创建共享存储NAS](~~214481~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-25T05:50:52.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNASFileSystem'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateNASFileSystem',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FileSystemId\\": \\"04f314****\\",\\n \\"FileSystemName\\": \\"testNAS\\",\\n \\"MountTargetDomain\\": \\"04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\"\\n}","type":"json"}]',
],
'CreateNetworkPackage' => [
'summary' => '为办公网络创建一个公网精品带宽。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网精品带宽的带宽大小。单位:Mbps。 '."\n"
."\n"
.'- 如果是包年包月精品带宽,则取值范围是2\\~1000。'."\n"
.'- 如果是按量付费精品带宽,且类型是按使用流量计费(PayByTraffic),则取值范围是2\\~200;'."\n"
.'- 如果是按量付费精品带宽,且类型是按固定带宽计费(PayByBandwidth),则取值范围是2\\~1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20000', 'minimum' => '2', 'example' => '2'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '付费类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
'schema' => [
'description' => '公网精品带宽的计费方式。'."\n"
."\n"
.'- 当参数`PayType`取值为`PrePaid`时,取值范围:'."\n"
.' - PayByBandwidth:按固定带宽计费。'."\n"
.'- 当参数`PayType`取值为`PostPaid`时,取值范围:'."\n"
.' - PayByTraffic:按使用流量计费。'."\n"
.' - PayByBandwidth:按固定带宽计费。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PayByTraffic' => '按使用流量付费', 'PayByBandwidth' => '按固定带宽计费'],
'example' => 'PayByTraffic',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '包年包月精品带宽的购买时长。当参数`PayType`取值为`PrePaid`时才生效,且为必选值。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Week`时,取值范围为:1。'."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1、2、3。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月精品带宽的购买时长单位。当参数`PayType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => 'Month', 'Year' => 'Year', 'Week' => 'Week'],
'example' => 'Week',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单。[默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。'],
'example' => 'false',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '是否自动续费。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动续费', 'false' => '不自动续费'],
'example' => 'false',
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '23141'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
[
'name' => 'ChannelCookie',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['type' => 'string'],
'Value' => ['type' => 'string'],
],
],
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'NetworkPackageId' => ['description' => '精品带宽ID。', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
'OrderId' => ['description' => '账单ID。', '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.', 'description' => '为保护您的账户安全,下单被中止,详情请联系客服。'],
],
],
'title' => '为办公网络创建公网精品带宽',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-09-22T02:00:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-08-06T09:59:53.000Z', 'description' => '错误码发生变更、请求参数发生变更'],
['createdAt' => '2025-07-22T04:52:51.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-30T03:32:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-14T07:58:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkPackage'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateNetworkPackage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NetworkPackageId\\": \\"np-amtp8e8q1o9e4****\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"OrderId\\": \\"234526262716724\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\n np-amtp8e8q1o9e4****\\n","errorExample":""}]',
],
'CreateOfficeSiteAccelerator' => [
'summary' => '为办公网络开通全球加速。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-259382****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '全球加速实例名称。', 'type' => 'string', 'required' => false, 'example' => 'testGA'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-3mtuc28rx95lx****'],
],
[
'name' => 'AccelerateRegion',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要加速的上车点地域信息列表。',
'type' => 'array',
'items' => [
'description' => '要加速的地域信息。',
'type' => 'object',
'properties' => [
'AccelerateRegionId' => ['description' => '要加速的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'ap-southeast-1'],
'IpVersion' => [
'description' => '接入全球加速服务的IP地址协议。'."\n"
."\n"
.'> `DUAL_STACK`类型仅标准型按量计费的全球加速实例支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DUAL_STACK' => 'IPv4和IPv6地址协议', 'IPv6' => 'IPv6地址协议', 'IPv4' => 'IPv4地址协议 [默认值]'],
'example' => 'IPv4',
],
'Bandwidth' => ['description' => '加速地域分配的带宽。单位:Mbps。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '2', 'example' => '50'],
'IspType' => [
'description' => '加速地域公网线路类型。'."\n"
."\n"
.'> - 带宽计费方式为**按流量**的全球加速实例需要配置该项。'."\n"
.'> - 加速地域不同,支持的加速地域公网线路类型也不同。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['BGP' => 'BGP(多线)线路', 'BGP_PRO' => 'BGP(多线)_精品线路'],
'example' => 'BGP',
],
],
'required' => false,
],
'required' => true,
'docRequired' => true,
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'AcceleratorId' => ['description' => '全球加速实例ID。', 'type' => 'string', 'example' => 'ga-bp1qxuk10jceqw3zb***p'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开通全球加速',
'description' => '请确保在使用该接口前,已充分了解全球加速产品的收费方式和[价格](~~425831~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateOfficeSiteAccelerator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AcceleratorId\\": \\"ga-bp1qxuk10jceqw3zb***p\\"\\n}","type":"json"}]',
],
'CreatePolicyGroup' => [
'summary' => '创建云电脑策略。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Clipboard',
'in' => 'query',
'schema' => [
'description' => '剪贴板权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地', 'readwrite' => '双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地', 'write' => '单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑', 'off' => '双向禁止。云电脑和本地之间无法进行复制操作 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'LocalDrive',
'in' => 'query',
'schema' => [
'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件', 'readwrite' => '读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件', 'off' => '关闭。云电脑上没有本地磁盘的映射 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'UsbRedirect',
'in' => 'query',
'schema' => [
'description' => 'USB重定向。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'VisualQuality',
'in' => 'query',
'schema' => [
'description' => '图像显示质量策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['high' => '高清', 'low' => '流畅', 'lossless' => '无损', 'medium' => '自适应 [默认值]'],
'example' => 'medium',
],
],
[
'name' => 'Html5Access',
'in' => 'query',
'schema' => [
'description' => 'Web客户端访问策略。'."\n"
."\n"
.'> 推荐您使用`ClientType`相关参数统一管控登录方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '禁止 [默认值]', 'on' => '允许'],
'example' => 'off',
],
],
[
'name' => 'Html5FileTransfer',
'in' => 'query',
'schema' => [
'description' => 'Web客户端文传输策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'Watermark',
'in' => 'query',
'schema' => [
'description' => '水印。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['blind' => '开启盲水印', 'off' => '关闭水印 [默认值]', 'on' => '开启明水印'],
'example' => 'off',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '策略名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testPolicyGroupName'],
],
[
'name' => 'WatermarkType',
'in' => 'query',
'schema' => [
'description' => '水印类型。最多可以选择3个类型,用半角逗号隔开。'."\n"
."\n"
.'> 若传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['EndUserId' => '用户名', 'Custom' => '自定义文本', 'DesktopIp' => '云电脑IP地址', 'ClientIp' => '客户端IP地址', 'HostName' => '云电脑ID的后15位', 'ClientTime' => '云电脑当前时间'],
'example' => 'EndUserId',
],
],
[
'name' => 'WatermarkTransparency',
'in' => 'query',
'schema' => [
'description' => '水印显示的深浅程度。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['LIGHT' => '较浅 [默认值]', 'DARK' => '较深', 'MIDDLE' => '普通'],
'example' => 'LIGHT',
],
],
[
'name' => 'PreemptLogin',
'in' => 'query',
'schema' => [
'description' => '云电脑抢占策略。'."\n"
."\n"
.'> 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为`off`,且不可修改。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不允许多个用户之间互相抢占 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'DomainList',
'in' => 'query',
'schema' => [
'description' => '访问域名权限管控。域名支持通配符(\\*),多个域名之间以半角逗号隔开。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'PrinterRedirection',
'in' => 'query',
'schema' => [
'description' => '打印机重定向策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '打开'],
'example' => 'on',
],
],
[
'name' => 'PreemptLoginUser',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '允许抢占云电脑的一组用户的用户名,最多可以设置5个。'."\n"
.'> 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占。',
'type' => 'array',
'items' => ['description' => '可抢占云电脑的用户的用户名。', 'type' => 'string', 'required' => false, 'example' => 'Alice'],
'required' => false,
'example' => 'Alice',
'maxItems' => 5,
],
],
[
'name' => 'AuthorizeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'inflow',
],
'Policy' => [
'description' => '安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求 [默认值]'],
'example' => 'accept',
],
'PortRange' => ['description' => '安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(\\/)隔开起始端口和终止端口。例如:1\\/200。'."\n"
.'- ICMP协议:端口为-1\\/-1。'."\n"
.'- GRE协议:端口为-1\\/-1。'."\n"
.'- IpProtocol取值为all:端口为-1\\/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => 'TCP协议', 'UDP' => 'UDP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'tcp',
],
'Priority' => ['description' => '安全组管控规则的优先级。数字越小,代表优先级越高。 '."\n"
.'取值范围:1~60。 '."\n"
.'默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'AuthorizeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '客户端IP白名单列表。设置后,仅白名单网段内的IP地址可访问云电脑。',
'type' => 'array',
'items' => [
'description' => '客户端IP白名单。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'North China Branch'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '登录方式管控规则列表。用于控制可通过哪些客户端访问云电脑。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['OFF' => '不允许', 'ON' => '允许'],
'example' => 'ON',
],
'ClientType' => [
'description' => '登录方式管控,设置客户端类型。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'ios' => 'iOS客户端', 'windows' => 'Windows客户端', 'macos' => 'macOS客户端'],
'example' => 'windows',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'GpuAcceleration',
'in' => 'query',
'schema' => [
'description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'UsbSupplyRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '04**'],
'ProductId' => ['description' => '产品ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '08**'],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'required' => false, 'example' => '测试规则'],
'UsbRedirectType' => [
'description' => 'USB重定向类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '允许', '拒绝'],
'example' => '1',
],
'DeviceClass' => ['description' => '设备类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'required' => false, 'example' => '0Eh'],
'DeviceSubclass' => ['description' => '设备子类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'required' => false, 'example' => 'xxh'],
'UsbRuleType' => [
'description' => 'USB重定向规则类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '设备类别', '设备厂商'],
'example' => '1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DomainResolveRuleType',
'in' => 'query',
'schema' => [
'description' => '域名解析策略类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['OFF' => '关闭', 'ON' => '开启'],
'example' => 'OFF',
],
],
[
'name' => 'DomainResolveRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名解析策略详情。',
'type' => 'array',
'items' => [
'description' => '域名解析策略。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'],
'Policy' => [
'description' => '解析策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'required' => false, 'example' => '测试规则'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'Recording',
'in' => 'query',
'schema' => [
'description' => '是否开启录屏。',
'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' => '录屏开始时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:00:00'],
],
[
'name' => 'RecordingEndTime',
'in' => 'query',
'schema' => ['description' => '录屏结束时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:59:00'],
],
[
'name' => 'RecordingFps',
'in' => 'query',
'schema' => [
'description' => '录屏帧率。单位:FPS(帧/秒)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'],
'example' => '2',
],
],
[
'name' => 'RecordingExpires',
'in' => 'query',
'schema' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'],
],
[
'name' => 'CameraRedirect',
'in' => 'query',
'schema' => [
'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启 [默认值]'],
'example' => 'on',
],
],
[
'name' => 'NetRedirect',
'in' => 'query',
'schema' => [
'description' => '是否开启网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'AppContentProtection',
'in' => 'query',
'schema' => [
'description' => '是否开启防截屏功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'RecordContent',
'in' => 'query',
'schema' => [
'description' => '是否开启自定义录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'OFF',
],
],
[
'name' => 'RecordContentExpires',
'in' => 'query',
'schema' => ['description' => '自定义录屏的文件过期时间,默认30天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
],
[
'name' => 'RemoteCoordinate',
'in' => 'query',
'schema' => [
'description' => '远程协助时的键鼠控制权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['optionalControl' => '默认关闭(可以申请打开)', 'fullControl' => '完全控制', 'disableControl' => '不控制'],
'example' => 'fullControl',
],
],
[
'name' => 'RecordingDuration',
'in' => 'query',
'schema' => [
'description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'],
'example' => '10',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IP' => '根据IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
],
[
'name' => 'ScopeValue',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '`Scope`取值为`IP`的时候填写。当`Scope`为`IP`时生效,否则不生效。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block范围。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24'],
'required' => false,
'maxItems' => 3,
],
],
[
'name' => 'RecordingAudio',
'in' => 'query',
'schema' => [
'description' => '录制云电脑声音的选项。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '仅录制画面不录制声音', 'on' => '音画同期录制'],
'example' => 'on',
],
],
[
'name' => 'InternetCommunicationProtocol',
'in' => 'query',
'schema' => [
'description' => '网络通信协议。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => '只允许使用TCP [默认值]', 'BOTH' => '允许自动在TCP和UDP之间切换'],
'example' => 'both',
],
],
[
'name' => 'VideoRedirect',
'in' => 'query',
'schema' => [
'description' => '多媒体重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭媒体重定向', 'on' => '打开媒体重定向'],
'example' => 'on',
],
],
[
'name' => 'WatermarkTransparencyValue',
'in' => 'query',
'schema' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkColor',
'in' => 'query',
'schema' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'WatermarkDegree',
'in' => 'query',
'schema' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10'],
],
[
'name' => 'WatermarkFontSize',
'in' => 'query',
'schema' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkFontStyle',
'in' => 'query',
'schema' => [
'description' => '水印字体样式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['plain' => '普通', 'bold' => '加粗'],
'example' => 'plain',
],
],
[
'name' => 'WatermarkRowAmount',
'in' => 'query',
'schema' => ['description' => '水印行数。'."\n"
."\n"
.'> 此参数暂未开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'EndUserApplyAdminCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户申请管理员协助开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['OFF' => '关闭', 'ON' => '开启'],
'example' => 'ON',
],
],
[
'name' => 'EndUserGroupCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户之间流协同开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['OFF' => '关闭', 'ON' => '开启'],
'example' => 'ON',
],
],
[
'name' => 'WatermarkSecurity',
'in' => 'query',
'schema' => [
'description' => '盲水印安全优先规则。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'AdminAccess',
'in' => 'query',
'schema' => ['description' => '用户登录云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。', 'type' => 'string', 'required' => false, 'example' => 'deny'],
],
[
'name' => 'WatermarkAntiCam',
'in' => 'query',
'schema' => [
'description' => '盲水印防拍照功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'WatermarkPower',
'in' => 'query',
'schema' => [
'description' => '盲水印增强功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['high' => '高', 'low' => '低', 'medium' => '中'],
'example' => 'medium',
],
],
[
'name' => 'RecordingUserNotify',
'in' => 'query',
'schema' => [
'description' => '录屏客户端消息通知功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'RecordingUserNotifyMessage',
'in' => 'query',
'schema' => ['description' => '录屏客户端通知内容。默认无需填写。', 'type' => 'string', 'required' => false, 'example' => 'Your cloud desktop is being recorded.'],
],
[
'name' => 'MaxReconnectTime',
'in' => 'query',
'schema' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'DeviceRedirects',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备重定向规则列表。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['printer' => '打印机', 'scanner' => '扫描仪', 'camera' => '摄像头', 'adb' => 'Android设备'],
'example' => 'camera',
],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭重定向'],
'example' => 'deviceRedirect',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DeviceRules',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '自定义外设规则列表。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['usbKey' => 'UKey', 'other' => '其他', 'graphicsTablet' => '手绘板', 'printer' => '打印机', 'cardReader' => '读卡器', 'scanner' => '扫描仪', 'storage' => '存储设备', 'camera' => '摄像头', 'adb' => 'Android设备', 'networkInterfaceCard' => '网卡设备'],
'example' => 'storage',
],
'DeviceName' => ['description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'sandisk'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '0x0781'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '0x55b1'],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭重定向'],
'example' => 'usbRedirect',
],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'required' => false, 'example' => '2:0'],
'Platforms' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'WyAssistant',
'in' => 'query',
'schema' => [
'description' => '通过桌面端(包括Windows客户端和macOS客户端)连接云电脑时,是否在云电脑悬浮球内提供无影AI助手功能入口。'."\n"
."\n"
.'> 仅适用于V7.7或更高版本的桌面端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不提供', 'on' => '提供'],
'example' => 'on',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'PolicyGroupId' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****'],
'RequestId' => ['description' => '请求ID。', '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":"\\n1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\npg-gx2x1dhsmthe9****\\n","errorExample":""}]',
'title' => '创建云电脑策略',
'description' => '云电脑策略是一组规则的集合,主要包含云电脑性能和安全方面的配置,例如磁盘映射、USB重定向、水印等基础策略,以及DNS管控等规则。更多信息,请参见[策略概述](~~189345~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-14T04:04:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-15T02:54:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-07-31T09:50:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-22T01:55:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-07T06:02:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreatePolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateQosRule' => [
'summary' => '新建限速规则',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '精品带宽ID。', 'type' => 'string', 'required' => true, 'example' => 'np-cfedn7r2pe48g****'],
],
[
'name' => 'QosRuleName',
'in' => 'query',
'schema' => ['description' => '限速规则名称。', 'type' => 'string', 'required' => true, 'example' => 'Test'],
],
[
'name' => 'Upload',
'in' => 'query',
'schema' => ['description' => '上行带宽峰值。单位为Mbps。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5'],
],
[
'name' => 'Download',
'in' => 'query',
'schema' => ['description' => '下行带宽峰值。单位为Mbps。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5'],
],
[
'name' => 'AuthDesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '绑定云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-sfasdfsddsat*****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthAndroidId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '绑定云手机列表。',
'type' => 'array',
'items' => ['description' => '云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthDesktopGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
'QosRuleId' => ['description' => '限速规则ID。', 'type' => 'string', 'example' => 'qos-5605u0gelk200****'],
],
'description' => '',
],
],
],
'title' => '新建限速规则',
'description' => '云电脑模板分为系统模板和自定义模板,其中系统模板是阿里云提供的默认模板,调用本接口可以创建自定义模板。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateQosRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"QosRuleId\\": \\"qos-5605u0gelk200****\\"\\n}","type":"json"}]',
],
'CreateRAMDirectory' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryName',
'in' => 'query',
'schema' => ['description' => '目录名称。长度为2~255个英文或中文字符。必须以大小字母或中文字符开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => true, 'example' => 'testDirectoryName'],
],
[
'name' => 'EnableInternetAccess',
'in' => 'query',
'schema' => [
'description' => '是否开通公网访问功能。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开通公网访问功能', 'false' => '不开通公网访问功能'],
'example' => 'false',
],
],
[
'name' => 'EnableAdminAccess',
'in' => 'query',
'schema' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'true',
],
],
[
'name' => 'DesktopAccessType',
'in' => 'query',
'schema' => [
'description' => '连接云电脑时允许使用的方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['VPC' => 'VPC连接', 'Internet' => '公网连接 [默认值]', 'Any' => '公网和VPC均可'],
'example' => 'Internet',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '交换机ID。目前仅支持配置一个。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf62w3qzt4aigvlcb****'],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'DirectoryId' => ['description' => 'RAM类型的目录ID。', 'type' => 'string', 'example' => 'dri-uf62w3qzt4aigvlcb****'],
'RequestId' => ['description' => '请求ID。', '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' => '创建RAM类型的目录',
'summary' => '创建RAM类型的目录。',
'description' => '创建RAM类型的目录前,请先完成以下准备工作:'."\n"
."\n"
.'- 已在云电脑支持的地域下调用`CreateVpc`创建专有网络VPC。'."\n"
.'- 已在同一地域的专有网络VPC下,调用`CreateVSwitch`创建交换机,且交换机的可用区为云电脑在该地域下支持的可用区。可以调用[DescribeZones](~~196648~~)获取无影云电脑在某一个阿里云地域下支持的可用区信息。',
'changeSet' => [
['createdAt' => '2022-11-14T06:21:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:55.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRAMDirectory'],
],
],
'ramActions' => [],
],
'CreateSimpleOfficeSite' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CidrBlock',
'in' => 'query',
'schema' => ['description' => '办公网络VPC包含的IPv4网段。高级办公网络必填参数,系统将根据输入的IPv4网段,自动创建一个专有网络VPC。建议您使用以下网段及其子网作为IPv4网段:'."\n"
."\n"
.'- `10.0.0.0/12`(掩码有效范围为12\\~24位)'."\n"
.'- `172.16.0.0/12`(掩码有效范围为12\\~24位)'."\n"
.'- `192.168.0.0/16`(掩码有效范围为16\\~24位)', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/12'],
],
[
'name' => 'CenId',
'in' => 'query',
'schema' => ['description' => '云企业网CEN实例ID。'."\n"
."\n"
.'> 如果想要通过VPC连接的方式接入云电脑,可以将办公网络加入到云企业网实例中。该云企业网实例为本地网络通过VPN或者专线接入的云企业网实例。', 'type' => 'string', 'required' => false, 'example' => 'cen-3gwy16dojz1m65****'],
],
[
'name' => 'CenOwnerId',
'in' => 'query',
'schema' => ['description' => '云企业网实例所属的阿里云账号ID。'."\n"
."\n"
.'- 如果未配置CenId,或者配置的CenId属于本阿里云账号,该参数无需配置。'."\n"
.'- 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '118272523431****'],
],
[
'name' => 'VerifyCode',
'in' => 'query',
'schema' => ['description' => '验证码。如果配置的CenId属于其他阿里云账号,必须先调用[SendVerifyCode](~~335132~~)获取验证码。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网带宽峰值。取值范围:10~200。带宽单位为 Mbps。'."\n"
.'当`EnableInternetAccess`配置为`true`时可以设置该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以`http:/`/和`https://`开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'TestOfficeSite_Simple'],
],
[
'name' => 'EnableInternetAccess',
'in' => 'query',
'schema' => [
'description' => '是否开通公网访问功能。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开通', 'false' => '不开通 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'EnableAdminAccess',
'in' => 'query',
'schema' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'true',
],
],
[
'name' => 'DesktopAccessType',
'in' => 'query',
'schema' => [
'description' => '连接云电脑时允许使用的接入方式。'."\n"
."\n"
.'> VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为`VPC`或者`Any`时,系统将自动为您开通私网连接服务。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['VPC' => '只允许处于VPC网络内的客户端连接云电脑。', 'Internet' => '只允许客户端通过公网连接云电脑。[默认值]', 'Any' => '不限制方式。使用客户端连接云电脑时可以自行选择连接方式。'],
'example' => 'Internet',
],
],
[
'name' => 'NeedVerifyZeroDevice',
'in' => 'query',
'schema' => [
'description' => '是否开启可信设备校验。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开启可信设备校验', 'false' => '不开启可信设备校验'],
'example' => 'true',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '专有网络VPC中的交换机ID,创建云盒办公网络时需要填写。',
'type' => 'array',
'items' => ['description' => '专有网络VPC中的交换机ID,创建云盒办公网络时需要填写。', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp12mw1f8k3jgy****'],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'CloudBoxOfficeSite',
'in' => 'query',
'schema' => [
'description' => '是否为云盒办公网络。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '云盒办公网络', 'false' => '公网办公网络'],
'example' => 'false',
],
],
[
'name' => 'VpcType',
'in' => 'query',
'schema' => [
'description' => '办公网络的类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['standard' => '高级办公网络', 'basic' => '基础办公网络'],
'example' => 'standard',
],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AuthorityHost',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'TenantId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientSecret',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'Eid',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'AccessAttribute',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'NetworkSpace.VpcInfoExist', 'errorMessage' => 'vpc info already exist.', 'description' => '对应VPC已存在办公网络'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '创建基于便捷账号的办公网络',
'summary' => '无影云电脑支持便捷账号和企业AD账号这两种账号体系。本接口用于创建一个基于便捷账号的办公网络(原工作区)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-25T06:01:39.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2023-11-15T08:54:40.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSimpleOfficeSite'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateSimpleOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OfficeSiteId\\": \\"cn-hangzhou+os-c5cy7q578s8jc****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n cn-hangzhou+os-c5cy7q578s8jc****\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
],
'CreateSnapshot' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'ecd-gx2x1dhsmucyy****"'],
],
[
'name' => 'SnapshotName',
'in' => 'query',
'schema' => ['description' => '快照的显示名称。长度为2\\~127个英文或中文字符。必须以大小写字母或中文开头。可以包含数字、下划线(\\_)或者短划线(-)。为防止和自动快照的名称冲突,不能以`auto`开头。', 'type' => 'string', 'required' => true, 'example' => 'testSnapshotName', 'maxLength' => 128, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '快照描述。长度不能超过128个英文或中文字符。', 'type' => 'string', 'required' => false, 'example' => 'testDescription', 'maxLength' => 128],
],
[
'name' => 'SourceDiskType',
'in' => 'query',
'schema' => [
'description' => '要创建快照的磁盘类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['system' => '系统盘', 'data' => '数据盘'],
'example' => 'system',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 's-2ze81owrnv9pity4****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3EB7FCEE-D731-4948-85A3-4B2C341CA983'],
],
],
],
],
'title' => '为云电脑的磁盘创建一份快照',
'summary' => '为云电脑的磁盘创建一份快照,用于备份和恢复磁盘上的数据。',
'description' => '云电脑的状态必须为**运行中**或**已停止**。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-02-05T01:54:01.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-22T06:30:40.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SnapshotId\\": \\"s-2ze81owrnv9pity4****\\",\\n \\"RequestId\\": \\"3EB7FCEE-D731-4948-85A3-4B2C341CA983\\"\\n}","errorExample":""},{"type":"xml","example":"\\n s-2ze81owrnv9pity4****\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n","errorExample":""}]',
],
'CreateTemplate' => [
'summary' => '创建一个自定义的云电脑模板。云电脑模板(简称模板)是云电脑配置的合集,用于减少创建云电脑时的配置步骤,加快创建云电脑的速度。',
'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' => '模板的名称。必须符合以下要求:'."\n"
."\n"
.'- 长度2~126个英文或中文字符。'."\n"
.'- 必须以大小写字母或中文开头,不能以`http://`和`https://`开头。'."\n"
.'- 可以包含字母、数字、汉字、半角冒号(:)、下划线(_)或短划线(-),不支持点号(.)。', 'type' => 'string', 'required' => true, 'example' => 'My cloud desktop template 001', 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '模板的描述。必须符合以下要求:'."\n"
."\n"
.'- 长度2~256个字符,不能以`http://`和`https://`开头。'."\n"
.'- 支持中文、英文、数字、空格和特殊符号,使用回车换行。', 'type' => 'string', 'required' => false, 'example' => 'Design department template', 'maxLength' => 256, 'minLength' => 2],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
'title' => '产品类型',
'description' => '产品类型。固定填写`CloudDesktop`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['CloudDesktop' => '云电脑'],
'example' => 'CloudDesktop',
],
],
[
'name' => 'BizType',
'in' => 'formData',
'schema' => [
'title' => '业务类型',
'description' => '> 该参数暂不对外开放使用。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [1 => '企业版'],
'example' => '1',
],
],
[
'name' => 'SystemDiskSize',
'in' => 'formData',
'schema' => ['title' => '系统盘配置', 'description' => '系统盘大小。单位:GiB。取值范围: 40~500,每10GiB为一个步长。'."\n"
."\n"
.'> 系统盘大小不能小于配置的镜像大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2040', 'minimum' => '40', 'example' => '80'],
],
[
'name' => 'SystemDiskPerformanceLevel',
'in' => 'formData',
'schema' => [
'description' => '系统盘类型。'."\n"
."\n"
.'> 只有高主频和图形型的云电脑规格支持ESSD类型的磁盘。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'ESSD极速云盘PL1等级', 'PL0' => 'ESSD极速云盘PL0等级', 'AutoPL' => 'SSD极速云盘 [默认值]'],
'example' => 'AutoPL',
],
],
[
'name' => 'DataDiskList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '数据盘大小和规格配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Size' => ['description' => '系统盘大小。单位:GiB。取值范围: 40~2040,每10GiB为一个步长。'."\n"
."\n"
.'>ESSD云盘容量越大,可供选择的“性能级别”越高 (例如460GiB以上可选PL2)。性能级别越高,费用也越高,请根据您的使用需求合理选择ESSD云盘性能级别。>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2040', 'minimum' => '20', 'example' => '40'],
'PerformanceLevel' => [
'description' => '数据盘性能等级,默认为`AutoPL`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'AutoPL',
],
],
'required' => false,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'ImageId',
'in' => 'formData',
'schema' => ['title' => '镜像id', 'description' => '云电脑镜像ID,可以从镜像管理页面查询, 支持系统镜像、自定义镜像等类型。', 'type' => 'string', 'required' => false, 'example' => 'desktopimage-windows-server-2022-64-asp'],
],
[
'name' => 'DefaultLanguage',
'in' => 'formData',
'schema' => ['title' => '默认语言', 'description' => '云电脑启动时设置的默认语言,仅在使用系统镜像创建云电脑的场景下生效。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'PolicyGroupId',
'in' => 'formData',
'schema' => ['title' => '策略ID', 'description' => '全局类型的策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-8hlryfn331******'],
],
[
'name' => 'TimerGroupId',
'in' => 'formData',
'schema' => ['title' => '中心定时任务组ID', 'description' => '配置组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0caoeogrk9m5****'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4knxmfneq1e******'],
],
[
'name' => 'ResourceTagList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '云电脑标签。Key-Value格式。最多可传入20个标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'design'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'RegionConfigList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '地域化的模板信息配置, 支持配置多个。 使用时会根据具体的地域匹配。'."\n"
."\n"
.'> 最多支持20个地域的配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'SnapshotPolicyId' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-35fvn8m21pnx2****'],
'ResourceInstanceType' => ['description' => '云电脑规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g'],
'VolumeEncryptionEnable' => [
'description' => '是否开启磁盘加密功能。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['false' => '不开启 [默认值]', 'true' => '开启'],
'example' => 'false',
],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'a7b3c0c8-b3a2-4876-b1cc-*********'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-709******'],
'SubnetId' => ['description' => '子网ID。', '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,
'description' => '',
],
'required' => false,
],
],
[
'name' => 'ChargeType',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['PostPaid', 'PrePaid'],
'description' => '',
],
],
[
'name' => 'Period',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '6', 'minimum' => '1', 'description' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['Month', 'Year', 'Week'],
'description' => '',
],
],
[
'name' => 'AutoPay',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'UserDuration',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enum' => ['120', '250', '360'],
'description' => '',
],
],
[
'name' => 'PostPaidAfterUsedUp',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult',
'description' => 'PlainResult',
'type' => 'object',
'properties' => [
'Data' => ['description' => '创建成功之后的模板ID。', 'type' => 'string', 'example' => 'b-0cc7rx533*****'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'True'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '创建结果。', 'type' => 'string', 'example' => 'success'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', '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' => '创建自定义云电脑模板',
'description' => '调用该接口时,您需要注意:'."\n"
."\n"
.'- 实例启动模板的参数大多数为可选参数。创建模板时,阿里云不会严格验证模板中参数取值的存在性和有效性。只会在真正创建实例时校验参数取值的有效性。'."\n"
."\n"
.'- 对于模板中具有地域属性的参数,若使用该模板创建云电脑时地域不匹配,则这些参数不会生效。',
'changeSet' => [
['createdAt' => '2025-12-25T06:33:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteAutoSnapshotPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待删除的自动快照策略ID列表。',
'type' => 'array',
'items' => ['description' => '待删除的自动快照策略ID。可以设置1\\~100个。', 'type' => 'string', 'required' => false, 'example' => 'sp-424g04y887d9e****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
],
'description' => '',
],
],
],
'title' => '删除自动快照策略',
'summary' => '删除自动快照策略。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]',
],
'DeleteBundles' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'BundleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑模板ID列表。可设置1\\~100个。',
'type' => 'array',
'items' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => false, 'example' => 'b-cezrnfgecbich****'],
'required' => true,
'example' => 'b-cezrnfgecbich****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除一个或多个自定义云电脑模板',
'summary' => '删除一个或多个自定义云电脑模板。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBundles'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n A5CDCED9-54D4-457C-917D-3F2A783CDA1E\\r\\n","errorExample":""}]',
],
'DeleteCdsFile' => [
'summary' => '删除网盘中的文件或文件夹。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-066224****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5CC5E450-FC43-4F5B-B540-9964BD31****'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Data' => [
'description' => '数据是否成功返回。',
'type' => 'string',
'enumValueTitles' => ['true' => '返回成功', 'false' => '返回失败'],
'example' => 'true',
],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
],
'description' => '',
],
],
],
'title' => '删除网盘文件',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCdsFile'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DeleteCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD31****\\",\\n \\"Code\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"true\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
],
'DeleteCenterPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop'."\n",
],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => false,
'enumValueTitles' => [1 => '公共云', 8 => '商业版'],
'example' => '1',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '策略组ID列表。',
'type' => 'array',
'items' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
'required' => true,
'docRequired' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****'],
],
'description' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '删除无地域策略',
'summary' => '删除一条无地域策略。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DeleteCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\"\\n}","type":"json"}]',
],
'DeleteCloudDriveGroups' => [
'summary' => '删除团队共享盘。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '团队空间ID列表。',
'type' => 'array',
'items' => ['description' => '团队空间ID。若设置多个,则表示批量删除。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
'required' => false,
'docRequired' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Data' => ['description' => '数据信息。', 'type' => 'string', 'example' => '[]'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
],
'description' => '',
],
],
],
'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' => '删除团队共享盘',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveGroups'],
],
],
'ramActions' => [],
],
'DeleteCloudDriveUsers' => [
'summary' => '删除企业网盘内的用户个人盘。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-64326*****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EAEFFE4B-E87B-5F76-B165-9248F377****'],
],
'description' => '',
],
],
],
'title' => '删除用户个人盘',
'changeSet' => [
['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveUsers'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAEFFE4B-E87B-5F76-B165-9248F377****\\"\\n}","type":"json"}]',
],
'DeleteConfigGroup' => [
'summary' => '删除配置组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要删除的配置组ID列表。',
'type' => 'array',
'items' => ['description' => '配置组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0cpaegmjioo7*****'],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除配置组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DeleteConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]',
],
'DeleteDesktopGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '释放共享型云电脑',
'summary' => '释放共享型云电脑。',
'description' => '- 调用本接口之前请确保共享型云电脑内没有已连接的云电脑,且没有已授权用户。'."\n"
.'- 对于包年包月共享型云电脑,如果池内的包年包月云电脑还未到期,则不允许删除共享型云电脑。'."\n"
.'- 对于按量付费共享型云电脑,删除共享型云电脑的同时将释放共享型云电脑内的按量付费云电脑。',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-07T09:08:49.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktopGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n","errorExample":""}]',
],
'DeleteDesktops' => [
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '释放云电脑',
'summary' => '释放一台或多台按量付费云电脑或到期的包年包月云电脑。',
'changeSet' => [
['createdAt' => '2025-09-28T09:09:08.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:54.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktops'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DeleteDevices' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DeviceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备ID列表。可配置1\\~200个。',
'type' => 'array',
'items' => [
'description' => '无影硬件终端的SN,或者无影软件客户端的UUID。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '5F52817BE267A43C608D245070D2****',
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '设备类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [1 => '无影硬件终端', '无影软件客户端'],
'example' => '1',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'description' => '当设备已有绑定的终端用户时,是否强制删除该设备。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => ['不强制删除', '强制删除'],
'example' => '0',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2AF861B4-0ECC-130C-B100-21A01E02****'],
],
],
],
],
'title' => '删除可信设备',
'summary' => '删除可信设备。',
'requestParamsDescription' => 'clientType和设备列表是必传参数',
'responseParamsDescription' => '没有特别参数',
'extraInfo' => '暂无',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevices'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2AF861B4-0ECC-130C-B100-21A01E02****\\"\\n}","type":"json"}]',
],
'DeleteDirectories' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目录ID。可设置一个或多个。',
'type' => 'array',
'items' => ['description' => '目录ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'],
'required' => true,
'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5CC5E450-FC43-4F5B-B540-9964BD313427'],
],
],
],
],
'title' => '删除目录',
'summary' => '删除一个或多个目录。',
'description' => '已存在云电脑的目录或已被云电脑使用的目录不允许删除。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDirectories'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5CC5E450-FC43-4F5B-B540-9964BD313427\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]',
],
'DeleteDrive' => [
'summary' => '删除网盘。',
'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' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DriveId',
'in' => 'query',
'schema' => ['description' => '用户级别的存储资源ID。', 'type' => 'string', 'required' => false, 'example' => 'dri-aaaa****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B7AA****'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应代码,200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'successful'],
'Data' => ['description' => '删除结果。', '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' => '删除用户级别存储资源',
'changeSet' => [
['createdAt' => '2022-08-31T07:11:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDrive'],
],
],
'ramActions' => [],
],
'DeleteImages' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID数组。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****'],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'DeleteCascadedBundle',
'in' => 'query',
'schema' => ['description' => '是否同时删除关联的模板。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除一个或多个自定义镜像',
'summary' => '删除一个或多个自定义镜像。',
'description' => '- 镜像分为系统镜像和自定义镜像,其中系统镜像不支持删除。'."\n"
.'- 如果镜像已被云电脑模板引用,请先调用[DeleteBundles](~~436972~~)删除对应的云电脑模板。',
'changeSet' => [
['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteImages'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteImages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DeleteNASFileSystems' => [
'summary' => '删除一个或者多个NAS文件系统。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'NAS文件系统ID数组。',
'type' => 'array',
'items' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'required' => false, 'example' => '04f314****'],
'required' => true,
'example' => '04f314****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除NAS文件系统',
'description' => '删除NAS文件系统前,请确保已经备份需要保存的数据。'."\n"
."\n\n"
.'> 删除NAS文件系统后,NAS文件系统中存储的数据无法恢复,请谨慎操作。>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNASFileSystems'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteNASFileSystems',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DeleteNetworkPackages' => [
'summary' => '删除一个或者多个公网精品带宽。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '公网精品带宽ID列表。可设置一个或者多个。',
'type' => 'array',
'items' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => false, 'example' => 'np-amtp8e8q1o9e4****'],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除公网精品带宽',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPackages'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DeleteOfficeSiteAccelerator' => [
'summary' => '删除全球加速配置',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-885351****'],
],
],
'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' => 'EE9472BC-0B5D-5458-85CD-C52BDD******'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除全球加速',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE9472BC-0B5D-5458-85CD-C52BDD******\\"\\n}","type":"json"}]',
],
'DeleteOfficeSites' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '办公网络ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
'required' => true,
'example' => 'cn-hangzhou+dir-363353****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除办公网络',
'summary' => '将办公网络(原工作区)内的云电脑资源完全释放后可以将办公网络删除。',
'description' => '删除办公网络前,请确保已完成以下操作:'."\n"
."\n"
.'- 已释放办公网络内的所有云电脑。'."\n"
.'- 已备份需要保存的相关数据。'."\n"
."\n"
.'>删除后相关资源和数据无法恢复,请谨慎操作。>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:53.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteOfficeSites'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteOfficeSites',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DeletePolicyGroups' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑策略ID。可设置1\\~100个。',
'type' => 'array',
'items' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
'required' => true,
'example' => 'pg-gx2x1dhsmthe9****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除一个或多个自定义云电脑策略',
'summary' => '删除一个或多个自定义云电脑策略。',
'description' => '- 系统云电脑策略不允许删除。'."\n"
.'- 已关联云电脑的自定义云电脑策略不允许删除。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyGroups'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeletePolicyGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 8BBD24F5-DECA-48D8-B08C-15619790F07B\\r\\n","errorExample":""}]',
],
'DeleteQosRules' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'QosRuleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '限速规则ID列表。',
'type' => 'array',
'items' => ['description' => '限速规则ID。', 'type' => 'string', 'required' => false, 'example' => 'qos-5605u0gelk200****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E54EB497-D7B7-5F04-B744-D8DFA7B******'],
],
'description' => '',
],
],
],
'title' => '删除限速规则。',
'summary' => '删除限速规则。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteQosRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\"\\n}","type":"json"}]',
],
'DeleteSnapshot' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '快照ID数组。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '快照ID。如果指定的快照ID不存在,请求将被忽略。', 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****'],
'required' => true,
'example' => 's-2ze81owrnv9pity4****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除一份或多份快照',
'summary' => '用于删除一份或多份快照。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]',
],
'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' => '需要删除的模板ID列表。',
'type' => 'array',
'items' => ['description' => '需要删除的模板ID。', 'type' => 'string', 'required' => false, 'example' => 'b-7ywwjrr50t1a*****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'BizType',
'in' => 'formData',
'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => '返回结果集合。',
'type' => 'object',
'properties' => [
'Success' => [
'description' => '是否调用成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '调用成功', 'false' => '调用失败'],
'example' => 'true',
],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'HttpStatusCode' => ['description' => '错误码描述。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'],
'AccessDeniedDetail' => ['description' => '关于访问被拒绝的详细信息。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '删除自定义云电脑模板',
'summary' => '删除自定义云电脑模板。',
'description' => '模板删除之后, 已基于该模板创建的云电脑不受影响,与该模板关联的资源不受影响。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]',
],
'DeleteVirtualMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => ['description' => '虚拟MFA设备的序列号,也是其唯一标识。您可以调用[DescribeVirtualMFADevices](~~DescribeVirtualMFADevices~~)查询AD账号绑定的虚拟MFA设备序列号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '删除AD账号绑定的虚拟MFA设备',
'summary' => '删除AD账号绑定的虚拟MFA设备。',
'description' => '删除MFA设备表示解除MFA设备绑定,等同于重置、禁用该MFA设备。对应AD用户在登录云桌面时,需要重新绑定新的MFA设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteVirtualMFADevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\r\\n","errorExample":""}]',
],
'DescribeAclEntries' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页的最大条目数。'."\n"
."\n"
.'- 最大值:1600。'."\n"
.'- 默认值:1600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '50'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6kRxd1mKkNnHlUy14zdjl/I'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-631324****'],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '公网访问控制策略对应的粒度。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['desktop' => '云电脑粒度', 'vpc' => '办公网络粒度'],
'example' => 'desktop',
],
],
[
'name' => 'SourceId',
'in' => 'query',
'schema' => ['description' => '公网访问控制对应的实例ID,即办公网络ID或云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-22poqua477xo4****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'AclEntries' => [
'description' => '公网访问控制策略条目列表。',
'type' => 'array',
'items' => [
'description' => '公网访问控制策略条目。',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '公网访问控制策略。',
'type' => 'string',
'enumValueTitles' => ['allow' => '允许访问公网', 'deny' => '禁止访问公网'],
'example' => 'allow',
],
'SourceType' => [
'description' => '公网访问控制策略对应的粒度。',
'type' => 'string',
'enumValueTitles' => ['desktop' => '云电脑粒度', 'vpc' => '办公网络粒度'],
'example' => 'desktop',
],
'SourceId' => ['description' => '公网访问控制对应的实例ID,即办公网络ID或云电脑ID。', 'type' => 'string', 'example' => 'ecd-22poqua477xo4****'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询公网访问控制策略详情',
'summary' => '查询办公网络或云电脑粒度上的公网访问控制策略详情。',
'changeSet' => [
['createdAt' => '2025-01-20T07:27:54.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAclEntries'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeAclEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"AclEntries\\": [\\n {\\n \\"Policy\\": \\"allow\\",\\n \\"SourceType\\": \\"desktop\\",\\n \\"SourceId\\": \\"ecd-22poqua477xo4****\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeAutoSnapshotPolicy' => [
'summary' => '查询自动快照策略。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-c5tv9d64ebjnj****'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => '自动快照策略的名称。', 'type' => 'string', 'required' => false, 'example' => 'Test 1201'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。'."\n"
."\n"
.'- 最大值:50'."\n"
.'- 默认值:50', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mqIGdPhID94rjhZFGsvpJo'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7F6612E-59CC-59F9-9DD1-91867FCC****'],
'AutoSnapshotPolicies' => [
'description' => '自动快照策略列表。',
'type' => 'array',
'items' => [
'description' => '自动快照策略。',
'type' => 'object',
'properties' => [
'TimePoints' => ['description' => '自动快照的创建时间点。'."\n"
."\n"
.'传递参数为JSON数组格式:`["0", "1", ... "23"]`,最多24个时间点,用半角逗号(,)隔开。', 'type' => 'string', 'example' => '["17","18"]'],
'CreationTime' => ['description' => '创建时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'example' => '2023-01-11T09:14:00Z'],
'Status' => [
'description' => '自动快照策略的状态。',
'type' => 'string',
'enumValueTitles' => ['Expire' => '由于账号欠费无法使用该策略', 'Normal' => '正常'],
'example' => 'Normal',
],
'DesktopNum' => ['description' => '绑定该快照策略的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CronExpression' => ['description' => '用于规定快照创建时间的Cron表达式。', 'type' => 'string', 'example' => '0 0 5,7 ? * 2/2'],
'RetentionDays' => ['description' => '自动快照的保留时间,单位为天。取值范围:1\\~180。', 'type' => 'string', 'example' => '2'],
'PolicyName' => ['description' => '自动快照策略名称。', 'type' => 'string', 'example' => 'snapshot01'],
'PolicyId' => ['description' => '自动快照策略ID。', 'type' => 'string', 'example' => 'sp-3e3bmfcdkjfl1****'],
'RegionId' => ['description' => '自动快照策略所属地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'DiskType' => ['type' => 'string', 'description' => ''],
],
],
],
],
'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' => '查询自动快照策略',
'changeSet' => [
['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-22T02:11:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-17T09:21:02.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoSnapshotPolicy'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeBundles' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'BundleType',
'in' => 'query',
'schema' => [
'description' => '云电脑模板类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '系统模板', 'CUSTOM' => '自定义模板'],
'example' => 'SYSTEM',
],
],
[
'name' => 'DesktopTypeFamily',
'in' => 'query',
'schema' => [
'description' => '云电脑规格族。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['eds.graphics' => '图形型', 'eds.hf' => '高主频型', 'eds.general' => '通用型'],
'example' => 'eds.general',
],
],
[
'name' => 'CpuCount',
'in' => 'query',
'schema' => ['description' => '云电脑规格包含的vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'MemorySize',
'in' => 'query',
'schema' => ['description' => '云电脑规格包含的内存大小。单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'],
],
[
'name' => 'GpuCount',
'in' => 'query',
'schema' => ['description' => '云电脑规格包含的GPU个数。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1'],
],
[
'name' => 'CheckStock',
'in' => 'query',
'schema' => ['description' => '是否查询云电脑规格的库存状态。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
[
'name' => 'FromDesktopGroup',
'in' => 'query',
'schema' => [
'description' => '是否属于云电脑池。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '属于云电脑池', 'false' => '不属于云电脑池 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议 [推荐]'],
'example' => 'ASP',
],
],
[
'name' => 'BundleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑模板ID列表。可设置1\\~100个。',
'type' => 'array',
'items' => ['description' => '云电脑模板ID。', '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' => '查询云电脑列表时是否返回多会话的云电脑模板。默认不返回。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'VolumeEncryptionEnabled',
'in' => 'query',
'schema' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FotaChannel',
'in' => 'query',
'schema' => ['description' => '> 此参数暂未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'example'],
],
[
'name' => 'SelectedBundle',
'in' => 'query',
'schema' => ['description' => '精选模板。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SessionType',
'in' => 'query',
'schema' => [
'description' => '会话类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SingleSession' => '单会话', 'MultipleSession' => '多会话'],
'example' => 'SingleSession',
],
],
[
'name' => 'ImageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID列表。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-7by8d2m4kiicz****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'OsType',
'in' => 'query',
'schema' => [
'description' => '操作系统类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => ['description' => '使用场景。', 'type' => 'string', 'required' => false, 'example' => 'FastBuy'],
],
[
'name' => 'GpuDriverType',
'in' => 'query',
'schema' => [
'description' => 'GPU驱动类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['T4' => 'T4', 'A10' => 'A10', 'G28' => 'G28', 'G39' => 'G39'],
'example' => 'T4',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BCC854D8-5D1E-46D3-96EF-797A5DD36789'],
'Bundles' => [
'description' => '云电脑模板的详细信息列表。',
'type' => 'array',
'items' => [
'description' => '云电脑模板的详细信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '云电脑模板描述。', 'type' => 'string', 'example' => 'test'],
'BundleType' => [
'description' => '云电脑模板类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统模板', 'CUSTOM' => '自定义模板'],
'example' => 'SYSTEM',
],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'StockState' => ['description' => '库存状态。当`CheckStock`设置为`True`时返回。', 'type' => 'string', 'example' => 'Sufficient'],
'DesktopType' => ['description' => '云电脑规格。', 'type' => 'string', 'example' => 'ecd.graphics.2xlarge'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'BundleId' => ['description' => '云电脑模板ID。', 'type' => 'string', 'example' => 'bundle_ecd_graphics.2xlarge_s15d15_win2019'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'desktopimage-windows-server-2019-64-ch-vgpu'],
'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'Windows server 2019 Chinese'],
'Language' => [
'description' => '镜像操作系统语言。',
'type' => 'string',
'enumValueTitles' => ['en-US' => '英文', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日文'],
'example' => 'en-US',
],
'BundleName' => ['description' => '云电脑模板名称。', 'type' => 'string', 'example' => 'Advanced graphics with Windows 2019'],
'Disks' => [
'description' => '磁盘信息。',
'type' => 'array',
'items' => [
'description' => '磁盘信息。',
'type' => 'object',
'properties' => [
'DiskType' => [
'description' => '磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'],
'example' => 'SYSTEM',
],
'DiskSize' => ['description' => '磁盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '150'],
'DiskPerformanceLevel' => [
'description' => '磁盘性能等级。',
'type' => 'string',
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL0',
],
],
],
],
'DesktopTypeAttribute' => [
'description' => '云电脑规格详情。',
'type' => 'object',
'properties' => [
'CpuCount' => ['description' => 'vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'GpuCount' => ['description' => 'GPU个数。', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
'GpuSpec' => ['description' => 'GPU类型。', 'type' => 'string', 'example' => 'NVIDIA T4'],
'MemorySize' => ['description' => '内存大小。单位:MiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '4096'],
],
],
'DesktopTypeFamily' => [
'description' => '云电脑规格族。',
'type' => 'string',
'enumValueTitles' => ['eds.graphics' => '图形型', 'eds.hf' => '高主频型', 'eds.general' => '通用型'],
'example' => 'eds.general',
],
'CreationTime' => ['description' => '云电脑模板的创建时间。', 'type' => 'string', 'example' => '2021-09-30T06:09Z'],
'SessionType' => [
'description' => '会话类型。',
'type' => 'string',
'enumValueTitles' => ['单会话', '多会话'],
'example' => '0',
],
'VolumeEncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
'Platform' => [
'description' => '操作系统平台信息。',
'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' => '镜像状态。', 'type' => 'string', 'example' => 'Available'],
'SystemDiskCategory' => [
'description' => '系统盘类型。',
'type' => 'string',
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_auto' => '极速云盘', 'cloud_essd' => '增强型SSD云盘,仅部分规格支持'],
'example' => 'cloud_efficiency',
],
'DataDiskCategory' => [
'description' => '数据盘类型。',
'type' => 'string',
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_auto' => '极速云盘', 'cloud_essd' => '增强型SSD云盘,仅部分规格支持'],
'example' => 'cloud_efficiency',
],
],
],
],
],
],
],
],
'title' => '查询云电脑模板的详细信息',
'summary' => '查询云电脑模板的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-01-15T03:18:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-19T04:01:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-06-10T09:38:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-04-27T14:07:37.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-01-05T11:05:30.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-13T02:35:19.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-13T02:35:19.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBundles'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeBundles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8\\",\\n \\"RequestId\\": \\"BCC854D8-5D1E-46D3-96EF-797A5DD36789\\",\\n \\"Bundles\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"BundleType\\": \\"SYSTEM\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"StockState\\": \\"Sufficient\\",\\n \\"DesktopType\\": \\"ecd.graphics.2xlarge\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"BundleId\\": \\"bundle_ecd_graphics.2xlarge_s15d15_win2019\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-vgpu\\",\\n \\"ImageName\\": \\"Windows server 2019 Chinese\\",\\n \\"Language\\": \\"en-US\\",\\n \\"BundleName\\": \\"Advanced graphics with Windows 2019\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskSize\\": 150,\\n \\"DiskPerformanceLevel\\": \\"PL0\\"\\n }\\n ],\\n \\"DesktopTypeAttribute\\": {\\n \\"CpuCount\\": 10,\\n \\"GpuCount\\": 0.5,\\n \\"GpuSpec\\": \\"NVIDIA T4\\",\\n \\"MemorySize\\": 4096\\n },\\n \\"DesktopTypeFamily\\": \\"eds.general\\",\\n \\"CreationTime\\": \\"2021-09-30T06:09Z\\",\\n \\"SessionType\\": \\"0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"Platform\\": \\"Windows Server 2019\\",\\n \\"ImageStatus\\": \\"Available\\",\\n \\"SystemDiskCategory\\": \\"cloud_efficiency\\",\\n \\"DataDiskCategory\\": \\"cloud_efficiency\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6lu3PTF6h3zE8egwlYuv8M8\\n BCC854D8-5D1E-46D3-96EF-797A5DD36789\\n \\n test\\n SYSTEM\\n Windows\\n Sufficient\\n ecd.graphics.2xlarge\\n HDX\\n bundle_ecd_graphics.2xlarge_s15d15_win2019\\n desktopimage-windows-server-2019-64-ch-vgpu\\n Windows server 2019 Chinese\\n en-US\\n Advanced graphics with Windows 2019\\n \\n SYSTEM\\n 150\\n PL0\\n \\n \\n 10\\n 0.5\\n NVIDIA T4\\n 47104\\n \\n eds.general\\n 2021-09-30T06:09Z\\n \\n","errorExample":""}]',
],
'DescribeCdsFileShareLinks' => [
'summary' => '查询文件分享。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-532033****'],
],
[
'name' => 'ShareId',
'in' => 'query',
'schema' => ['description' => '分享ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7JQX1Fs****'."\n"],
],
[
'name' => 'Creators',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '分享的创建者列表。',
'type' => 'array',
'items' => ['description' => '分享的创建者。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'docRequired' => false,
'maxItems' => 20,
'minItems' => 0,
],
],
[
'name' => 'ShareName',
'in' => 'query',
'schema' => ['description' => '分享名称,支持模糊匹配。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'user'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '分享状态。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['disabled' => '已取消', 'enabled' => '有效'],
'example' => 'enabled',
'enum' => ['enabled', 'disabled'],
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '限定此次返回资源的数量,取值范围为1\\~100。如果没有填写,则默认取值100。'."\n"
.'返回结果可以小于指定的数量,但不能多于指定的数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => [
'description' => '数据信息。',
'type' => 'array',
'items' => ['description' => '分享链接实体。', '$ref' => '#/components/schemas/CdsFileShareLinkModel'],
],
'NextToken' => ['description' => '下一个查询开始的Token,`NextToken`为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"文件分享链接。\\",\\n \\"SaveLimit\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]',
'title' => '查询文件分享',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCdsFileShareLinks'],
],
],
'ramActions' => [],
],
'DescribeCens' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。 '."\n"
.'默认值:50。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。 '."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalCount' => ['description' => '查询到的云企业网实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Cens' => [
'description' => '云企业网实例的详细信息。',
'type' => 'array',
'items' => [
'description' => '云企业网实例对象。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '云企业网实例的状态。',
'type' => 'string',
'enumValueTitles' => ['Creating' => '创建中', 'Active' => '运行中', 'Deleting' => '删除中'],
'example' => 'Active',
],
'CreationTime' => ['description' => '云企业网实例的创建时间。', 'type' => 'string', 'example' => '2021-06-16T08:46Z'],
'Ipv6Level' => [
'description' => 'IPv6等级。'."\n"
."\n"
.'> 目前均不支持IPv6。',
'type' => 'string',
'enumValueTitles' => ['DISABLED' => '不支持IPv6'],
'example' => 'DISABLED',
],
'Description' => ['description' => '云企业网实例的描述信息。', 'type' => 'string', 'example' => 'test'],
'CenId' => ['description' => '云企业网实例ID。', 'type' => 'string', 'example' => 'cen-3gwy16dojz1m65****'],
'ProtectionLevel' => [
'description' => '网段重叠冲突的级别。',
'type' => 'string',
'enumValueTitles' => ['REDUCED' => '表示可以有网段重叠,但是不能完全相等。'],
'example' => 'REDUCED',
],
'Name' => ['description' => '云企业网实例名称。', 'type' => 'string', 'example' => 'testCen'],
'Tags' => [
'description' => '云企业网实例的标签列表。',
'type' => 'array',
'items' => [
'description' => '云企业网实例的标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'testKey'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'testValue'],
],
],
],
'PackageIds' => [
'description' => '云企业网实例绑定的带宽包列表。',
'type' => 'array',
'items' => [
'description' => '云企业网实例绑定的带宽包对象。',
'type' => 'object',
'properties' => [
'PackageId' => ['description' => '云企业网实例绑定的带宽包ID。', 'type' => 'string', 'example' => 'cenbwp-4c2zaavbvh5f42****'],
],
],
],
],
],
],
],
],
],
],
'title' => '查询云企业网实例信息',
'summary' => '查询账号下所有云企业网实例信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:52.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCens'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 50,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Cens\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"CreationTime\\": \\"2021-06-16T08:46Z\\",\\n \\"Ipv6Level\\": \\"DISABLED\\",\\n \\"Description\\": \\"test\\",\\n \\"CenId\\": \\"cen-3gwy16dojz1m65****\\",\\n \\"ProtectionLevel\\": \\"REDUCED\\",\\n \\"Name\\": \\"testCen\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ],\\n \\"PackageIds\\": [\\n {\\n \\"PackageId\\": \\"cenbwp-4c2zaavbvh5f42****\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 50\\n 2BFA6822-240E-4E27-B4C8-AA400EF7474D\\n 1\\n \\n Active\\n REDUCED\\n test\\n DISABLED\\n 2021-06-16T08:46Z\\n cen-3gwy16dojz1m65****\\n testCen\\n \\n testValue\\n testKey\\n \\n \\n cenbwp-4c2zaavbvh5f42****\\n \\n \\n","errorExample":""}]',
],
'DescribeCenterPolicyList' => [
'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' => '分页查询时,当前页的页码。 '."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑策略ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '云电脑策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IP' => '指定IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'enumValueTitles' => [1 => '公共云', 8 => '商业版'],
'example' => '1',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'PortProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ModelLibrary',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AcademicProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'DescribePolicyGroups' => [
'description' => '云电脑策略的详细信息。',
'type' => 'array',
'items' => [
'description' => '云电脑策略的详细信息。',
'type' => 'object',
'properties' => [
'PolicyStatus' => ['description' => '云电脑策略状态。', 'type' => 'string', 'example' => 'AVAILABLE'],
'Html5Access' => ['description' => 'Web客户端访问策略。', 'type' => 'string', 'example' => 'off'],
'WatermarkType' => ['description' => '水印类型。', 'type' => 'string', 'example' => 'EndUserId'],
'WatermarkCustomText' => ['description' => '若参数`WatermarkType`传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。', 'type' => 'string', 'example' => 'custom-watermark'],
'Clipboard' => ['description' => '剪贴板权限。', 'type' => 'string', 'example' => 'off'],
'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****'],
'PrinterRedirection' => ['description' => '打印机重定向策略。', 'type' => 'string', 'example' => 'off'],
'Html5FileTransfer' => ['description' => 'Web客户端文件传输策略。', 'type' => 'string', 'example' => 'off'],
'UsbRedirect' => ['description' => 'USB重定向。', 'type' => 'string', 'example' => 'off'],
'PolicyGroupType' => ['description' => '策略类型。', 'type' => 'string', 'example' => 'SYSTEM'],
'Watermark' => ['description' => '水印。', 'type' => 'string', 'example' => 'on'],
'VisualQuality' => ['description' => '图像显示质量策略。', 'type' => 'string', 'example' => 'medium'],
'Name' => ['description' => '策略名称。', 'type' => 'string', 'example' => 'testPolicyGroupName'],
'LocalDrive' => ['description' => '本地磁盘映射权限。', 'type' => 'string', 'example' => 'readwrite'],
'AuthorizeSecurityPolicyRules' => [
'description' => '安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则列表。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '安全组管控规则的规则方向。', 'type' => 'string', 'example' => 'inflow'],
'Policy' => ['description' => '安全组管控规则的授权策略。', 'type' => 'string', 'example' => 'accept'],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'example' => 'test'],
'PortRange' => ['description' => '安全组管控规则的端口范围。', 'type' => 'string', 'example' => '22/22'],
'IpProtocol' => ['description' => '安全组管控规则的协议类型。', 'type' => 'string', 'example' => 'tcp'],
'Priority' => ['description' => '安全组管控规则的优先级,数字越小,代表优先级越高。', 'type' => 'string', 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'example' => '47.100.XX.XX/16'],
],
],
],
'AuthorizeAccessPolicyRules' => [
'description' => '客户端访问IP白名单。',
'type' => 'array',
'items' => [
'description' => '客户端访问IP白名单。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端访问IP地址段备注信息。', 'type' => 'string', 'example' => 'test'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'example' => '47.100.XX.XX/16'],
],
],
],
'ClientTypes' => [
'description' => '登录方式管控规则。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '是否允许某一类型的客户端登录云桌面。', 'type' => 'string', 'example' => 'on'],
'ClientType' => ['description' => '客户端类型。', 'type' => 'string', 'example' => 'windows'],
],
],
],
'GpuAcceleration' => ['description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。', 'type' => 'string', 'example' => 'off'],
'UsbSupplyRedirectRule' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'example' => '04**'],
'ProductId' => ['description' => '产品ID。', 'type' => 'string', 'example' => '08**'],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => 'Test rule'],
'UsbRedirectType' => ['description' => 'USB重定向类型。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'UsbRuleType' => ['description' => 'USB重定向规则类型。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
'DomainResolveRuleType' => ['description' => '域名解析策略开关。', 'type' => 'string', 'example' => 'on'],
'DomainResolveRule' => [
'description' => '域名解析策略详情。',
'type' => 'array',
'items' => [
'description' => '域名解析策略详情。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'example' => '*.example.com'],
'Policy' => ['description' => '解析策略。', 'type' => 'string', 'example' => 'allow'],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'example' => '测试规则'],
],
],
],
'NetRedirectRule' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'array',
'items' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'example' => '*.example.com'],
'RuleType' => ['description' => '规则类型', 'type' => 'string', 'example' => 'domain'],
'Policy' => ['description' => '重定向策略。', 'type' => 'string', 'example' => 'allow'],
],
],
],
'Recording' => ['description' => '是否开启录屏。', 'type' => 'string', 'example' => 'off'],
'RecordingStartTime' => ['description' => '录屏开始时间,取值:HH:MM:SS。只有Recording取值是period时,该返回值有实际意义。', 'type' => 'string', 'example' => '08:00:00'],
'RecordingEndTime' => ['description' => '录屏结束时间,取值:HH:MM:SS。只有Recording取值是period时,该返回值有实际意义。', 'type' => 'string', 'example' => '08:59:00'],
'RecordingFps' => ['description' => '录屏帧率。单位:FPS(帧/秒)。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'RecordingExpires' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'CameraRedirect' => ['description' => '是否开启本地摄像头重定向。', 'type' => 'string', 'example' => 'on'],
'NetRedirect' => ['description' => '网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。', 'type' => 'string', 'example' => 'off'],
'AppContentProtection' => ['description' => '是否开启防截屏功能。', 'type' => 'string', 'example' => 'off'],
'RecordContent' => ['description' => '是否开启自定义录屏。', 'type' => 'string', 'example' => 'off'],
'RecordContentExpires' => ['description' => '自定义录屏的文件过期时间,默认30天。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'RemoteCoordinate' => ['description' => '远程协助键鼠控制权限。', 'type' => 'string', 'example' => 'fullControl'],
'RecordingDuration' => ['description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Scope' => ['description' => '策略的生效范围。', 'type' => 'string', 'example' => 'GLOBAL'],
'ScopeValue' => [
'description' => '生效的CIDR Block。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block。', 'type' => 'string', 'example' => '47.100.XX.XX/24'],
],
'RecordingAudio' => ['description' => '录制云电脑声音选项。', 'type' => 'string', 'example' => 'on'],
'InternetCommunicationProtocol' => ['description' => '网络通信协议。', 'type' => 'string', 'example' => 'tcp'],
'VideoRedirect' => ['description' => '多媒体重定向。', 'type' => 'string', 'example' => 'off'],
'WatermarkTransparencyValue' => ['description' => '水印透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'WatermarkColor' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WatermarkFontSize' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'WatermarkFontStyle' => ['description' => '水印字体样式。', 'type' => 'string', 'example' => 'plain'],
'WatermarkDegree' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'example' => '-10'],
'WatermarkRowAmount' => ['description' => '水印行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'EndUserApplyAdminCoordinate' => ['description' => '用户请求管理员协助。', 'type' => 'string', 'example' => 'off'],
'EndUserGroupCoordinate' => ['description' => '同一个办公网络下用户共享云电脑。', 'type' => 'string', 'example' => 'off'],
'CpuProtectedMode' => ['description' => 'CPU保护模式开关。', 'type' => 'string', 'example' => 'on'],
'CpuRateLimit' => ['description' => 'CPU整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'CpuSampleDuration' => ['description' => 'CPU整体采样时长,取值范围: 10\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CpuSingleRateLimit' => ['description' => 'CPU单核使用率百分比,取值范围: 70\\~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'CpuDownGradeDuration' => ['description' => 'CPU降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'CpuProcessors' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'example' => 'chrome.exe'],
],
'MemoryProtectedMode' => ['description' => '内存保护模式开关。', 'type' => 'string', 'example' => 'off'],
'MemoryRateLimit' => ['description' => '内存整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MemorySampleDuration' => ['description' => '内存整体采样时长,取值范围: 30\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemorySingleRateLimit' => ['description' => '单个进程内存使用率百分比,取值范围: 30\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemoryDownGradeDuration' => ['description' => '单个进程内存降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemoryProcessors' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'example' => 'notepad.exe'],
],
'WatermarkSecurity' => ['description' => '盲水印安全优先规则。', 'type' => 'string', 'example' => 'on'],
'WatermarkAntiCam' => ['description' => '盲水印防拍照功能。', 'type' => 'string', 'example' => 'off'],
'WatermarkPower' => ['description' => '盲水印增强功能。', 'type' => 'string', 'example' => 'medium'],
'RecordingUserNotify' => ['description' => '提示终端客户已开启录屏。', 'type' => 'string', 'example' => 'off'],
'RecordingUserNotifyMessage' => ['description' => '提示终端客户开启录屏的信息。', 'type' => 'string', 'example' => 'Screen recording is enabled.'],
'AdminAccess' => ['description' => '用户连接云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。', 'type' => 'string', 'example' => 'deny'],
'MaxReconnectTime' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
'DisplayMode' => ['description' => '显示模式。', 'type' => 'string', 'example' => 'adminCustom'],
'StreamingMode' => ['description' => '流模式适配场景。', 'type' => 'string', 'example' => 'smooth'],
'ColorEnhancement' => ['description' => '设计及3D应用场景选择是否开启色彩增强。', 'type' => 'string', 'example' => 'off'],
'SmoothEnhancement' => ['description' => '日常办公场景选择,是否开启平滑度增强。', 'type' => 'string', 'example' => 'off'],
'QualityEnhancement' => ['description' => '设计及3D应用场景选择是否开启画质增强。', 'type' => 'string', 'example' => 'off'],
'VideoEncPolicy' => ['description' => '视频编码策略。', 'type' => 'string', 'example' => 'qualityFirst'],
'TargetFps' => ['description' => '目标帧率,取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'VideoEncMinQP' => ['description' => '视频编码最小QP,最高质量。取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'VideoEncMaxQP' => ['description' => '视频编码最大QP,画面最低质量,取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'VideoEncAvgKbps' => ['description' => '视频编码平均码率。单位:Kbps。取值范围:1000\\~50000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'VideoEncPeakKbps' => ['description' => '视频编码峰值码率。单位:Kbps。取值范围:1000~50000。', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
'DeviceRedirects' => [
'description' => '设备重定向规则。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则。',
'type' => 'object',
'properties' => [
'DeviceType' => ['description' => '外设类型。', 'type' => 'string', 'example' => 'camera'],
'RedirectType' => ['description' => '重定向类型。', 'type' => 'string', 'example' => 'usbRedirect'],
],
],
],
'DeviceRules' => [
'description' => '自定义外设规则。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则。',
'type' => 'object',
'properties' => [
'DeviceType' => ['description' => '外设类型。', 'type' => 'string', 'example' => 'storage'],
'DeviceName' => ['description' => '设备名称', 'type' => 'string', 'example' => 'sandisk'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'example' => '0x0781'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'example' => '0x55b1'],
'RedirectType' => ['description' => '重定向类型。', 'type' => 'string', 'example' => 'usbRedirect'],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'example' => '2:0'],
'Platforms' => ['type' => 'string', 'description' => ''],
],
],
],
'WyAssistant' => ['description' => '是否在云电脑悬浮球内提供无影AI助手功能入口。', 'type' => 'string', 'example' => 'on'],
'StatusMonitor' => ['description' => '是否在云电脑悬浮球内提供状态监控功能入口。', 'type' => 'string', 'example' => 'on'],
'MobileRestart' => ['description' => '通过移动端(Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供重启按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。', 'type' => 'string', 'example' => 'off'],
'MobileShutdown' => ['description' => '通过移动端(Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供关机按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。', 'type' => 'string', 'example' => 'off'],
'DesktopCount' => ['description' => '已关联该策略的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DesktopGroupCount' => ['description' => '已关联该策略的云电脑池数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ResourceGroupCount' => ['description' => '已关联该策略的资源组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ResolutionModel' => ['description' => '分辨率类型。', 'type' => 'string', 'example' => 'adaptive'],
'ResolutionWidth' => ['description' => '分辨率的宽度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'],
'ResolutionHeight' => ['description' => '分辨率的高度。单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '1280'],
'Taskbar' => ['description' => '应用任务栏。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'string', 'example' => 'off'],
'NoOperationDisconnect' => ['description' => '无操作断连。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'string', 'example' => 'off'],
'NoOperationDisconnectTime' => ['description' => '无操作断连时长。单位:秒。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
'DisconnectKeepSession' => ['description' => '会话断连保留。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'string', 'example' => 'persistent'],
'DisconnectKeepSessionTime' => ['description' => '会话断连保留时长。单位:秒。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
'DomainRegisterValue' => ['description' => '域名解析生效字段。', 'type' => 'string', 'example' => 'xxxx'],
'RecordEventFilePaths' => [
'description' => '录屏审计中的文件监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的文件监控绝对路径。', 'type' => 'string', 'example' => 'd:/data'],
],
'RecordEventRegisters' => [
'description' => '录屏审计中的注册表监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的注册表监控绝对路径。', 'type' => 'string', 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR'],
'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR',
],
'RecordEventDuration' => ['description' => '录屏审计中检测到事件发生后录屏的时长。单位:分钟。取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'InternetPrinter' => ['type' => 'string', 'description' => ''],
'SafeMenu' => ['type' => 'string', 'description' => ''],
'ScreenDisplayMode' => ['type' => 'string', 'description' => ''],
'ClientControlMenu' => ['type' => 'string', 'description' => ''],
'FileTransferSpeedLocation' => ['type' => 'string', 'description' => ''],
'FileTransferAddress' => ['type' => 'string', 'description' => ''],
'FileTransferSpeed' => ['type' => 'string', 'description' => ''],
'CpdDriveClipboard' => ['type' => 'string', 'description' => ''],
'UseTime' => ['type' => 'string', 'description' => ''],
'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'],
'ExternalDrive' => ['type' => 'string'],
'KmsServerConfig' => ['type' => 'string'],
'KmsServer' => ['type' => 'string'],
'ClientCreateSnapshot' => ['type' => 'string'],
'DiskOverload' => ['type' => 'string'],
'CpuOverload' => ['type' => 'string'],
'MemoryOverload' => ['type' => 'string'],
'AdminMonitor' => ['type' => 'integer', 'format' => 'int32'],
'KeyboardControl' => ['type' => 'string'],
'AdminKeyboardOnWindows' => ['type' => 'string'],
'AdminKeyboardOnFullScreen' => ['type' => 'string'],
'NetworkPrinter' => ['type' => 'string'],
'EndUserCount' => ['type' => 'string'],
'OrganizationCount' => ['type' => 'string'],
'ResetDesktop' => ['type' => 'string'],
'DeviceConnectHint' => ['type' => 'string'],
'FileMigrate' => ['type' => 'string'],
'WuyingKeeper' => ['type' => 'string'],
'AutoReconnect' => ['type' => 'string'],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询无地域策略',
'summary' => '查询无地域策略的详细信息。',
'changeSet' => [
['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 20,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DescribePolicyGroups\\": [\\n {\\n \\"PolicyStatus\\": \\"AVAILABLE\\",\\n \\"Html5Access\\": \\"off\\",\\n \\"WatermarkType\\": \\"EndUserId\\",\\n \\"WatermarkCustomText\\": \\"custom-watermark\\",\\n \\"Clipboard\\": \\"off\\",\\n \\"PolicyGroupId\\": \\"pg-gx2x1dhsmthe9****\\",\\n \\"PrinterRedirection\\": \\"off\\",\\n \\"Html5FileTransfer\\": \\"off\\",\\n \\"UsbRedirect\\": \\"off\\",\\n \\"PolicyGroupType\\": \\"SYSTEM\\",\\n \\"Watermark\\": \\"on\\",\\n \\"VisualQuality\\": \\"medium\\",\\n \\"Name\\": \\"testPolicyGroupName\\",\\n \\"LocalDrive\\": \\"readwrite\\",\\n \\"AuthorizeSecurityPolicyRules\\": [\\n {\\n \\"Type\\": \\"inflow\\",\\n \\"Policy\\": \\"accept\\",\\n \\"Description\\": \\"test\\",\\n \\"PortRange\\": \\"22/22\\",\\n \\"IpProtocol\\": \\"tcp\\",\\n \\"Priority\\": \\"1\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"AuthorizeAccessPolicyRules\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"CidrIp\\": \\"47.100.XX.XX/16\\"\\n }\\n ],\\n \\"ClientTypes\\": [\\n {\\n \\"Status\\": \\"on\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"GpuAcceleration\\": \\"off\\",\\n \\"UsbSupplyRedirectRule\\": [\\n {\\n \\"VendorId\\": \\"04**\\",\\n \\"ProductId\\": \\"08**\\",\\n \\"Description\\": \\"Test rule\\",\\n \\"UsbRedirectType\\": 1,\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"off\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"tcp\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 3,\\n \\"EndUserApplyAdminCoordinate\\": \\"off\\",\\n \\"EndUserGroupCoordinate\\": \\"off\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"off\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"Screen recording is enabled.\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 2000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"ResolutionModel\\": \\"adaptive\\",\\n \\"ResolutionWidth\\": 1920,\\n \\"ResolutionHeight\\": 1280,\\n \\"Taskbar\\": \\"off\\",\\n \\"NoOperationDisconnect\\": \\"off\\",\\n \\"NoOperationDisconnectTime\\": 120,\\n \\"DisconnectKeepSession\\": \\"persistent\\",\\n \\"DisconnectKeepSessionTime\\": 120,\\n \\"DomainRegisterValue\\": \\"xxxx\\",\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"MobileWyAssistant\\": \\"\\",\\n \\"MobileSafeMenu\\": \\"\\",\\n \\"MobileWuyingKeeper\\": \\"\\",\\n \\"ExternalDrive\\": \\"\\",\\n \\"KmsServerConfig\\": \\"\\",\\n \\"KmsServer\\": \\"\\",\\n \\"ClientCreateSnapshot\\": \\"\\",\\n \\"DiskOverload\\": \\"\\",\\n \\"CpuOverload\\": \\"\\",\\n \\"MemoryOverload\\": \\"\\",\\n \\"AdminMonitor\\": 0,\\n \\"KeyboardControl\\": \\"\\",\\n \\"AdminKeyboardOnWindows\\": \\"\\",\\n \\"AdminKeyboardOnFullScreen\\": \\"\\",\\n \\"NetworkPrinter\\": \\"\\",\\n \\"EndUserCount\\": \\"\\",\\n \\"OrganizationCount\\": \\"\\",\\n \\"ResetDesktop\\": \\"\\",\\n \\"DeviceConnectHint\\": \\"\\",\\n \\"FileMigrate\\": \\"\\",\\n \\"WuyingKeeper\\": \\"\\",\\n \\"AutoReconnect\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeClientEvents' => [
'summary' => '查询终端用户的操作日志,包括云电脑的开机、关机、会话断开等事件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '登录用户信息,RAM用户ID或AD用户名。不指定时,表示查询该地域下所有用户的事件。', 'type' => 'string', 'required' => false, 'example' => '28961708130834****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。不指定时,表示查询该地域下所有云电脑。', 'type' => 'string', 'required' => false, 'example' => 'ecd-8fupvkhg0aayu****'],
],
[
'name' => 'DesktopIp',
'in' => 'query',
'schema' => ['description' => '云电脑的IP地址。不指定时,表示查询该地域下所有云电脑的事件。', 'type' => 'string', 'required' => false, 'example' => '10.10.*.*'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '> 本参数不开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'To be hidden.'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '云电脑所属的办公网络ID。不指定时,表示查询该地域下所有办公网络下的用户事件。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****'],
],
[
'name' => 'EventType',
'in' => 'query',
'schema' => [
'description' => '要查询的事件类型。当EventTypes不为空时,则以EventTypes组合类型为查询过滤条件。当EventTypes为空,且EventType为空,则查询所有事件。',
'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' => '开始时间。按照[ISO 8601](~~25696~~)标准表示,并需要使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。 '."\n"
.'如果不填,则按`EndTime`指定的时间往前查询。', 'type' => 'string', 'required' => false, 'example' => '2020-11-30T06:32:31Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。按照[ISO 8601](~~25696~~)标准表示,并需要使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。 '."\n"
.'如果不填,则按当前时间。', 'type' => 'string', 'required' => false, 'example' => '2020-11-31T06:32:31Z'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
.'默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'EventTypes',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '要查询的事件类型组合,可以多个事件组合,查询结果包含所有组合的事件。',
'type' => 'array',
'items' => [
'description' => '要查询的事件类型。',
'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, 'description' => ''],
],
[
'name' => 'FillHardwareInfo',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '28A40F12-F340-442B-A35F-46EF6A03227B'],
'Events' => [
'description' => '用户事件。',
'type' => 'array',
'items' => [
'description' => '用户事件。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '事件行为状态,一般在`DESKTOP_DISCONNECT`和`GET_CONNECTION_TICKET`中出现。可能值:'."\n"
.'- 200,表示成功。'."\n"
.'- 返回失败信息,例如:FailedToGetConnectionTicket。', 'type' => 'string', 'example' => '200'],
'BytesReceived' => ['description' => '已接收字节,单位:Byte。', 'type' => 'string', 'example' => '8665'],
'DesktopIp' => ['description' => '云电脑的IP地址。', 'type' => 'string', 'example' => '10.10.XX.XX'],
'EventTime' => ['description' => '事件发生的时间。', 'type' => 'string', 'example' => '2020-11-30T06:32:31Z'],
'BytesSend' => ['description' => '已发送字节,单位:Byte。', 'type' => 'string', 'example' => '2345'],
'OfficeSiteId' => ['description' => '云电脑所属的办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****'],
'AliUid' => ['description' => '事件关联的主账号信息。', 'type' => 'string', 'example' => '112259558861****'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-8fupvkhg0aayu****'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'EventId' => ['description' => '事件ID。', 'type' => 'string', 'example' => '5651188b-3070-d1cc-5311-75753d59****'],
'DirectoryType' => ['description' => '目录类型。', 'type' => 'string', 'example' => 'RAM'],
'EventType' => ['description' => '事件类型。', 'type' => 'string', 'example' => 'DESKTOP_DISCONNECT'],
'EndUserId' => ['description' => '登录用户信息,RAM用户ID或者AD用户名。', 'type' => 'string', 'example' => '28961708130834****'],
'ClientIp' => ['description' => '客户端IP。', 'type' => 'string', 'example' => '100.68.*.*'],
'ClientOS' => ['description' => '客户端系统。', 'type' => 'string', 'example' => 'Darwin 17.7.0 x64'],
'OfficeSiteType' => [
'description' => '办公网络的账号系统类型。',
'type' => 'string',
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'SIMPLE',
],
'DirectoryId' => ['description' => '云电脑所属的目录ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-bh77qa8nmjot4****'],
'ClientVersion' => ['description' => '客户端版本。', 'type' => 'string', 'example' => '1.0.4 202012021700'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'test'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'test'],
'DesktopGroupId' => ['description' => '云电脑池ID。', 'type' => 'string', 'example' => 'dg-kadkdfaf****'],
'DesktopGroupName' => ['description' => '云电脑池名称。', 'type' => 'string', 'example' => 'testName'],
'Description' => ['description' => '描述。', 'type' => 'string', 'example' => 'test'],
'TerminalInfo' => [
'type' => 'object',
'properties' => [
'ProductName' => ['type' => 'string', 'description' => ''],
'SerialNumber' => ['type' => 'string', 'description' => ''],
'Model' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
],
],
],
],
],
'title' => '查询终端用户的操作日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-19T06:25:59.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-01-11T09:27:20.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-08T08:41:40.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClientEvents'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeClientEvents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"28A40F12-F340-442B-A35F-46EF6A03227B\\",\\n \\"Events\\": [\\n {\\n \\"Status\\": \\"200\\",\\n \\"BytesReceived\\": \\"8665\\",\\n \\"DesktopIp\\": \\"10.10.XX.XX\\",\\n \\"EventTime\\": \\"2020-11-30T06:32:31Z\\",\\n \\"BytesSend\\": \\"2345\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"AliUid\\": \\"112259558861****\\",\\n \\"DesktopId\\": \\"ecd-8fupvkhg0aayu****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"EventId\\": \\"5651188b-3070-d1cc-5311-75753d59****\\",\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"EventType\\": \\"DESKTOP_DISCONNECT\\",\\n \\"EndUserId\\": \\"28961708130834****\\",\\n \\"ClientIp\\": \\"100.68.*.*\\",\\n \\"ClientOS\\": \\"Darwin 17.7.0 x64\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-bh77qa8nmjot4****\\",\\n \\"ClientVersion\\": \\"1.0.4 202012021700\\",\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"DesktopName\\": \\"test\\",\\n \\"DesktopGroupId\\": \\"dg-kadkdfaf****\\",\\n \\"DesktopGroupName\\": \\"testName\\",\\n \\"Description\\": \\"test\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"Model\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n 28A40F12-F340-442B-A35F-46EF6A03227B\\n \\n 200\\n 8665\\n 10.10.*.*\\n 2020-11-30T06:32:31Z\\n 2345\\n cn-hangzhou+dir-bh77qa8nmjot4****\\n 112259558861****\\n ecd-8fupvkhg0aayu****\\n cn-hangzhou\\n 5651188b-3070-d1cc-5311-75753d59****\\n RAM\\n DESKTOP_DISCONNECT\\n 28961708130834****\\n 100.68.*.*\\n Darwin 17.7.0 x64\\n SIMPLE\\n cn-hangzhou+dir-bh77qa8nmjot4****\\n 1.0.4 202012021700\\n test\\n test\\n dg-kadkdfaf****\\n testName\\n \\n","errorExample":""}]',
],
'DescribeCloudDiskGroupDrives' => [
'summary' => '查询云盘团队空间列表',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-6805637***'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '团队空间名称', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Team 1'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'MTA0MjA='],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'MTA0MjA='],
'RequestId' => ['description' => '请求ID。', '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' => '团队空间ID。', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****'],
'GroupName' => ['description' => '团队空间名称。', 'type' => 'string', 'example' => 'Test team 1'],
'DirectoryId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****'],
'DriveId' => ['description' => '空间ID。', 'type' => 'string', 'example' => '1234'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z'],
'TotalSize' => ['description' => '网盘团队总容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120'],
'UsedSize' => ['description' => '已使用的空间大小。单位:Byte(字节)。', 'type' => 'string', 'example' => '1024000000'],
'OrgId' => ['description' => '团队的组织ID。', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id'],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"MTA0MjA=\\",\\n \\"RequestId\\": \\"B9F9CBBE-8A9F-5FE5-8A72-0E81C2401A91\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询云盘团队空间',
'description' => '云盘团队列表是从无影客户端->用户管理->组织结构同步过来的,如果用户想要使用团队空间,需要在用户管理界面将用户移动到指定组织下,用户在云盘客户端可看到团队空间的菜单栏。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDiskGroupDrives',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCloudDiskGroups' => [
'summary' => '查询云盘团队列表',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '已创建的企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-0456357992'],
],
[
'name' => 'GroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '配置组ID。',
'type' => 'array',
'items' => ['description' => '团队空间ID列表。', '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' => 'Test team 1'],
],
[
'name' => 'ParentOrgId',
'in' => 'query',
'schema' => ['description' => '父组织ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'root'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D648DBF7-9476-53D6-98AB-674836021DFB'],
'Count' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'True'],
'CloudDriveGroups' => [
'description' => '网盘团队空间列表。',
'type' => 'array',
'items' => [
'description' => '网盘团队空间列表。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '团队空间状态。', 'type' => 'string', 'example' => '1'],
'GroupId' => ['description' => '团队空间ID。', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****'],
'GroupName' => ['description' => '团队空间名称。', 'type' => 'string', 'example' => 'Test team 1'],
'DirectoryId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****'],
'DriveId' => ['description' => '空间ID。', 'type' => 'string', 'example' => '1234'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z'],
'TotalSize' => ['description' => '网盘团队总容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120'],
'UsedSize' => ['description' => '已使用的空间大小。单位:Byte(字节)。', 'type' => 'string', 'example' => '1024000000'],
'OrgId' => ['description' => '团队的组织ID。', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id'],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"D648DBF7-9476-53D6-98AB-674836021DFB\\",\\n \\"Count\\": 1,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询云盘团队',
'description' => '开启安全防护后,系统将周期性(每天一次)自动扫描云桌面的系统漏洞。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDiskGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCloudDriveGroups' => [
'summary' => '查询企业网盘内所有团队共享盘的列表及基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '团队空间ID列表。',
'type' => 'array',
'items' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '团队空间名称,支持模糊查询。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Test team 1'],
],
[
'name' => 'ParentGroupId',
'in' => 'query',
'schema' => ['description' => '待查询对象的父节点ID。查询根节点时,填`root`。'."\n"
."\n"
.'默认为空,表示查询全部。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cg-e70ga4ixp30ur****'],
],
[
'name' => 'DriveStatus',
'in' => 'query',
'schema' => [
'description' => '团队空间状态。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '可用 [默认值]'],
'example' => 'enabled',
],
],
[
'name' => 'GroupType',
'in' => 'query',
'schema' => [
'description' => '团队类型。默认为空,表示查询全部。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['org' => '组织架构', 'directory' => '办公网络'],
'example' => 'org',
],
],
[
'name' => 'DriveType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '是否添加空间。默认为空,表示查询全部。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['unbound' => '没有添加空间', 'binding' => '添加了空间'],
'example' => 'binding',
],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'],
],
[
'name' => 'DirectoryName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDirectoryName '],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6lY3I2VNHLwy+nIoSXh****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,`NextToken`为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'EF015AE5-B30A-5189-B519-735CEE40****'],
'Count' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'CloudDriveGroups' => [
'description' => '网盘团队空间列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '团队空间状态。',
'type' => 'string',
'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '可用 [默认值]'],
'example' => 'enabled',
],
'GroupId' => ['description' => '团队空间ID。', 'type' => 'string', 'example' => 'cg-e70ga4ixp30ur****'],
'GroupName' => ['description' => '团队空间名称。', 'type' => 'string', 'example' => 'Test team 1'],
'DirectoryId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-959593****'],
'DriveId' => ['description' => '空间ID。', 'type' => 'string', 'example' => 'sh1234'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-04-11T07:44:21Z'],
'TotalSize' => ['description' => '网盘团队总容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5368709120'],
'UsedSize' => ['description' => '已使用的空间大小。单位:Byte(字节)。', 'type' => 'string', 'example' => '1024000000'],
'RecycleBinSize' => ['description' => '团队空间回收站的大小。单位:Byte(字节)。', 'type' => 'string', 'example' => '1024000'],
'AdminUserIds' => ['description' => '团队管理员列表。', 'type' => 'string', 'example' => '["user01"]'],
'OrgId' => ['description' => '团队的组织ID。', 'type' => 'string', 'example' => 'org-aliyun-wy-org-id'],
'AdminUserInfos' => [
'description' => '团队空间管理员信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '管理员用户名(三方导入时可能不可读)。', 'type' => 'string', 'example' => 'user01'],
'NickName' => ['description' => '管理员昵称。', 'type' => 'string', 'example' => 'John Doe'],
'RealNickName' => ['description' => '管理员昵称。', 'type' => 'string', 'example' => 'John Doe'],
'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => 'John Doe'],
'Phone' => ['description' => '电话号码。', 'type' => 'string', 'example' => '12345678'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => '123@aliyun.com'],
'JobNumber' => ['description' => '工号(钉钉)', 'type' => 'string', 'example' => '12345'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"EF015AE5-B30A-5189-B519-735CEE40****\\",\\n \\"Count\\": 0,\\n \\"Success\\": true,\\n \\"CloudDriveGroups\\": [\\n {\\n \\"Status\\": \\"enabled\\",\\n \\"GroupId\\": \\"cg-e70ga4ixp30ur****\\",\\n \\"GroupName\\": \\"Test team 1\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-959593****\\",\\n \\"DriveId\\": \\"sh1234\\",\\n \\"CreateTime\\": \\"2022-04-11T07:44:21Z\\",\\n \\"TotalSize\\": 5368709120,\\n \\"UsedSize\\": \\"1024000000\\",\\n \\"RecycleBinSize\\": \\"1024000\\",\\n \\"AdminUserIds\\": \\"[\\\\\\"user01\\\\\\"]\\",\\n \\"OrgId\\": \\"org-aliyun-wy-org-id\\",\\n \\"AdminUserInfos\\": [\\n {\\n \\"EndUserId\\": \\"user01\\",\\n \\"NickName\\": \\"John Doe\\",\\n \\"RealNickName\\": \\"John Doe\\",\\n \\"Remark\\": \\"John Doe\\",\\n \\"Phone\\": \\"12345678\\",\\n \\"Email\\": \\"123@aliyun.com\\",\\n \\"JobNumber\\": \\"12345\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询团队共享盘列表',
'changeSet' => [
['createdAt' => '2024-12-02T02:36:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-23T12:37:42.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-12-11T14:21:05.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-06-27T02:25:40.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveGroups'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDriveGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCloudDrivePermissions' => [
'summary' => '查询企业网盘的权限设置详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '已创建的企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-82414*****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A87DBB05-653A-5E4B-B72B-5F4A1E07E5B3'],
'CloudDrivePermissionModels' => [
'description' => '企业网盘权限信息列表。',
'type' => 'array',
'items' => [
'description' => '企业网盘权限信息。',
'type' => 'object',
'properties' => [
'Permission' => [
'description' => '用户在企业网盘与本地设备之间的文件传输权限。',
'type' => 'string',
'enumValueTitles' => ['CDS_CREATE_DOWNLOAD' => '同时具备上传和下载权限', 'CDS_DOWNLOAD' => '仅具备下载权限', 'CDS_CREATE' => '仅具备上传权限'],
'example' => 'CDS_DOWNLOAD',
],
'EndUsers' => [
'description' => '终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
],
'description' => '',
],
],
],
'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' => '查询企业网盘的权限设置详情',
'changeSet' => [
['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDrivePermissions'],
],
],
'ramActions' => [],
],
'DescribeCloudDriveUsers' => [
'summary' => '查询企业网盘内所有用户个人盘的列表及基本信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-066224****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户ID。'."\n"
."\n"
.'如果不为空,则只查询当前用户的个人盘;如果为空,则查询所有用户的个人盘。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100。'."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,`NextToken`为空表示没有下一个。', 'type' => 'string', 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F083AAE5-7AA9-53BB-9060-AFFB2C18****'],
'CloudDriveUsers' => [
'description' => '用户个人盘列表。',
'type' => 'array',
'items' => [
'description' => '用户个人盘。',
'type' => 'object',
'properties' => [
'UsedSize' => ['description' => '已使用的空间大小。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '10485760'],
'Status' => [
'description' => '用户个人盘的状态。',
'type' => 'string',
'enumValueTitles' => ['disabled' => '已禁用', 'enabled' => '已启用'],
'example' => 'enabled',
],
'DriveId' => ['description' => '用户个人盘ID。', 'type' => 'string', 'example' => '8'],
'TotalSize' => ['description' => '用户个人盘的存储峰值。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '104857600'],
'UserId' => ['description' => '用户内部ID。', 'type' => 'string', 'example' => 'alice@cn-shanghai.148875033399****'],
'UserName' => ['description' => '终端用户名称。', 'type' => 'string', 'example' => 'alice'],
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询用户个人盘列表',
'changeSet' => [
['createdAt' => '2023-06-30T08:54:18.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveUsers'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCloudDriveUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\",\\n \\"RequestId\\": \\"F083AAE5-7AA9-53BB-9060-AFFB2C18****\\",\\n \\"CloudDriveUsers\\": [\\n {\\n \\"UsedSize\\": 10485760,\\n \\"Status\\": \\"enabled\\",\\n \\"DriveId\\": \\"8\\",\\n \\"TotalSize\\": 104857600,\\n \\"UserId\\": \\"alice@cn-shanghai.148875033399****\\",\\n \\"UserName\\": \\"alice\\",\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeConfigGroup' => [
'summary' => '查询配置组列表信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '配置组ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '配置组名称。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task configuration'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '配置组类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Timer' => '定时任务'],
'example' => 'Timer',
],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '配置组使用的产品类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
],
[
'name' => 'Statuses',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '配置组状态列表。',
'type' => 'array',
'items' => [
'description' => '配置组状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['AVAILABLE' => '可用', 'UNAVAILABLE' => '已删除', 'DELETING' => '删除中', 'UPDATING' => '修改中'],
'example' => 'AVAILABLE',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '配置组ID列表。',
'type' => 'array',
'items' => ['description' => '配置组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0cwz8naid24v*****'],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Data' => [
'description' => '配置组信息。',
'type' => 'array',
'items' => [
'description' => '配置组信息。',
'type' => 'object',
'properties' => [
'GroupId' => ['description' => '配置组ID。', 'type' => 'string', 'example' => 'ccg-0cid8v30an12****'],
'Name' => ['description' => '配置组名称。', 'type' => 'string', 'example' => 'Scheduled task'],
'Description' => ['description' => '配置组描述信息。', 'type' => 'string', 'example' => 'Scheduled task information'],
'Type' => [
'description' => '配置组类型。',
'type' => 'string',
'enumValueTitles' => ['Timer' => '定时任务'],
'example' => 'Timer',
],
'ProductType' => [
'description' => '配置组使用的产品类型。',
'type' => 'string',
'enumValueTitles' => ['CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'Status' => [
'description' => '配置组状态。',
'type' => 'string',
'enumValueTitles' => ['AVAILABLE' => '可用', 'UNAVAILABLE' => '已删除', 'DELETING' => '删除中', 'UPDATING' => '修改中'],
'example' => 'AVAILABLE',
],
'BindCount' => ['description' => '配置组绑定的资源数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'BindCountMap' => [
'description' => '配置绑定资源的数量信息。',
'type' => 'object',
'additionalProperties' => ['type' => 'integer', 'format' => 'int32', 'description' => '绑定的资源数量。', 'example' => '10'],
],
'IsUpdate' => ['title' => '系统定时任务检查使用,当前定时任务不支持修改', 'description' => '系统定时任务检查使用,当前定时任务不支持修改', 'type' => 'boolean'],
'IsBind' => ['title' => '系统定时任务检查使用,当前定时任务不支持解绑和绑定', 'description' => '系统定时任务检查使用,当前定时任务不支持解绑和绑定', 'type' => 'boolean'],
'InnerTimerName' => ['title' => '前端展示使用,系统定时任务名称映射code', 'description' => '前端展示使用,系统定时任务名称映射code', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE'],
'InnerTimerDesc' => ['title' => '前端展示使用,系统定时任务描述使用code', 'description' => '前端展示使用,系统定时任务描述使用code', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC'],
],
],
],
'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['description' => '查询结果总数。', '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\\": \\"Scheduled task\\",\\n \\"Description\\": \\"Scheduled task information\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCount\\": 4,\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsUpdate\\": 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' => '查询配置组列表',
'changeSet' => [
['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCustomizedListHeaders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', '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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Headers' => [
'description' => '表头列表。',
'type' => 'array',
'items' => [
'description' => '表头。',
'type' => 'object',
'properties' => [
'DisplayType' => [
'description' => '表头的显示类型。可调用[ModifyCustomizedListHeaders](~~452324~~)更改。',
'type' => 'string',
'enumValueTitles' => ['hide' => '隐藏', 'display' => '显示', 'required' => '必选(不可隐藏)'],
'example' => 'display',
],
'HeaderKey' => ['description' => '表头键值。', 'type' => 'string', 'example' => 'system_data_disk'],
'HeaderName' => ['description' => '表头名称。', 'type' => 'string', 'example' => 'System disk/Data disk'],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Headers\\": [\\n {\\n \\"DisplayType\\": \\"display\\",\\n \\"HeaderKey\\": \\"system_data_disk\\",\\n \\"HeaderName\\": \\"System disk/Data disk\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取云电脑列表表头',
'summary' => '获取云电脑列表页的表头信息。',
'changeSet' => [
['createdAt' => '2022-09-09T06:33:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCustomizedListHeaders'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCustomizedListHeaders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeDesktopGroupSessions' => [
'summary' => '查询共享型云电脑会话监控详情。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SessionStatus',
'in' => 'query',
'schema' => [
'description' => '连接状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Connected' => '连接', 'Disconnected' => '断开'],
'example' => 'Connected',
],
],
[
'name' => 'OwnType',
'in' => 'query',
'schema' => [
'description' => '会话类型。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => ['单会话', '多会话'],
'example' => '1',
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '连接会话的终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间。', 'type' => 'string', 'required' => false, 'example' => '"2022-08-31T06:56:45Z"'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间。', 'type' => 'string', 'required' => false, 'example' => '"2022-08-31T06:56:45Z"'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '每页最大数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一页Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6ljnKKgSRjo8yXAIT5QSvkU'],
],
[
'name' => 'FillTerminalInfo',
'in' => 'query',
'schema' => ['title' => '是否补充终端信息。', 'description' => '是否补充终端信息。', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '返回信息语言类型。', 'description' => '返回信息语言类型。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'DesktopGroupIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '共享桌面组ID列表。',
'description' => '共享桌面组ID列表。',
'type' => 'array',
'items' => ['title' => '共享桌面组ID。', 'description' => '共享桌面组ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-4oyi32wmrctgx****'],
'required' => false,
],
],
[
'name' => 'DesktopGroupName',
'in' => 'query',
'schema' => ['title' => '共享桌面名称。', 'description' => '共享桌面名称。', 'type' => 'string', 'required' => false, 'example' => 'ecd-4oyi32wmrctgx****'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0920845-7359-59FC-9899-B****'],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
'Sessions' => [
'description' => '会话数据列表。',
'type' => 'array',
'items' => [
'description' => '会话详情。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '连接会话的终端用户ID。', 'type' => 'string', 'example' => 'alice'],
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-iaqu3bi2xtie****'],
'DesktopGroupName' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'example' => 'DemoCCGroup'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'DemoOfficeNetwork'],
'OwnType' => [
'description' => '会话类型。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['单会话', '多会话'],
'example' => '0',
],
'SessionStatus' => [
'description' => '会话连接状态。',
'type' => 'string',
'enumValueTitles' => ['Connected' => '连接', 'Disconnected' => '断开'],
'example' => 'Connected',
],
'DesktopId' => ['description' => '若会话状态为连接,则表示当前连接的云电脑ID;若会话状态为断开,则表示最近一次连接的云电脑ID。', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****'],
'ClientOS' => ['description' => '客户端的操作系统。', 'type' => 'string', 'example' => 'windows'],
'ClientVersion' => ['description' => '客户端版本。', 'type' => 'string', 'example' => '7.8.0'],
'ClientIp' => ['description' => '客户端IP。', 'type' => 'string', 'example' => '172.21.XX.XX'],
'LatestConnectionTime' => ['description' => '最近一次连接时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalConnectionDuration' => ['description' => '连接总时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'SessionIdleTime' => ['description' => '云电脑空闲时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'ProtocolType' => [
'description' => '协议类型。'."\n",
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'LastSessionStartTime' => ['description' => '最近一次连接开始时间。', 'type' => 'string', 'example' => '2022-08-31 06:56:45'],
'LastSessionEndTime' => ['description' => '最近一次连接结束时间。', 'type' => 'string', 'example' => '2022-08-31 07:56:45'],
'OsType' => [
'description' => '云电脑的操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['linux' => 'Linux操作系统', 'windows' => 'Windows操作系统'],
'example' => 'Windows',
],
'EndUserApplyCoordinateTime' => ['description' => '用户申请管理员协助时间点。', 'type' => 'integer', 'format' => 'int64', 'example' => '1678794261000'],
'TerminalInfo' => [
'title' => '终端信息。',
'description' => '终端信息。',
'type' => 'object',
'properties' => [
'ProductName' => ['title' => '终端类型。', 'description' => '终端类型。', 'type' => 'string', 'example' => 'Mac'],
'SerialNumber' => ['title' => '终端序列号', 'description' => '终端序列号', 'type' => 'string', 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****'],
'Model' => ['title' => '终端设备类型。', 'description' => '终端设备类型。', 'type' => 'string', 'example' => 'wuying_mac_x86_64'],
'Uuid' => ['title' => '终端设备UUID。', 'description' => '终端设备UUID。', 'type' => 'string', 'example' => 'EBFDC7773BEBAD418A9F89429652****'],
],
],
'DirectoryType' => ['title' => '办公网络类型', 'description' => '办公网络类型', 'type' => 'string', 'example' => 'SIMPLE'],
'AccountType' => ['title' => '账号类型', 'description' => '账号类型', 'type' => 'string', 'example' => 'SIMPLE'],
],
],
],
'NextToken' => ['description' => '下一页查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2'],
],
],
],
],
'title' => '查询共享型云电脑会话监控详情',
'changeSet' => [
['createdAt' => '2025-10-17T12:21:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-09-15T04:00:29.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroupSessions'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0920845-7359-59FC-9899-B****\\",\\n \\"TotalCount\\": 15,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\",\\n \\"OwnType\\": 0,\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"ClientOS\\": \\"windows\\",\\n \\"ClientVersion\\": \\"7.8.0\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionDuration\\": 120,\\n \\"SessionIdleTime\\": 120,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LastSessionStartTime\\": \\"2022-08-31 06:56:45\\",\\n \\"LastSessionEndTime\\": \\"2022-08-31 07:56:45\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 1678794261000,\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"wuying_mac_x86_64\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"AccountType\\": \\"SIMPLE\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2\\"\\n}","type":"json"}]',
],
'DescribeDesktopGroups' => [
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑所属的办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-467671****'],
],
[
'name' => 'DesktopGroupName',
'in' => 'query',
'schema' => ['description' => '要查询的共享型云电脑名称,支持模糊查询。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CloudComputerPool01'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '包年包月共享型云电脑的购买时长。单位由`PeriodUnit`指定。'."\n"
.'- 如果`PeriodUnit`为`Month`,该参数的取值范围:'."\n"
.' - 1'."\n"
.' - 2'."\n"
.' - 3'."\n"
.' - 6'."\n"
.'- 如果`PeriodUnit`为`Year`,该参数的取值范围:'."\n"
.' - 1'."\n"
.' - 2'."\n"
.' - 3'."\n"
.' - 4'."\n"
.' - 5', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '包年包月计费方式的时长单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
.'最大值:100。'."\n"
.'默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑的状态。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => ['未支付', '正常', '欠费或过期'],
'example' => '1',
],
],
[
'name' => 'OwnType',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑类型。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['单会话多台共享型云电脑', '多会话多台共享型云电脑'],
'example' => '0',
],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑的授权用户ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑的授权用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'."\n"],
'required' => false,
'maxItems' => 1000,
],
],
[
'name' => 'ExcludedEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要排除的已授权用户列表。',
'type' => 'array',
'items' => ['description' => '要排除的已授权用户。', 'type' => 'string', 'required' => false, 'example' => 'Tony'],
'required' => false,
'maxItems' => 1000,
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
],
[
'name' => 'ImageId',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID列表。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-eeuo9qab4b0****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'BundleId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑模板ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => false, 'example' => 'b-4w5nk44znm6****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。可包含1\\~20个。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。可以为空字符串。最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'MultiResource',
'in' => 'query',
'schema' => [
'description' => '是否为多台共享类型的共享型云电脑。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '多台共享型云电脑', 'false' => '单台共享型云电脑'],
'example' => 'true',
],
],
[
'name' => 'DesktopGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'QosRuleId',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'DesktopGroups' => [
'description' => '共享型云电脑列表。',
'type' => 'array',
'items' => [
'description' => '共享型云电脑信息。',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-02-17T14:51:07Z'],
'PayType' => [
'description' => '付费类型。',
'type' => 'string',
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
'PolicyGroupName' => ['description' => '共享型云电脑关联的策略名称。', 'type' => 'string', 'example' => 'All enabled policy'],
'Creator' => ['description' => '创建者的阿里云账号ID。', 'type' => 'string', 'example' => '1007214305******'],
'MaxDesktopsCount' => ['description' => '- 对于按量付费的共享型云电脑,该参数表示云电脑的最大创建数量。'."\n"
.'- 对于包年包月的共享型云电脑,该参数表示初始购买的云电脑数量(`BuyDesktopsCount`)与允许自动创建的云电脑数量之和。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'SystemDiskSize' => ['description' => '系统盘容量。单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'PolicyGroupId' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'example' => 'pg-53iyi2aar0nd6c8qj'],
'OwnBundleId' => ['description' => '云电脑模板ID。', 'type' => 'string', 'example' => 'bundle_eds_general_4c8g_s8d5_win2019'],
'GpuCount' => ['description' => 'GPU核数。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'Memory' => ['description' => '内存大小。单位为MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '16384'],
'GpuSpec' => ['description' => 'GPU显存。', 'type' => 'string', 'example' => '16 GiB'],
'OwnBundleName' => ['description' => '云电脑模板名称。', 'type' => 'string', 'example' => 'test'],
'DataDiskCategory' => [
'description' => '用户磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_ssd' => 'SSD云盘', 'cloud_essd' => 'ESSD云盘'],
'example' => 'cloud_ssd',
],
'DesktopGroupName' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'example' => 'CloudComputerPool01'],
'SystemDiskCategory' => [
'description' => '系统盘类型。',
'type' => 'string',
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_ssd' => 'SSD云盘', 'cloud_essd' => 'ESSD云盘'],
'example' => 'cloud_ssd',
],
'OfficeSiteId' => ['description' => '共享型云电脑所属的办公网络名称。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-467671****'],
'KeepDuration' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '180000'],
'MinDesktopsCount' => ['description' => '- 对于按量付费的共享型云电脑,该参数表示云电脑的最小创建数量。'."\n"
.'- 对于包年包月的共享型云电脑,该参数等同于`BuyDesktopsCount`,表示初始购买的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'EndUserCount' => ['description' => '共享型云电脑的授权用户数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataDiskSize' => ['description' => '用户磁盘容量。单位为GiB。', 'type' => 'string', 'example' => '50'],
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-2i8qxpv6t1a03****'],
'OfficeSiteName' => ['description' => '共享型云电脑所属的办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+os-c5cy7q578s8jc****'],
'Cpu' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'ExpiredTime' => ['description' => '包年包月共享型云电脑的到期时间。', 'type' => 'string', 'example' => '2022-03-17T16:00:00Z'],
'Comments' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'comment'],
'OfficeSiteType' => [
'description' => '办公网络的账号体系类型。',
'type' => 'string',
'enumValueTitles' => ['PERSONAL' => '个人型办公网络', 'SIMPLE' => '便捷办公网络', 'AD_CONNECTOR' => 'AD办公网络', 'RAM' => 'RAM型办公网络'],
'example' => 'SIMPLE',
],
'Status' => [
'description' => '共享型云电脑的状态。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['未支付', '正常', '欠费或过期'],
'example' => '1',
],
'ResetType' => [
'description' => '共享型云电脑重置类型。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => ['不重置', '只重置系统盘', '只重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '0',
],
'LoadPolicy' => [
'description' => '多会话多台共享型云电脑的负载均衡策略。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '1',
],
'BindAmount' => ['description' => '多会话多台共享型云电脑中每台云电脑允许的并发会话数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'OwnType' => [
'description' => '共享型云电脑类型。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => ['单会话多台共享型云电脑', '多会话多台共享型云电脑'],
'example' => '0',
],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-gq15cq5ydlvwn****'],
'VolumeEncryptionEnabled' => ['description' => '是否开启加密功能。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '加密磁盘使用的KMS密钥ID。', 'type' => 'string', 'example' => 'e5409ada-xxxx-xxxx-xxxx-89e31e23e993'],
'RatioThreshold' => ['description' => '会话占用率阈值,用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。', 'type' => 'number', 'format' => 'float', 'example' => '0.85'],
'ConnectDuration' => ['description' => '会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600000'],
'IdleDisconnectDuration' => ['description' => '用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '90000'],
'Version' => ['description' => '共享型云电脑版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'StopDuration' => ['description' => '空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '900000'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'BuyDesktopsCount' => ['description' => '该参数仅适用于包年包月的共享型云电脑,表示初始购买的云电脑数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'DesktopCount' => ['description' => '已创建的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'DesktopType' => ['description' => '目标云电脑规格。您可以调用[DescribeDesktopTypes](~~188882~~)查询无影云电脑支持的规格ID。', 'type' => 'string', 'example' => 'eds.enterprise_office.4c4g'],
'CountPerStatus' => [
'description' => '每种状态下的云电脑数量列表。',
'type' => 'array',
'items' => [
'description' => '每种状态下的云电脑数量。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '云电脑状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Running',
],
'Count' => ['description' => '云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
'GpuDriverVersion' => ['description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '12'],
'SubnetId' => ['description' => '子网ID。', 'type' => 'string', 'example' => 'vsw-uf63bb6*****8gfytm'],
'Tags' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'desktop_group_name'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'ds-dq2mybjr23yw*****'],
],
],
],
'UserOuPath' => ['description' => '用户组织单元路径。', 'type' => 'string', 'example' => 'example.com'],
'IsLdap' => ['type' => 'boolean', 'description' => ''],
'UserGroupName' => ['type' => 'string', 'description' => ''],
'PolicyGroupIdList' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'PolicyGroupNameList' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'SimpleUserGroupId' => ['type' => 'string', 'description' => ''],
'OrgId' => ['type' => 'string'],
'AccountType' => ['type' => 'string', 'description' => ''],
'EntraDomainName' => ['type' => 'string', 'description' => ''],
'ExpiredTimes' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'EnvType' => ['type' => 'string'],
'EnvId' => ['type' => 'string'],
'QosRuleId' => ['type' => 'string'],
],
],
],
],
],
],
],
'title' => '查询共享型云电脑列表及详情',
'summary' => '查询共享型云电脑列表及详情。',
'changeSet' => [
['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-06-03T02:21:28.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-08-01T01:51:53.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-07T09:08:48.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-04T10:02:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-09-10T07:04:39.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroups'],
],
],
'ramActions' => [],
'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 \\"OrgId\\": \\"\\",\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\",\\n \\"ExpiredTimes\\": [\\n \\"\\"\\n ],\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\",\\n \\"QosRuleId\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n String\\tcaeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n \\n 2022-02-17T14:51:07Z\\n PrePaid\\n test-policy\\n 1007214305******\\n 10\\n 80\\n pg-53iyi2aar0nd6c8qj\\n bundle_eds_general_4c8g_s8d5_win2019\\n 1\\n 16384\\n 16 GiB\\n cn-hangzhou+dir-adde******\\n test\\n cloud_ssd\\n test1\\n cloud_ssd\\n cn-hangzhou+dir-467671****\\n 1000\\n 1\\n 1\\n 50\\n dg-2i8qxpv6t1a03****\\n testName\\n SIMPLE\\n 4\\n 2022-03-17T16:00:00Z\\n test\\n SIMPLE\\n 1\\n 0\\n \\n","errorExample":""}]',
],
'DescribeDesktopInfo' => [
'summary' => '查询云电脑的基础信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'title' => '业务渠道, 取值:'."\n"
.'Enterprise:企业版'."\n"
.'Business:商业版',
'type' => 'string',
'enum' => ['Enterprise', 'Business'],
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => '["ecd-gx2x1dhsmucyy****"]'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'NeedExtraInfo',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A1560565'],
'Desktops' => [
'description' => '云电脑基础信息。',
'type' => 'array',
'items' => [
'description' => '云电脑基础信息。',
'type' => 'object',
'properties' => [
'CurrentAppVersion' => ['description' => '云电脑镜像版本号。', 'type' => 'string', 'example' => '1.4.0-R-***'],
'StartTime' => ['description' => '云电脑首次启动时间。', 'type' => 'string', 'example' => '2020-11-06T08:31Z'],
'ConnectionStatus' => [
'description' => '用户的连接状态。',
'type' => 'string',
'enumValueTitles' => ['Connected' => '已连接', 'Disconnected' => '已断开连接'],
'example' => 'Disconnected',
],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
'DesktopStatus' => [
'description' => '云电脑状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已关机', 'Failed' => '创建失败', 'Starting' => '开机中', 'Running' => '运行中', 'Stopping' => '关机中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '创建中'],
'example' => 'Running',
],
'ManagementFlag' => [
'description' => '管理标识。',
'type' => 'array',
'items' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Migrating' => '迁移中', 'Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
],
'NewAppVersion' => ['description' => '云电脑可升级的镜像版本号。', 'type' => 'string', 'example' => '1.6.0-R-***'],
'ReleaseNote' => ['description' => '可升级的镜像版本描述。', 'type' => 'string', 'example' => 'Test upgrade package 03-07'],
'NewAppSize' => ['description' => '升级包大小,单位为KB。', 'type' => 'integer', 'format' => 'int64', 'example' => '568533470'],
'DesktopGroupId' => ['description' => '云电脑池ID。', '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\\": \\"Test upgrade package 03-07\\",\\n \\"NewAppSize\\": 568533470,\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询云电脑基础信息',
'changeSet' => [
['createdAt' => '2025-08-04T10:15:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-05-07T04:24:56.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-04T05:05:07.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopInfo'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeDesktopMetadata' => [
'summary' => '查询全地域的桌面列表及元数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域id。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'SearchRegionId',
'in' => 'query',
'schema' => ['description' => '需要搜索的地域id。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '工作区id。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-778418****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '共享云电脑id。', 'type' => 'string', 'required' => false, 'example' => 'dg-i1ruuudp92qpj****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。最大值:100默认值:10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的token,nexttoken为空表示没有下一个。', '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' => '云电脑创建的时间点。格式为UTC时间格式:'."\n"
.'`yyyy-MM-dd\'T\'HH:mm:ss\'Z\'`。', 'type' => 'string', 'required' => false, 'example' => '2025-01-01T12:00:00Z'],
],
[
'name' => 'OperationTimeStart',
'in' => 'query',
'schema' => ['description' => '云电脑发生操作的开始时间。时间格式:'."\n"
.'`yyyy-MM-dd\'T\'HH:mm:ss\'Z\'`。', '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' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****'],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑ID列表。', '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'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['title' => '终端用户ID', 'description' => '终端用户ID', 'type' => 'string', 'required' => false, 'example' => 'test-user'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的token,nexttoken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求id。', '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' => '华东2(上海)'],
'OfficeSiteId' => ['description' => '工作区id。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'ChargeType' => ['description' => '云桌面的计费类型。可能值:'."\n"
.'- PostPaid:按量付费'."\n"
.'- PrePaid:包年包月', 'type' => 'string', 'example' => 'PostPaid'],
'DesktopName' => ['description' => '云桌面名称。', 'type' => 'string', 'example' => 'testDesktopName'],
'DesktopId' => ['description' => '云桌面id。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
'DesktopGroupId' => ['description' => '共享云电脑id。', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****'],
'RegionId' => ['description' => '地域id。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'StartTime' => ['description' => '云桌面的启动时间。', 'type' => 'string', 'example' => '2020-11-06T08:31Z'],
'DesktopStatus' => ['description' => '云桌面状态。可能值:'."\n"
.'- Stopped(已关机)'."\n"
.'- Starting(启动中)'."\n"
.'- Rebuilding(重建中)'."\n"
.'- Running(运行中)'."\n"
.'- Stopping(停止中)'."\n"
.'- Expired(已过期)'."\n"
.'- Deleted(已删除)'."\n"
.'- Pending(等待中)', 'type' => 'string', 'example' => 'Running'],
'ExpiredTime' => ['description' => '云桌面过期时间。仅计费方式为包年包月的云桌面有该返回值。', 'type' => 'string', 'example' => '2021-12-31T15:59Z'],
'ImageId' => ['description' => '镜像id。', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****'],
'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8'],
'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => 'serverless_new'],
'ManagementFlags' => [
'description' => '云电脑管理状态。',
'type' => 'array',
'items' => ['description' => '管理标识。可能值:'."\n"
."\n"
.'- NoFlag:无状态'."\n"
.'- Updating:升级或更新中'."\n"
.'- Migrating:迁移中'."\n"
.'- UnderMaintenance:维护模式'."\n"
.'- EnterMaintenance:正在进入维护模式'."\n"
.'- Hibernating:休眠中'."\n"
.'- Hibernated:已休眠'."\n"
.'- WakingUp:唤醒中', 'type' => 'string', 'example' => '["NoFlag"]'],
],
'DesktopType' => ['description' => '云桌面规格。', 'type' => 'string', 'example' => 'eds.general.2c8g'],
'MemberEniIp' => ['description' => '实例的成员网卡IP。', 'type' => 'string', 'example' => '192.168.2.1'],
'Platform' => ['description' => '操作系统平台信息。', 'type' => 'string', 'example' => 'Ubuntu'],
'AgentProviderList' => [
'title' => '',
'description' => '当前云电脑支持的Agent。',
'type' => 'array',
'items' => ['description' => '当前云电脑支持的Agent。', 'type' => 'string', 'example' => 'OpenClaw'],
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"LocalName\\": \\"华东2(上海)\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"StartTime\\": \\"2020-11-06T08:31Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"serverless_new\\",\\n \\"ManagementFlags\\": [\\n \\"[\\\\\\"NoFlag\\\\\\"]\\"\\n ],\\n \\"DesktopType\\": \\"eds.general.2c8g\\",\\n \\"MemberEniIp\\": \\"192.168.2.1\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"AgentProviderList\\": [\\n \\"OpenClaw\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询云桌面的元数据',
'description' => '该接口为中心化接口,仅支持上海及新加坡站点查询。',
'changeSet' => [
['createdAt' => '2025-12-27T14:56:15.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopMetadata'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopMetadata',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeDesktopSessions' => [
'summary' => '查询云电脑的详细会话信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'SessionStatus',
'in' => 'query',
'schema' => [
'description' => '会话连接状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Connected' => '已连接', 'Disconnected' => '已断开'],
'example' => 'Connected',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间。', 'type' => 'string', 'required' => false, 'example' => '2023-01-28T02:31:43Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间。', 'type' => 'string', 'required' => false, 'example' => '2023-02-13T02:51:43Z'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****"'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer'],
],
[
'name' => 'SubPayType',
'in' => 'query',
'schema' => [
'description' => '云电脑购买方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['duration' => '时长包 [白名单]', 'postPaid' => '按需购买', 'monthPackage' => '按月购买(120小时/250小时)', 'prePaid' => '按月购买(不限时长)'],
'example' => 'monthPackage',
],
],
[
'name' => 'CheckOsSession',
'in' => 'query',
'schema' => ['description' => '检查云电脑内会话状态的开关。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'EndUserIdFilter',
'in' => 'query',
'schema' => ['description' => '终端用户ID。与参数`EndUserId`相同,两者只需要传入一个即可。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FillHardwareInfo',
'in' => 'query',
'schema' => ['title' => '是否增加终端信息返回。', 'description' => '是否增加终端信息返回。', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '返回信息的语言类型。', 'description' => '返回信息的语言类型。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3EC4A6DB-EC8D-55B0-9038-543DE671****'],
'Sessions' => [
'description' => '会话详情。',
'type' => 'array',
'items' => [
'description' => '会话详情。',
'type' => 'object',
'properties' => [
'SessionStatus' => [
'description' => '会话连接状态。',
'type' => 'string',
'enumValueTitles' => ['Connected' => '已连接', 'Disconnected' => '已断开'],
'example' => 'Connected',
],
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'alice'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****'],
'ClientIp' => ['description' => '客户端IP。', 'type' => 'string', 'example' => '172.21.XX.XX'],
'ClientOS' => ['description' => '客户端操作系统。', 'type' => 'string', 'example' => 'windows_\\"Windows10Enterprise\\"10.0(Build22000)'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'TestOfficeSite'],
'ClientVersion' => ['description' => '客户端版本。', 'type' => 'string', 'example' => '2.0.0-R-20221030.08****'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'LatestConnectionTime' => ['description' => '最近一次连接云电脑的时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalConnectionTime' => ['description' => '总连接时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '240'],
'SessionStartTime' => ['description' => '会话的开始时间。', 'type' => 'string', 'example' => '2023-01-28T02:31:43Z'."\n"],
'SessionEndTime' => ['description' => '会话的结束时间。', 'type' => 'string', 'example' => '2023-01-28T02:31:43Z'],
'SessionIdleTime' => ['description' => '会话空闲时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'EndUserApplyCoordinateTime' => ['description' => '终端用户远程协助时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'SubPayType' => [
'description' => '云电脑购买方式。',
'type' => 'string',
'enumValueTitles' => ['duration' => '时长包 [白名单]', 'postPaid' => '按需购买', 'monthPackage' => '按月购买(120小时/250小时)', 'prePaid' => '按月购买(不限时长)'],
'example' => 'monthPackage',
],
'OsSessionStatus' => ['description' => '检查云电脑内会话状态的开关。', 'type' => 'string', 'example' => 'true'],
'TerminalInfo' => [
'title' => '终端设备信息描述。',
'description' => '终端设备信息描述。',
'type' => 'object',
'properties' => [
'ProductName' => ['title' => '终端设备类型。', 'description' => '终端设备类型。', 'type' => 'string', 'example' => 'Mac'],
'SerialNumber' => ['title' => '终端设备序列号。', 'description' => '终端设备序列号。', 'type' => 'string', 'example' => '96c530bc-6095-4014-8bbc-d461b8ac****'],
'Model' => ['title' => '终端设备信息。', 'description' => '终端设备信息。', 'type' => 'string', 'example' => 'Mac'],
'Uuid' => ['title' => '登录设备的UUID。', 'description' => '登录设备的UUID。', 'type' => 'string', 'example' => 'EBFDC7773BEBAD418A9F89429652****'],
],
],
'DirectoryType' => ['title' => '办公网络类型', 'description' => '办公网络类型', 'type' => 'string', 'example' => 'SIMPLE'],
'AccountType' => ['title' => '账号类型', 'description' => '账号类型', 'type' => 'string', 'example' => 'SIMPLE'],
'ResourceGroups' => [
'title' => '资源组信息',
'description' => '资源组信息',
'type' => 'array',
'items' => [
'title' => '资源组',
'description' => '资源组',
'type' => 'object',
'properties' => [
'Id' => ['title' => '资源组ID', 'description' => '资源组ID', 'type' => 'string', 'example' => 'rg-8whrmo2gtsb8bxxxx'],
'Name' => ['title' => '资源组名称', 'description' => '资源组名称', 'type' => 'string', 'example' => 'RgTest'],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询云电脑会话详情',
'description' => '当前仅支持查询30天以内的数据。',
'responseParamsDescription' => 'SessionIdleTime仅当云电脑操作系统为Windows时返回。',
'changeSet' => [
['createdAt' => '2025-10-17T12:21:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-09-15T04:00:29.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-07-07T05:42:57.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-12-09T12:03:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-21T01:35:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-08T12:43:40.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-07-01T02:32:29.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-04-15T06:38:40.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopSessions'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"3EC4A6DB-EC8D-55B0-9038-543DE671****\\",\\n \\"Sessions\\": [\\n {\\n \\"SessionStatus\\": \\"Connected\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"ClientIp\\": \\"172.21.XX.XX\\",\\n \\"ClientOS\\": \\"windows_\\\\\\\\\\\\\\"Windows10Enterprise\\\\\\\\\\\\\\"10.0(Build22000)\\",\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ClientVersion\\": \\"2.0.0-R-20221030.08****\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"SessionStartTime\\": \\"2023-01-28T02:31:43Z\\\\n\\",\\n \\"SessionEndTime\\": \\"2023-01-28T02:31:43Z\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OsType\\": \\"Windows\\",\\n \\"EndUserApplyCoordinateTime\\": 120,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"OsSessionStatus\\": \\"true\\",\\n \\"TerminalInfo\\": {\\n \\"ProductName\\": \\"Mac\\",\\n \\"SerialNumber\\": \\"96c530bc-6095-4014-8bbc-d461b8ac****\\",\\n \\"Model\\": \\"Mac\\",\\n \\"Uuid\\": \\"EBFDC7773BEBAD418A9F89429652****\\"\\n },\\n \\"DirectoryType\\": \\"SIMPLE\\",\\n \\"AccountType\\": \\"SIMPLE\\",\\n \\"ResourceGroups\\": [\\n {\\n \\"Id\\": \\"rg-8whrmo2gtsb8bxxxx\\",\\n \\"Name\\": \\"RgTest\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeDesktopTypes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => ['Enterprise', 'Business', 'Lincore_team'],
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopTypeId',
'in' => 'query',
'schema' => [
'description' => '规格ID。'."\n"
."\n"
.'> 当`InstanceTypeFamily`和`DesktopTypeId`参数的取值均为空时,将查询云电脑所有规格的信息。',
'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' => '规格族名称。'."\n"
."\n"
.'> 当`InstanceTypeFamily`和`DesktopTypeId`参数的取值均为空时,将查询云电脑所有规格的信息。',
'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' => 'vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'MemorySize',
'in' => 'query',
'schema' => ['description' => '内存大小。单位为MiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4096'],
],
[
'name' => 'GpuCount',
'in' => 'query',
'schema' => ['description' => 'GPU核数。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1'],
],
[
'name' => 'DesktopIdForModify',
'in' => 'query',
'schema' => ['description' => '变配时传入需要变配的云电脑ID,返回值会增加规格与云电脑之间是否兼容的信息。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '订单类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DOWNGRADE' => '降级配置', 'UPGRADE' => '升级配置'],
'example' => 'DOWNGRADE',
],
],
[
'name' => 'AppliedScope',
'in' => 'query',
'schema' => [
'description' => '规格适用范围。默认值:`Public`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Public' => 'Public', 'SavingPlan' => 'SavingPlan'],
'example' => 'Public',
],
],
[
'name' => 'DesktopGroupIdForModify',
'in' => 'query',
'schema' => ['description' => '变配时传入需要变配的共享型云电脑ID,返回值会增加规格与共享型云电脑之间是否兼容的信息。', 'type' => 'string', 'required' => false, 'example' => 'dg-abcdefg****'],
],
[
'name' => 'GpuDriverType',
'in' => 'query',
'schema' => [
'description' => 'GPU驱动类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['T4' => 'T4', 'A10' => 'A10', 'G28' => 'G28', 'G39' => 'G39'],
'example' => 'A10',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序字段,若不指定则按照创建时间倒序排列。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Memory' => '按照内存大小排序', 'Cpu' => '按照CPU核数排序'],
'example' => 'Memory',
],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => [
'description' => '排序方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ASC' => '升序 [默认值]', 'DESC' => '降序'],
'example' => 'ASC',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '规格的售卖方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['MonthPackage' => '按月包购买', 'FastBuy' => '快速购买'],
'example' => 'FastBuy',
],
],
[
'name' => 'DesktopTypeIdList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '规格ID列表。',
'type' => 'array',
'items' => ['description' => '规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise.4c8g'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'SupportMinSessionCount',
'in' => 'query',
'schema' => ['description' => '查询规则支持的多会话数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '> 该参数未对外开放使用。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
[
'name' => 'GpuMemory',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
],
[
'name' => 'ScopeSet',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'maxItems' => 100,
'description' => '',
],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'DesktopScenario',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'DesktopTypes' => [
'description' => '规格的详细信息。',
'type' => 'array',
'items' => [
'description' => '规格的详细信息。',
'type' => 'object',
'properties' => [
'SystemDiskSize' => ['description' => '系统盘大小。单位:GiB。', 'type' => 'string', 'example' => '150'],
'DesktopTypeId' => ['description' => '规格ID。', 'type' => 'string', 'example' => 'ecd.graphics.xlarge'],
'DataDiskSize' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'string', 'example' => '150'],
'CpuCount' => ['description' => 'vCPU数量。', 'type' => 'string', 'example' => '2'],
'GpuCount' => ['description' => 'GPU核数。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'GpuSpec' => ['description' => 'GPU显存。', 'type' => 'string', 'example' => '16 GiB'],
'InstanceTypeFamily' => ['description' => '规格族。', 'type' => 'string', 'example' => 'ecd.graphics'],
'MemorySize' => ['description' => '内存大小。单位:MiB。', 'type' => 'string', 'example' => '23552'],
'DesktopTypeStatus' => ['description' => '规格状态。返回`SUFFICIENT`时表示该规格资源充足。', 'type' => 'string', 'example' => 'SUFFICIENT'],
'Scopes' => [
'description' => '规格售卖方式列表。',
'type' => 'array',
'items' => [
'description' => '规格的售卖方式。',
'type' => 'string',
'enumValueTitles' => ['MonthPackage' => '按月包购买', 'FastBuy' => '快速购买'],
'example' => 'FastBuy',
],
],
'StockState' => [
'description' => '库存状态。',
'type' => 'string',
'enumValueTitles' => ['Insufficient' => '无库存', 'Sufficient' => '库存充足'],
'example' => 'Sufficient',
],
'GpuMemory' => ['description' => '显存大小。对于GPU型云电脑,该返回值有实际意义。单位:MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'],
'MaxSessionCount' => ['description' => '当前规格支持的多会话数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Description' => ['type' => 'string', 'description' => ''],
'EnvType' => ['type' => 'string'],
'EnvId' => ['type' => 'string'],
],
],
],
],
],
],
],
'title' => '查询云电脑规格详细信息',
'summary' => '查询云电脑规格的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-12-27T14:56:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-06-10T08:12:56.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-25T03:26:19.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-01-24T01:26:14.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-11-09T02:21:46.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-07-19T04:01:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-08-01T01:51:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-05-31T07:06:27.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-16T06:34:36.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopTypes'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopTypes\\": [\\n {\\n \\"SystemDiskSize\\": \\"150\\",\\n \\"DesktopTypeId\\": \\"ecd.graphics.xlarge\\",\\n \\"DataDiskSize\\": \\"150\\",\\n \\"CpuCount\\": \\"2\\",\\n \\"GpuCount\\": 1,\\n \\"GpuSpec\\": \\"16 GiB\\",\\n \\"InstanceTypeFamily\\": \\"ecd.graphics\\",\\n \\"MemorySize\\": \\"23552\\",\\n \\"DesktopTypeStatus\\": \\"SUFFICIENT\\",\\n \\"Scopes\\": [\\n \\"FastBuy\\"\\n ],\\n \\"StockState\\": \\"Sufficient\\",\\n \\"GpuMemory\\": 2048,\\n \\"MaxSessionCount\\": 4,\\n \\"Description\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\nFE1810C7-09DA-4224-A8DC-5110954FD47F\\n\\n 95232\\n 24\\n eds.graphics.24c1t4\\n 150\\n eds.graphics\\n 16 GiB\\n 1\\n 150\\n\\n\\n 63488\\n 16\\n eds.graphics.16c1t4\\n 150\\n eds.graphics\\n 16 GiB\\n \\n 150\\n 150\\n \\n 1\\n 150\\n\\n\\n 24576\\n 12\\n eds.hf.12c24g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 16384\\n 8\\n eds.hf.8c16g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 8192\\n 4\\n eds.hf.4c8g\\n 80\\n eds.hf\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n\\n 32768\\n 16\\n eds.general.16c32g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 32768\\n 8\\n eds.general.8c32g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 16384\\n 8\\n eds.general.8c16g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 16384\\n 4\\n eds.general.4c16g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 8192\\n 4\\n eds.general.4c8g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 8192\\n 2\\n eds.general.2c8g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 4096\\n 2\\n eds.general.2c4g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 2048\\n 2\\n eds.general.2c2g\\n 80\\n eds.general\\n \\n 80\\n 50\\n \\n \\n 80\\n 100\\n \\n 0\\n 20\\n\\n\\n 47104\\n 10\\n ecd.graphics.2xlarge\\n 150\\n ecd.graphics\\n 8 GiB\\n \\n 150\\n 150\\n \\n 0.5\\n 150\\n\\n\\n 23552\\n 4\\n ecd.graphics.xlarge\\n 150\\n ecd.graphics\\n 4 GiB\\n \\n 150\\n 150\\n \\n 0.25\\n 150\\n\\n\\n 32768\\n 8\\n ecd.performance.2xlarge\\n 150\\n ecd.performance\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 150\\n\\n\\n 16384\\n 4\\n ecd.advanced.xlarge\\n 150\\n ecd.advanced\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 150\\n\\n\\n 8192\\n 2\\n ecd.advanced.large\\n 80\\n ecd.advanced\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 70\\n\\n\\n 4096\\n 2\\n ecd.basic.large\\n 80\\n ecd.basic\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 70\\n\\n\\n 2048\\n 1\\n ecd.basic.small\\n 80\\n ecd.basic\\n \\n 80\\n 20\\n \\n \\n 80\\n 70\\n \\n \\n 150\\n 100\\n \\n \\n 150\\n 150\\n \\n 0\\n 20\\n\\n","errorExample":""}]',
],
'DescribeDesktops' => [
'summary' => '查询云电脑的详细信息。',
'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' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'title' => '业务渠道, 取值:'."\n"
.'Enterprise:企业版'."\n"
.'Business:商业版',
'type' => 'string',
'enum' => ['Enterprise', 'Business'],
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '云电脑池ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5****'],
],
[
'name' => 'DesktopStatus',
'in' => 'query',
'schema' => [
'description' => '云电脑状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Running',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => ['description' => '用户名称。', 'type' => 'string', 'required' => false, 'example' => 'Alice'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '目录ID。同办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '云电脑的计费方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费 [默认值]', 'PrePaid' => '包年包月'],
'example' => 'PostPaid',
],
],
[
'name' => 'ExpiredTime',
'in' => 'query',
'schema' => ['description' => '包年包月云电脑的到期时间。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59:59Z'],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议 [推荐]'],
'example' => 'ASP',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => false,
'example' => 'ecd-gx2x1dhsmucyy****',
'maxItems' => 100,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑的授权用户列表。可设置1~100个。'."\n"
."\n"
.'> 在同一时段内,只有一个用户可以连接和使用该云电脑。',
'type' => 'array',
'items' => ['description' => '云电脑的授权用户。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'example' => 'alice',
'maxItems' => 100,
],
],
[
'name' => 'ExcludedEndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要排除的云电脑授权用户列表。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '要排除的云电脑授权用户。', 'type' => 'string', 'required' => false, 'example' => 'andy'],
'required' => false,
'example' => 'andy',
'maxItems' => 50,
],
],
[
'name' => 'FilterDesktopGroup',
'in' => 'query',
'schema' => [
'description' => '是否排除池化云电脑(云电脑池中的云电脑)。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '排除池化云电脑 [默认值]', 'false' => '不排除池化云电脑'],
'example' => 'false',
],
],
[
'name' => 'ManagementFlag',
'in' => 'query',
'schema' => [
'description' => '管理标识。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Migrating' => '迁移中', 'Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
],
[
'name' => 'QueryFotaUpdate',
'in' => 'query',
'schema' => [
'description' => '是否查询云电脑镜像版本信息。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '查询云电脑镜像升级信息', 'false' => '不查询云电脑镜像升级信息 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。一个标签由一对键值对组成,用于标记资源。您可以使用标签来分组管理云电脑,便于搜索和批量操作,详情参见[使用标签管理云电脑](~~203781~~)。',
'type' => 'array',
'items' => [
'description' => '标签键值对。可为每台云电脑设置1~20个键值对,一个标签键只能对应一个标签值。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。如果传入`Tag`,则`Key`是必填的。不可超过128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或者`https://`,也不能仅包含空格。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。不可超过128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'SnapshotPolicyId',
'in' => 'query',
'schema' => ['description' => '快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-hb12mclyne09xw***'],
],
[
'name' => 'OnlyDesktopGroup',
'in' => 'query',
'schema' => ['description' => '是否只查询池化云电脑(云电脑池中的云电脑)。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑池ID。如果传入了`DesktopId`,则忽略该`DesktopGroupId`;如果`DesktopId`为空,则会根据`DesktopGroupId`去获取该云电脑池内所有云电脑的`DesktopId`。', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'OsTypes',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '操作系统类型。',
'type' => 'array',
'items' => [
'description' => '操作系统类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['description' => '云电脑规格。您可以调用[DescribeDesktopTypes](~~188882~~)查询云电脑支持的规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.general.2c8g'],
],
[
'name' => 'ImageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID列表。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-2g65ljy3ynrdq****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DesktopStatusList',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => '云电脑状态列表。',
'type' => 'array',
'items' => [
'description' => '云电脑状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Stopped',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'GpuInstanceGroupId',
'in' => 'query',
'schema' => ['description' => '弹性显卡池ID。', 'type' => 'string', 'required' => false, 'example' => 'gp-0bm2iz1v6m6nx****'],
],
[
'name' => 'QosRuleId',
'in' => 'query',
'schema' => ['description' => '公网限速规则ID。', 'type' => 'string', 'required' => false, 'example' => 'qos-5605u0gelk200****'],
],
[
'name' => 'SubPayType',
'in' => 'query',
'schema' => [
'description' => '云电脑购买方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['duration' => '时长包 [白名单]', 'postPaid' => '按需购买', 'monthPackage' => '按月购买(120小时/250小时)', 'prePaid' => '按月购买(不限时长)'],
'example' => 'monthPackage',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '企业资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4hsvzbbmqdzu3s****'],
],
[
'name' => 'FillResourceGroup',
'in' => 'query',
'schema' => ['description' => '是否查询企业资源组信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'MultiResource',
'in' => 'query',
'schema' => ['description' => '是否有多个资源。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'IncludeAutoSnapshotPolicy',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C'],
'TotalCount' => ['description' => '云电脑总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Desktops' => [
'description' => '云电脑详细信息。',
'type' => 'array',
'items' => [
'description' => '云电脑详细信息。',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => '云电脑创建时间。', 'type' => 'string', 'example' => '2020-11-06T08:28Z'],
'ChargeType' => [
'description' => '云电脑的计费方式。',
'type' => 'string',
'enumValueTitles' => ['PostPaid' => '按量付费 [默认值]', 'PrePaid' => '包年包月'],
'example' => 'PostPaid',
],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer01'],
'PolicyGroupName' => ['description' => '策略名称。', 'type' => 'string', 'example' => 'All enabled policy'],
'SystemDiskSize' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'PolicyGroupId' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'system-all-enabled-policy'],
'DesktopStatus' => ['description' => '云电脑状态。', 'type' => 'string', 'example' => 'Running'],
'DesktopType' => ['description' => '云电脑规格。', 'type' => 'string', 'example' => 'ecd.basic.large'],
'GpuCount' => ['description' => 'GPU数量。', 'type' => 'number', 'format' => 'float', 'example' => '1'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'Memory' => ['description' => '内存大小。单位:MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'],
'GpuSpec' => ['description' => 'GPU规格。', 'type' => 'string', 'example' => 'NVIDIA T4'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****'],
'DirectoryId' => ['description' => '目录ID,同办公网络ID(OfficeSiteId)。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'ManagementFlag' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Migrating' => '迁移中', 'Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
'DataDiskCategory' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'string', 'example' => 'null'],
'SystemDiskCategory' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'string', 'example' => 'null'],
'NetworkInterfaceId' => ['description' => '云电脑服务在RAM或AD用户下创建的辅助网卡ID,不可修改。', 'type' => 'string', 'example' => '123456'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'DataDiskSize' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'string', 'example' => 'null'],
'DesktopGroupId' => ['description' => '云电脑所属的云电脑池ID。默认为`null`。', 'type' => 'string', 'example' => 'null'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'default'],
'StartTime' => ['description' => '云电脑首次启动时间。', 'type' => 'string', 'example' => '2020-11-06T08:31Z'],
'DirectoryType' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'string', 'example' => 'SIMPLE'],
'Cpu' => ['description' => 'vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'NetworkInterfaceIp' => ['description' => '云电脑服务在RAM或AD用户下创建的辅助网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'],
'ExpiredTime' => ['description' => '包年包月云电脑的到期时间。', 'type' => 'string', 'example' => '2021-12-31T15:59Z'],
'OsType' => ['description' => '操作系统类型。', 'type' => 'string', 'example' => 'Windows'],
'ConnectionStatus' => [
'description' => '用户的连接状态。',
'type' => 'string',
'enumValueTitles' => ['Unknown' => '未知', 'Connected' => '已连接', 'Disconnected' => '已断开连接'],
'example' => 'Disconnected',
],
'BundleId' => ['description' => '云电脑使用的云电脑模板ID。', 'type' => 'string', 'example' => 'b-2g65ljy4291vl****'],
'BundleName' => ['description' => '云电脑使用的云电脑模板名称。', 'type' => 'string', 'example' => 'TemplateName'],
'OfficeSiteType' => [
'description' => '办公网络的账号系统类型。',
'type' => 'string',
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'SIMPLE',
],
'HostName' => ['description' => '主机名称。', 'type' => 'string', 'example' => 'testName'],
'Disks' => [
'description' => '磁盘信息。',
'type' => 'array',
'items' => [
'description' => '磁盘信息。',
'type' => 'object',
'properties' => [
'DiskType' => [
'description' => '磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'],
'example' => 'SYSTEM',
],
'DiskId' => ['description' => '磁盘ID。', 'type' => 'string', 'example' => 'd-jedbpr4sl9l37****'],
'DiskSize' => ['description' => '磁盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'PerformanceLevel' => [
'description' => '当磁盘采用ESSD云盘时,ESSD云盘的性能等级。'."\n"
."\n"
.'关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。',
'type' => 'string',
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL0',
],
'DiskCategory' => [
'description' => '磁盘类型。'."\n"
.'- cloud_efficiency(高效云盘)'."\n"
.' - cloud_auto(极速云盘)'."\n"
.' - cloud_essd(增强型SSD云盘,仅部分规格支持)',
'type' => 'string',
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_auto' => '极速云盘', 'cloud_essd' => '增强型SSD云盘,仅部分规格支持'],
'example' => 'cloud_auto',
],
],
],
],
'Tags' => [
'description' => '标签信息。',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'],
],
],
],
'Sessions' => [
'description' => '云电脑用户会话信息。',
'type' => 'array',
'items' => [
'description' => '云电脑用户会话信息。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '连接云电脑的用户ID。', 'type' => 'string', 'example' => '29615820929547****'],
'EstablishmentTime' => ['description' => '云电脑会话连接的时间。', 'type' => 'string', 'example' => '2021-03-07T08:23Z'],
'ExternalUserName' => ['description' => '外部用户名称。', 'type' => 'string', 'example' => 'Testname'],
],
],
],
'EndUserIds' => [
'description' => '云电脑的授权用户ID。',
'type' => 'array',
'items' => ['description' => '云电脑的授权用户ID。', 'type' => 'string', 'example' => 'alice'],
],
'DowngradeQuota' => ['description' => '可以降配的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'DowngradedTimes' => ['description' => '已经降配的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'GpuCategory' => ['description' => '是否为GPU云电脑。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'GpuDriverVersion' => ['description' => '云电脑的GPU驱动版本号。', 'type' => 'string', 'example' => 'null'],
'ZoneType' => ['description' => '查询可用区的类型。默认取值为`AvailabilityZone`,即普通云上可用区。', 'type' => 'string', 'example' => 'AvailabilityZone'],
'FotaUpdate' => [
'description' => '云电脑的镜像版本信息。',
'type' => 'object',
'properties' => [
'CurrentAppVersion' => ['description' => '云电脑当前镜像的版本号。', 'type' => 'string', 'example' => '0.0.0-D-20220102.000000'],
'NewAppVersion' => ['description' => '云电脑可升级的镜像版本号。', 'type' => 'string', 'example' => '0.0.0-R-20220307.190736'],
'ReleaseNote' => ['description' => '可升级镜像的版本描述。', 'type' => 'string', 'example' => '测试升级包03-07'],
'Size' => ['description' => '可升级的版本安装包大小。单位:KB。', 'type' => 'integer', 'format' => 'int64', 'example' => '108815097'],
'ReleaseNoteEn' => ['description' => '可升级的版本英文描述。', 'type' => 'string', 'example' => 'What\'s new'],
'ReleaseNoteJp' => ['description' => '可升级的版本日文描述。', 'type' => 'string', 'example' => 'リリースノート'],
],
],
'Progress' => ['description' => '云电脑的创建进度。', 'type' => 'string', 'example' => '100%'],
'VolumeEncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
'OfficeSiteVpcType' => [
'description' => '办公网络VPC类型。',
'type' => 'string',
'enumValueTitles' => ['standard' => '标准型', 'customized' => '定制型', 'basic' => '基础型'],
'example' => 'basic',
],
'Platform' => [
'description' => '操作系统平台信息。',
'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' => '会话类型。',
'type' => 'string',
'enumValueTitles' => ['SINGLE_SESSION' => '单会话', 'MULTIPLE_SESSION' => '多会话'],
'example' => 'SINGLE_SESSION',
],
'ManagementFlags' => [
'description' => '管理标识。',
'type' => 'array',
'items' => [
'description' => '云电脑管理状态。',
'type' => 'string',
'enumValueTitles' => ['Migrating' => '办公网络迁移中', 'Hibernated' => '已休眠', 'UnderMaintenance' => '维护模式中', 'MigratingProtocol' => '协议迁移中', 'EnterMaintenance' => '进入维护模式中', 'WakingUp' => '唤醒中', 'Updating' => '升级中', 'NoFlag' => '无状态', 'Assigning' => '分配用户中', 'Hibernating' => '休眠中'],
'example' => '["NoFlag"]',
],
],
'SnapshotPolicyId' => ['title' => '快照策略ID', 'description' => '快照策略ID。', 'type' => 'string', 'example' => 'sp-gi007jgyc3kce****'],
'SnapshotPolicyName' => ['title' => '快照策略名称', 'description' => '快照策略名称。', 'type' => 'string', 'example' => 'testSnapshotName'],
'BindAmount' => ['description' => '多会话云电脑池中,每台云电脑允许的并发会话数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'PolicyGroupIdList' => [
'description' => '云电脑策略ID集合。',
'type' => 'array',
'items' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'pg-dasffjkdf*****'],
],
'PolicyGroupNameList' => [
'description' => '云电脑策略名称列表。',
'type' => 'array',
'items' => ['description' => '云电脑策略名称。', 'type' => 'string', 'example' => '测试策略01'],
'example' => 'Test policy 01',
],
'HibernationOptionsConfigured' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'boolean', 'example' => 'true'],
'SupportHibernation' => ['description' => '是否支持休眠。', 'type' => 'boolean', 'example' => 'true'],
'HibernationBeta' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'boolean', 'example' => 'true'],
'DesktopDurationList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PackageId' => ['type' => 'string', 'description' => ''],
'PackageCreationTime' => ['type' => 'string', 'description' => ''],
'PackageExpiredTime' => ['type' => 'string', 'description' => ''],
'UsedDuration' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'TotalDuration' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
'PackageStatus' => ['type' => 'string', 'description' => ''],
'PackageType' => ['type' => 'string', 'description' => ''],
'PeriodStartTime' => ['type' => 'string', 'description' => ''],
'PeriodEndTime' => ['type' => 'string', 'description' => ''],
'PostPaidLimitFee' => ['type' => 'number', 'format' => 'float', 'description' => ''],
'PackageUsedUpStrategy' => ['type' => 'string', 'description' => ''],
'OrderInstanceId' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
'ResourceGroups' => [
'description' => '企业资源组信息列表。',
'type' => 'array',
'items' => [
'description' => '企业资源组信息。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '企业资源组名称。', 'type' => 'string', 'example' => 'Resource group 01'],
'Id' => ['description' => '企业资源组ID。', 'type' => 'string', 'example' => 'rg-4hsvzbbmqdzu3s****'],
],
],
],
'StandardStartTime' => ['type' => 'string', 'description' => ''],
'OsUpdate' => [
'type' => 'object',
'properties' => [
'CheckId' => ['type' => 'string', 'description' => ''],
'PackageCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'Packages' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Kb' => ['type' => 'string', 'description' => ''],
'Title' => ['type' => 'string', 'description' => ''],
'Description' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
],
'description' => '',
],
'IsLdap' => ['type' => 'boolean', 'description' => ''],
'DomainType' => ['type' => 'string', 'description' => ''],
'SerialNumber' => ['type' => 'string', 'description' => ''],
'AccountType' => ['type' => 'string', 'description' => ''],
'EntraDomainName' => ['type' => 'string', 'description' => ''],
'EnvType' => ['type' => 'string'],
'EnvId' => ['type' => 'string'],
'AgentProviderList' => [
'title' => '当前云电脑支持的Agent列表。',
'type' => 'array',
'items' => ['title' => '当前云电脑支持的Agent。', 'type' => 'string'],
],
],
],
],
'PageNumber' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页查询时,每页最大行数。', '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\\": \\"Resource group 01\\",\\n \\"Id\\": \\"rg-4hsvzbbmqdzu3s****\\"\\n }\\n ],\\n \\"StandardStartTime\\": \\"\\",\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"\\",\\n \\"PackageCount\\": 0,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Description\\": \\"\\"\\n }\\n ]\\n },\\n \\"IsLdap\\": true,\\n \\"DomainType\\": \\"\\",\\n \\"SerialNumber\\": \\"\\",\\n \\"AccountType\\": \\"\\",\\n \\"EntraDomainName\\": \\"\\",\\n \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\",\\n \\"AgentProviderList\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n 1\\n \\n 2020-11-06T08:28Z\\n PostPaid\\n testDesktopName\\n test\\n 0\\n system-all-enabled-policy\\n Running\\n ecd.basic.large\\n 1\\n HDX\\n 4096\\n NVIDIA T4\\n m-4zfb6zj728hhr****\\n cn-hangzhou+dir-363353****\\n NoFlag\\n null\\n null\\n 123456\\n cn-hangzhou+dir-363353****\\n null\\n null\\n ecd-gx2x1dhsmucyy****\\n test\\n SIMPLE\\n basic\\n 2020-11-06T08:31Z\\n 2\\n 192.168.74.165\\n 2021-12-31T15:59Z\\n Windows\\n Disconnected\\n b-2g65ljy4291vl****\\n Name\\n SIMPLE\\n testName\\n \\n SYSTEM\\n d-jedbpr4sl9l37****\\n 80\\n PL0\\n \\n \\n TestKey\\n TestValue\\n \\n \\n 29615820929547****\\n 2021-03-07T08:23Z\\n Testname\\n \\n Alice\\n 3\\n 0\\n 0\\n null\\n AvailabilityZone\\n \\n t-bp198jigq7l0h5ac****\\n 0.0.0-D-20220102.000000\\n 0.0.0-R-20220307.190736\\n 测试升级包03-07\\n 108815097\\n \\n \\n Ubuntu\\n \\n","errorExample":""}]',
'title' => '查询云电脑详细信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-09-29T08:05:30.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-07-28T03:28:45.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-21T07:30:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-13T10:28:27.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-02-17T12:02:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-24T02:43:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-29T05:29:15.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-07-04T13:58:35.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-06-17T11:57:07.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-22T09:14:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-11T08:23:17.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-08-29T02:24:30.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-07-19T09:17:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-07-03T09:44:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-05-18T06:09:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-05-06T07:41:37.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
['createdAt' => '2023-03-17T06:52:32.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-10-14T02:36:03.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:52:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-04T09:33:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-07T06:26:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-20T03:48:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-09-26T03:59:24.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeDesktopsInGroup' => [
'summary' => '按付费类型查询共享型云电脑包含的云电脑列表。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '付费类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
.'- 默认值:10。'."\n"
.'- 最大值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'IgnoreDeleted',
'in' => 'query',
'schema' => [
'description' => '是否忽略删除标志位。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '忽略删除标志位,意味着展示删除的云电脑 [默认值]', 'false' => '不忽略删除标志位,意味着不展示删除的云电脑'],
'example' => 'true',
],
],
[
'name' => 'CustomStartTimePeriod',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
[
'name' => 'CustomEndTimePeriod',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'PostPaidDesktopsCount' => ['description' => '按量付费云电脑总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'PaidDesktopsCount' => ['description' => '包年包月云电脑总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'PostPaidDesktopsTotalAmount' => ['description' => '按量付费云电脑的账单总额。', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
'PaidDesktops' => [
'description' => '包年包月云电脑列表。',
'type' => 'array',
'items' => [
'description' => '包年包月云电脑对象。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '授权用户。', 'type' => 'string', 'example' => 'alice'],
'DesktopStatus' => [
'description' => '云电脑状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Running',
],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
'ConnectionStatus' => [
'description' => '连接状态。',
'type' => 'string',
'enumValueTitles' => ['Unknown' => '未知', 'Connected' => '已连接', 'Disconnected' => '断开连接'],
'example' => 'Connected',
],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ud-7ftf5b6yu77b0****'],
'EndUserName' => ['description' => '授权用户名。', 'type' => 'string', 'example' => 'alice'],
'ManagementFlag' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
'EndUserIds' => [
'description' => '当前连接用户ID列表,如果未连接状态则为空。',
'type' => 'array',
'items' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'alice'],
],
'EndUserNames' => [
'description' => '当前用户名列表,如果未连接状态则为空。',
'type' => 'array',
'items' => ['description' => '用户名称。', 'type' => 'string', 'example' => 'alice'],
],
'ResetTime' => ['description' => '云电脑的重置时间。', 'type' => 'string', 'example' => '2021-03-03 08:48:08'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-hn5v2mmk0****'],
'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'Win10_ZC'],
'SystemDiskSize' => ['description' => '系统盘大小,单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'GpuDriverVersion' => ['description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '1.0'],
'DiskType' => [
'description' => '磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'],
'example' => 'SYSTEM',
],
'ManagementFlags' => [
'description' => '管理标识列表。',
'type' => 'array',
'items' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
],
'MemberEniIp' => ['description' => '实例的成员网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'],
'PrimaryEniIp' => ['description' => '实例的主网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'FotaVersion' => ['description' => '镜像版本信息。', 'type' => 'string', 'example' => '0.1.0-R-20220914.17****'],
'ExpiredTime' => ['type' => 'string', 'description' => ''],
],
],
],
'PostPaidDesktops' => [
'description' => '按量付费云电脑列表。',
'type' => 'array',
'items' => [
'description' => '按量付费云电脑对象。',
'type' => 'object',
'properties' => [
'CreateDuration' => ['description' => '保留时长。单位:毫秒。', 'type' => 'string', 'example' => '4153958447'],
'EndUserId' => ['description' => '授权用户。', 'type' => 'string', 'example' => 'alice'],
'DesktopStatus' => [
'description' => '云电脑状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Stopped',
],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-01-21T06:34:57Z'],
'ReleaseTime' => ['description' => '释放时间。', 'type' => 'string', 'example' => '2022-01-21T16:34:57Z'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
'ConnectionStatus' => [
'description' => '连接状态。',
'type' => 'string',
'enumValueTitles' => ['Unknown' => '未知', 'Connected' => '已连接', 'Disconnected' => '已断开连接'],
'example' => 'Connected',
],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ud-2i8qxpv6t1a07****'],
'EndUserName' => ['description' => '授权用户名。', 'type' => 'string', 'example' => 'alice'],
'ManagementFlag' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
'EndUserIds' => [
'description' => '当前连接用户ID列表,如果未连接状态则为空。',
'type' => 'array',
'items' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'alice'],
],
'EndUserNames' => [
'description' => '当前用户名列表,如果未连接状态则为空。',
'type' => 'array',
'items' => ['description' => '用户名称。', 'type' => 'string', 'example' => 'alice'],
],
'ResetTime' => ['description' => '云电脑的重置时间。', 'type' => 'string', 'example' => '2021-03-03 08:48:08'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-hn5v2mmk0****'],
'ImageName' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'Win10_ZC'],
'SystemDiskSize' => ['description' => '系统盘大小,单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
'GpuDriverVersion' => ['description' => 'GPU驱动版本。', 'type' => 'string', 'example' => '1.0'],
'DiskType' => [
'description' => '磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'],
'example' => 'SYSTEM',
],
'ManagementFlags' => [
'description' => '管理标识集合。',
'type' => 'array',
'items' => [
'description' => '管理标识。',
'type' => 'string',
'enumValueTitles' => ['Updating' => '变配中', 'NoFlag' => '无标识'],
'example' => 'NoFlag',
],
],
'MemberEniIp' => ['description' => '实例的成员网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'],
'PrimaryEniIp' => ['description' => '实例的主网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'HDX',
],
'FotaVersion' => ['description' => '镜像版本信息。', 'type' => 'string', 'example' => '0.1.0-R-20220914.17****'],
],
],
],
'OnlinePrePaidDesktopsCount' => ['description' => '已连接的包年包月云电脑的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'RunningPrePaidDesktopsCount' => ['description' => '运行中的包年包月云电脑的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'StopedPrePaidDesktopsCount' => ['description' => '已停止的包年包月云电脑的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'StoppedPrePaidDesktopsCount' => ['description' => '已停止的包年包月云电脑的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
'title' => '查询共享型云电脑内的云电脑',
'changeSet' => [
['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-02-27T02:51:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-06-19T11:39:22.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-14T06:26:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-17T08:46:11.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopsInGroup'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDesktopsInGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PostPaidDesktopsCount\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"PaidDesktopsCount\\": 10,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PostPaidDesktopsTotalAmount\\": 10000,\\n \\"PaidDesktops\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-7ftf5b6yu77b0****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\",\\n \\"ExpiredTime\\": \\"\\"\\n }\\n ],\\n \\"PostPaidDesktops\\": [\\n {\\n \\"CreateDuration\\": \\"4153958447\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"DesktopStatus\\": \\"Stopped\\",\\n \\"CreateTime\\": \\"2022-01-21T06:34:57Z\\",\\n \\"ReleaseTime\\": \\"2022-01-21T16:34:57Z\\",\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"DesktopId\\": \\"ud-2i8qxpv6t1a07****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ManagementFlag\\": \\"NoFlag\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"EndUserNames\\": [\\n \\"alice\\"\\n ],\\n \\"ResetTime\\": \\"2021-03-03 08:48:08\\",\\n \\"ImageId\\": \\"m-hn5v2mmk0****\\",\\n \\"ImageName\\": \\"Win10_ZC\\",\\n \\"SystemDiskSize\\": 80,\\n \\"OsType\\": \\"Windows\\",\\n \\"GpuDriverVersion\\": \\"1.0\\",\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"ManagementFlags\\": [\\n \\"NoFlag\\"\\n ],\\n \\"MemberEniIp\\": \\"192.168.XX.XX\\",\\n \\"PrimaryEniIp\\": \\"192.168.XX.XX\\",\\n \\"ProtocolType\\": \\"HDX\\",\\n \\"FotaVersion\\": \\"0.1.0-R-20220914.17****\\"\\n }\\n ],\\n \\"OnlinePrePaidDesktopsCount\\": 100,\\n \\"RunningPrePaidDesktopsCount\\": 100,\\n \\"StopedPrePaidDesktopsCount\\": 100,\\n \\"StoppedPrePaidDesktopsCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n hx-test-3\\n ecd-2i8qxpv6t1a04qpu1\\n 0\\n Running\\n NoFlag\\n \\n 1\\n 5399F876-8F01-5767-A1FD-21F2EE3C3323\\n","errorExample":""}]',
],
'DescribeDevices' => [
'summary' => '查询可信设备列表。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '设备ID。无影硬件终端的SN,或者无影软件客户端的UUID。', 'type' => 'string', 'required' => false, 'example' => '5F52817BE267A43C608D245070D2****'."\n"],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '绑定的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '便捷办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'],
],
[
'name' => 'AdDomain',
'in' => 'query',
'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '用户账号类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['AD' => '企业AD账号', 'SIMPLE' => '便捷账号'],
'example' => 'SIMPLE',
],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '客户端类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [1 => '无影硬件终端', '无影软件客户端'],
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5BEFE642-A383-4A18-8939-FB7DE452****'],
'Devices' => [
'description' => '返回的设备列表。',
'type' => 'array',
'items' => [
'description' => '返回的设备信息。',
'type' => 'object',
'properties' => [
'DeviceId' => ['description' => '设备ID。无影硬件终端的SN,或者无影软件客户端的UUID。', 'type' => 'string', 'example' => '5F52817BE267A43C608D245070D2****'."\n"],
'EndUserList' => [
'description' => '绑定的用户信息列表。',
'type' => 'array',
'items' => [
'description' => '绑定的用户信息。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'alice'],
'UserType' => [
'description' => '用户账号类型。',
'type' => 'string',
'enumValueTitles' => ['AD' => '企业AD账号', 'SIMPLE' => '便捷账号'],
'example' => 'SIMPLE',
],
'DirectoryId' => ['description' => '便捷办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'."\n"],
'AdDomain' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'example' => 'xn--0zw****'."\n"],
],
],
],
],
],
],
],
],
],
],
'title' => '查询可信设备列表',
'responseParamsDescription' => '如果没有绑定用户信息,endUserList为[]',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'],
],
],
'ramActions' => [],
'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"}]',
],
'DescribeDirectories' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryType',
'in' => 'query',
'schema' => [
'description' => '目录类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['SIMPLE' => '便捷账号类型的目录', 'AD_CONNECTOR' => 'AD类型的目录'],
'example' => 'SIMPLE',
],
],
[
'name' => 'DirectoryStatus',
'in' => 'query',
'schema' => ['description' => '目录状态,和`Status`相同。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'REGISTERED'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '目录ID。可设置一个或多个。',
'type' => 'array',
'items' => ['description' => '目录ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'],
'required' => false,
'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****',
'maxItems' => 100,
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '目录状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['REGISTERING' => '注册中', 'DEREGISTERING' => '取消中', 'REGISTERED' => '已注册', 'NEEDCONFIGTRUST' => '需要配置信任关系', 'CONFIGTRUSTFAILED' => '配置信任关系失败', 'DEREGISTERED' => '已取消', 'ERROR' => '配置错误', 'CONFIGTRUSTING' => '配置信任关系中', 'NEEDCONFIGUSER' => '需要配置用户'],
'example' => 'REGISTERED',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F369A091-002F-49C8-AD55-02A776297C7B'],
'Directories' => [
'description' => '目录信息列表。',
'type' => 'array',
'items' => [
'description' => '目录信息。',
'type' => 'object',
'properties' => [
'EnableInternetAccess' => ['description' => '是否可上网。 '."\n"
."\n"
.'> 该参数暂未开放使用。'."\n", 'type' => 'boolean', 'example' => 'false'],
'VpcId' => ['description' => '交换机所属的VPC ID。仅当目录类型为AD办公网络时返回该参数。', 'type' => 'string', 'example' => 'vpc-uf6tz5k67puge5jn8****'],
'CreationTime' => ['description' => '目录创建时间。', 'type' => 'string', 'example' => '2020-11-02T01:44Z'],
'Status' => [
'description' => 'AD类型的目录状态。',
'type' => 'string',
'enumValueTitles' => ['REGISTERING' => '注册中', 'REGISTERED' => '已注册'],
'example' => 'REGISTERING',
],
'DomainPassword' => ['description' => '域管理员的用户密码。仅当目录类型为AD办公网络时返回该参数。', 'type' => 'string', 'example' => 'testPassword'],
'EnableAdminAccess' => ['description' => '是否为使用云电脑的用户赋予本地管理员权限。', 'type' => 'boolean', 'example' => 'true'],
'SubDomainName' => ['description' => '企业已有AD子域的全限定域名(FQDN),即同时带有主机名和域名。', 'type' => 'string', 'example' => 'child.example.com'],
'DomainUserName' => ['description' => '域管理员的用户名。', 'type' => 'string', 'example' => 'sAMAccountName'],
'EnableCrossDesktopAccess' => ['description' => '是否开通目录内云电脑互通功能。开启后,同一个目录内的云电脑之间可以实现相互访问彼此的网络。', 'type' => 'boolean', 'example' => 'true'],
'CustomSecurityGroupId' => ['description' => '安全组ID。仅当目录类型为AD办公网络时返回该参数。', 'type' => 'string', 'example' => 'sg-bp1ce64o4g9mdf5u****'],
'DesktopVpcEndpoint' => ['description' => 'VPC连接云电脑时所使用的终端节点。', 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com'],
'SsoEnabled' => ['description' => '是否开启SSO认证。', 'type' => 'boolean', 'example' => 'false'],
'DomainName' => ['description' => '域名称。', 'type' => 'string', 'example' => 'example.com'],
'DesktopAccessType' => [
'description' => '连接云电脑时允许使用的方式。',
'type' => 'string',
'enumValueTitles' => ['VPC' => 'VPC连接', 'Internet' => '公网连接', 'Any' => '公网和VPC均可'],
'example' => 'Internet',
],
'MfaEnabled' => ['description' => '是否开启多因素认证MFA。', 'type' => 'boolean', 'example' => 'false'],
'DirectoryType' => [
'description' => '目录类型。',
'type' => 'string',
'enumValueTitles' => ['AD_CONNECTOR' => 'AD类型的目录', 'RAM' => 'RAM类型的目录'],
'example' => 'RAM',
],
'DnsUserName' => ['description' => 'DNS用户名。', 'type' => 'string', 'example' => 'testDnsUserName'],
'TrustPassword' => ['description' => 'AD信任密码。仅当目录类型为AD办公网络时返回该参数。', 'type' => 'string', 'example' => '82Tg****'],
'OuName' => ['description' => '指定云电脑加域时选择的组织单元。', 'type' => 'string', 'example' => 'example.com/Domain Controllers'],
'Name' => ['description' => '目录名称。', 'type' => 'string', 'example' => 'testDirectoryName'],
'DirectoryId' => ['description' => '目录ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'],
'ADConnectors' => [
'description' => 'AD连接器的信息。',
'type' => 'array',
'items' => [
'description' => 'AD连接器的信息。',
'type' => 'object',
'properties' => [
'ConnectorStatus' => [
'description' => '连接状态。',
'type' => 'string',
'enumValueTitles' => ['CONNECT_ERROR' => '连接错误', 'RUNNING' => '运行中', 'CONNECTING' => '连接中。需要用户在自有AD上配置域信任', 'EXPIRED' => '欠费过期', 'CREATING' => '创建中'],
'example' => 'RUNNING',
],
'VSwitchId' => ['description' => 'AD连接器所在的交换机ID。', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****'],
'ADConnectorAddress' => ['description' => '连接地址。', 'type' => 'string', 'example' => '172.17.XX.XX'],
'TrustKey' => ['description' => 'AD域控信任密码。', 'type' => 'string', 'example' => 'yfpoAD****'],
'NetworkInterfaceId' => ['description' => 'AD连接器挂载的网卡ID。', 'type' => 'string', 'example' => 'eni-bp1i4wx78lgosrj6****'],
'Specification' => [
'description' => 'AD Connector规格。',
'type' => 'string',
'enumValueTitles' => [1 => '通用型', '高级型'],
'example' => '1',
],
],
],
],
'Logs' => [
'description' => '注册日志信息列表。仅当目录类型为AD办公网络时返回该参数。',
'type' => 'array',
'items' => [
'description' => '注册日志信息。',
'type' => 'object',
'properties' => [
'Step' => ['description' => '日志对应的步骤。', 'type' => 'string', 'example' => 'DescribeDirectories'],
'Message' => ['description' => '日志详细信息。', 'type' => 'string', 'example' => 'code:success | message:Create Connector complete.'],
'TimeStamp' => ['description' => '日志打印时间。', 'type' => 'string', 'example' => '2021-01-22T06:45Z'],
'Level' => [
'description' => '日志级别。',
'type' => 'string',
'enumValueTitles' => ['ERROR' => '错误', 'INFO' => '信息', 'WARN' => '警告'],
'example' => 'INFO',
],
],
],
],
'VSwitchIds' => [
'description' => '目录创建时设置的交换机ID。',
'type' => 'array',
'items' => ['description' => '目录创建时设置的交换机ID。', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****'],
],
'FileSystemIds' => [
'description' => 'NAS文件系统ID。',
'type' => 'array',
'items' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'example' => '05b534****'],
],
'SubDnsAddress' => [
'description' => 'AD子域的DNS地址。',
'type' => 'array',
'items' => ['description' => 'AD子域的DNS地址。', 'type' => 'string', 'example' => '172.24.XX.XX'],
],
'DnsAddress' => [
'description' => '目录的DNS地址。',
'type' => 'array',
'items' => ['description' => '目录的DNS地址。', 'type' => 'string', 'example' => '172.24.XX.XX'],
],
'NeedVerifyLoginRisk' => ['description' => '登录是否需要二次验证。仅适用于便捷目录。 '."\n"
.'如果开启了登录二次验证,则便捷用户登录客户端时,系统将检测登录账号是否有安全风险。如果有风险,系统将发送验证码到该账号关联的邮箱,便捷用户使用验证码验证通过后才能登录客户端。', 'type' => 'boolean', 'example' => 'false'],
'AdHostname' => ['description' => '域控主机名。', 'type' => 'string', 'example' => 'dc001'],
'BackupDns' => ['description' => '备用域控DNS地址。', 'type' => 'string', 'example' => '192.168.2.100'],
'BackupDCHostname' => ['description' => '备用域控主机名。', 'type' => 'string', 'example' => 'dc002'],
],
],
],
'AdHostname' => ['description' => '域控主机名。必须符合Windows主机命名规范。仅当目录类型为AD办公网络时返回该参数。', 'type' => 'string', 'example' => 'cnshsv21hmc****'],
],
],
],
],
'title' => '查询目录的详细信息',
'summary' => '查询目录的详细信息。',
'changeSet' => [
['createdAt' => '2024-06-26T07:31:57.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:51.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDirectories'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A776297C7B\\",\\n \\"Directories\\": [\\n {\\n \\"EnableInternetAccess\\": false,\\n \\"VpcId\\": \\"vpc-uf6tz5k67puge5jn8****\\",\\n \\"CreationTime\\": \\"2020-11-02T01:44Z\\",\\n \\"Status\\": \\"REGISTERING\\",\\n \\"DomainPassword\\": \\"testPassword\\",\\n \\"EnableAdminAccess\\": true,\\n \\"SubDomainName\\": \\"child.example.com\\",\\n \\"DomainUserName\\": \\"sAMAccountName\\",\\n \\"EnableCrossDesktopAccess\\": true,\\n \\"CustomSecurityGroupId\\": \\"sg-bp1ce64o4g9mdf5u****\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"SsoEnabled\\": false,\\n \\"DomainName\\": \\"example.com\\",\\n \\"DesktopAccessType\\": \\"Internet\\",\\n \\"MfaEnabled\\": false,\\n \\"DirectoryType\\": \\"RAM\\",\\n \\"DnsUserName\\": \\"testDnsUserName\\",\\n \\"TrustPassword\\": \\"82Tg****\\",\\n \\"OuName\\": \\"example.com/Domain Controllers\\",\\n \\"Name\\": \\"testDirectoryName\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ADConnectors\\": [\\n {\\n \\"ConnectorStatus\\": \\"RUNNING\\",\\n \\"VSwitchId\\": \\"vsw-bp19ocz3erfx15uon****\\",\\n \\"ADConnectorAddress\\": \\"172.17.XX.XX\\",\\n \\"TrustKey\\": \\"yfpoAD****\\",\\n \\"NetworkInterfaceId\\": \\"eni-bp1i4wx78lgosrj6****\\",\\n \\"Specification\\": \\"1\\"\\n }\\n ],\\n \\"Logs\\": [\\n {\\n \\"Step\\": \\"DescribeDirectories\\",\\n \\"Message\\": \\"code:success | message:Create Connector complete.\\",\\n \\"TimeStamp\\": \\"2021-01-22T06:45Z\\",\\n \\"Level\\": \\"INFO\\"\\n }\\n ],\\n \\"VSwitchIds\\": [\\n \\"vsw-bp19ocz3erfx15uon****\\"\\n ],\\n \\"FileSystemIds\\": [\\n \\"05b534****\\"\\n ],\\n \\"SubDnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"DnsAddress\\": [\\n \\"172.24.XX.XX\\"\\n ],\\n \\"NeedVerifyLoginRisk\\": false,\\n \\"AdHostname\\": \\"dc001\\",\\n \\"BackupDns\\": \\"192.168.2.100\\",\\n \\"BackupDCHostname\\": \\"dc002\\"\\n }\\n ],\\n \\"AdHostname\\": \\"cnshsv21hmc****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n REGISTERING\\n example.com\\n sg-bp1ce64o4g9mdf5u****\\n testDirectoryName\\n RAM\\n testPassword\\n 82Tg****\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\n vpc-uf6tz5k67puge5jn8****\\n 2020-11-02T01:44Z\\n Internet\\n sAMAccountName\\n false\\n testDnsUserName\\n \\n \\n \\n 172.17.**.**\\n eni-bp1i4wx78lgosrj6****\\n RUNNING\\n vsw-bp19ocz3erfx15uon****\\n \\n \\n INFO\\n DescribeDirectories\\n code:success | message:Create Connector complete.\\n 2021-01-22T06:45Z\\n \\n \\n \\n vsw-bp19ocz3erfx15uon****\\n [\\"171.17.**.**\\"]\\n \\n F369A091-002F-49C8-AD55-02A776297C7B\\n caeba0bbb2be03f84eb48b699f0a4883\\n","errorExample":""}]',
],
'DescribeDrives' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'DomainIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '存储资源ID列表。',
'type' => 'array',
'items' => ['description' => '存储资源ID。', 'type' => 'string', 'required' => false, 'example' => 'dom-aaaa****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '存储资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['NAS' => 'NAS存储', 'PDS' => 'PDS存储'],
'example' => 'NAS',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:500'."\n"
.'- 默认值:20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'AAAA****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'B7AA****'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '响应代码,200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '响应消息。', 'type' => 'string', 'example' => 'successful'],
'Count' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAA****'],
'Drives' => [
'description' => '用户级别的存储资源列表。',
'type' => 'array',
'items' => [
'description' => '用户级别的存储资源。',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'ID。'."\n"
.'> 此参数不需要关注', 'type' => 'string', 'example' => '1'],
'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-07-02T08:42:26.000+00:00'],
'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-07-07T02:46:04.000+00:00'],
'AliUid' => ['description' => '阿里云账号id。', 'type' => 'integer', 'format' => 'int64', 'example' => '1202****'],
'DomainId' => ['description' => '存储资源ID。', 'type' => 'string', 'example' => 'dom-aaaa****'],
'ExternalDomainId' => ['description' => '外部存储资源ID。'."\n"
.'- 当存储资源为NAS时,此参数返回NAS的ID。'."\n"
.'- 当存储资源为PDS时,此参数返回PDS的ID。', 'type' => 'string', 'example' => '0976****'],
'DriveId' => ['description' => '用户级别的存储资源ID。', 'type' => 'string', 'example' => 'dri-aaaa****'],
'ExternalDriveId' => ['description' => '外部用户级别的存储资源ID。'."\n"
.'> 仅存储资源为PDS时返回此参数。', 'type' => 'string', 'example' => '1100****'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'user01'],
'ExternalUserId' => ['description' => '外部用户ID。'."\n"
.'> 仅存储资源为PDS时返回此参数。', 'type' => 'string', 'example' => 'user01@cn-hangzhou.120****'],
'Name' => ['description' => '存储资源名称。', 'type' => 'string', 'example' => 'test****'],
'Description' => ['description' => '存储资源简介。', 'type' => 'string', 'example' => 'test****'],
'TotalSize' => ['description' => '用户级别存储资源总容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '536870912000'],
'UsedSize' => ['description' => '用户级别存储资源已用容量。', 'type' => 'integer', 'format' => 'int64', 'example' => '243175936'],
'Status' => [
'description' => '用户级别存储资源状态。',
'type' => 'string',
'enumValueTitles' => ['INIT' => '初始化', 'MAINTAIN' => '维护中', 'DELETING' => '删除中', 'INVALID' => '失效', 'NORMAL' => '正常', 'FAIL' => '失败'],
'example' => 'NORMAL',
],
'Type' => [
'description' => '存储资源用途。',
'type' => 'string',
'enumValueTitles' => ['DESKTOP' => '数据盘空间', 'USER_PROFILE' => '用户个人数据空间'],
'example' => 'USER_PROFILE',
],
'ProfileRoaming' => ['description' => '> 此参数已废弃。', 'type' => 'boolean', 'example' => '-'],
'DesktopGroupCount' => ['description' => '关联云电脑池数量。'."\n"
.'> 仅存储资源为NAS且用途为USER_PROFILE时返回此参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DesktopGroups' => [
'description' => '关联云电脑池详情列表。'."\n"
.'> 仅存储资源为NAS且用途为USER_PROFILE时返回此参数。',
'type' => 'array',
'items' => [
'description' => '云电脑池详情。',
'type' => 'object',
'properties' => [
'DesktopGroupId' => ['description' => '云电脑池ID。', 'type' => 'string', 'example' => 'dg-aaaa****'],
'DesktopGroupName' => ['description' => '云电脑池名称。', 'type' => 'string', 'example' => 'group01'],
],
],
],
'EnableProfileManagement' => ['description' => '是否开启了UPM功能。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
'title' => '查询用户级别的存储资源',
'summary' => '查询用户级别的存储资源。',
'changeSet' => [
['createdAt' => '2022-08-31T07:11:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDrives'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B7AA****\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Count\\": 2,\\n \\"NextToken\\": \\"AAAA****\\",\\n \\"Drives\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"GmtCreate\\": \\"2025-07-02T08:42:26.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-07T02:46:04.000+00:00\\",\\n \\"AliUid\\": 0,\\n \\"DomainId\\": \\"dom-aaaa****\\",\\n \\"ExternalDomainId\\": \\"0976****\\",\\n \\"DriveId\\": \\"dri-aaaa****\\",\\n \\"ExternalDriveId\\": \\"1100****\\",\\n \\"UserId\\": \\"user01\\",\\n \\"ExternalUserId\\": \\"user01@cn-hangzhou.120****\\",\\n \\"Name\\": \\"test****\\",\\n \\"Description\\": \\"test****\\",\\n \\"TotalSize\\": 536870912000,\\n \\"UsedSize\\": 243175936,\\n \\"Status\\": \\"NORMAL\\",\\n \\"Type\\": \\"USER_PROFILE\\",\\n \\"ProfileRoaming\\": true,\\n \\"DesktopGroupCount\\": 1,\\n \\"DesktopGroups\\": [\\n {\\n \\"DesktopGroupId\\": \\"dg-aaaa****\\",\\n \\"DesktopGroupName\\": \\"group01\\"\\n }\\n ],\\n \\"EnableProfileManagement\\": true\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeEcdReportTasks' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => ['Enterprise', 'Business'],
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '报表任务ID。', 'type' => 'string', 'required' => false, 'example' => 'ret-sfkdsjfi*****'],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => [
'description' => '报表类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESOURCE_REPORT' => '资源报表'],
'example' => 'RESOURCE_REPORT',
],
],
[
'name' => 'SubType',
'in' => 'query',
'schema' => [
'description' => '报表任务子类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DESKTOP' => '云电脑'],
'example' => 'DESKTOP',
],
],
[
'name' => 'Status',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '任务状态。',
'type' => 'array',
'items' => ['description' => '任务状态。', 'type' => 'string', 'required' => false, 'example' => 'RUNNING'],
'required' => false,
'enumValueTitles' => ['INIT' => '初始化', 'FAILED' => '执行失败', 'RUNNING' => '执行中', 'EXPIRED' => '已过期', 'FINISHED' => '执行完成'],
'maxItems' => 100,
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => '第几页,默认查询第1页。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页行数。最大值200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20。'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'ExportTaskList' => [
'description' => '报表任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '报表任务ID。', 'type' => 'string', 'example' => 'ret-asdfkjg*****'],
'TaskType' => [
'description' => '报表类型。',
'type' => 'string',
'enumValueTitles' => ['RESOURCE_REPORT' => '资源报表'],
'example' => 'RESOURCE_REPORT',
],
'SubType' => [
'description' => '报表任务子类型。',
'type' => 'string',
'enumValueTitles' => ['DESKTOP' => '云电脑'],
'example' => 'DESKTOP',
],
'ReportFileName' => ['description' => '报表文件名称。', 'type' => 'string', 'example' => 'TestFileName'],
'Status' => ['description' => '报表任务状态。', 'type' => 'string', 'example' => 'Running'],
'Progress' => ['description' => '报表导出任务完成的进度。单位:%。', 'type' => 'number', 'format' => 'float', 'example' => '80'],
'GmtCreate' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2025-07-14T07:46:49.000+00:00'],
'GmtModified' => ['description' => '修改时间。', 'type' => 'string', 'example' => '2025-07-14T07:46:49.000+00:00'],
'DownloadUrl' => ['description' => '报表文件下载地址。', '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' => '错误码。', 'type' => 'string', 'example' => 'Success'],
'ErrorMsg' => ['description' => '错误信息', 'type' => 'string', 'example' => 'No Data.'],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询无影报表任务列表',
'summary' => '查询数据报表导出任务列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEcdReportTasks'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeEcdReportTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 20,\\n \\"ExportTaskList\\": [\\n {\\n \\"TaskId\\": \\"ret-asdfkjg*****\\",\\n \\"TaskType\\": \\"RESOURCE_REPORT\\",\\n \\"SubType\\": \\"DESKTOP\\",\\n \\"ReportFileName\\": \\"TestFileName\\",\\n \\"Status\\": \\"Running\\",\\n \\"Progress\\": 80,\\n \\"GmtCreate\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"GmtModified\\": \\"2025-07-14T07:46:49.000+00:00\\",\\n \\"DownloadUrl\\": \\"https://cn-shanghai-ecd-report-files.oss-cn-shanghai.aliyuncs.com/ecd_report/resource/desktop/100721430*****/DESKTOP_20250709140932_*****.xlsx?Expires=*****&OSSAccessKeyId=STS.****&Signature=****%3D&security-token=****\\",\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMsg\\": \\"No Data.\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeFlowMetric' => [
'summary' => '查询云电脑的流入带宽和流出带宽,或是公网精品带宽的公网访问流入带宽和流出带宽监控数据。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID,可以是云电脑ID或者公网精品带宽ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Ecd-fwq23f13****ornp-6inxqsvcyv6z8****'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => [
'description' => '监控数据的统计周期。单位:秒。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '3600',
'minimum' => '60',
'enumValueTitles' => [60 => '60秒', 900 => '900秒', 3600 => '3600秒'],
'example' => '60',
'enum' => ['60', '300', '900', '3600'],
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间。支持的格式:'."\n"
."\n"
.'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1651817220643'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。支持的格式:'."\n"
."\n"
.'- Unix时间戳:从1970年1月1日开始所经过的毫秒数。'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', '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' => '实例类型。可以选择云电脑类型或公网精品带宽类型。如果选择云电脑类型,则`InstanceId`与`MetricType`需对应填写云电脑ID与云电脑的流量类型,公网精品带宽同理。',
'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' => '请求ID。', '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.', 'description' => '服务内部异常,请稍候重试。'],
],
],
'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' => '查询流入带宽和流出带宽',
'changeSet' => [
['createdAt' => '2025-06-30T12:35:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFlowMetric'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeFlowMetric',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeFotaPendingDesktops' => [
'summary' => '获取可升级到指定版本镜像但尚未升级的云电脑信息。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'TaskUid',
'in' => 'query',
'schema' => ['description' => '镜像升级任务的信息。可调用[DescribeFotaTasks](~~437001~~)获取该参数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aot-c4khwrp9ocml4****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。可调用[DescribeOfficeSites](~~216071~~)获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-428216****'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'demo-computer'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'FotaPendingDesktops' => [
'description' => '可升级到`TaskUid`对应版本的镜像但尚未升级的云电脑列表。',
'type' => 'array',
'items' => [
'description' => '可升级到`TaskUid`对应版本的镜像但尚未升级的云电脑。',
'type' => 'object',
'properties' => [
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-bvdtu3jn97o1r****'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'demo-computer'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-shanghai+dir-428216****'],
'FotaProject' => ['description' => '> 此参数不对外开放使用。', 'type' => 'string', 'example' => 'windows'],
'CurrentAppVersion' => ['description' => '云电脑当前的镜像版本。', 'type' => 'string', 'example' => '0.0.1-D-20220513.143129'],
'Status' => [
'description' => '云电脑的状态。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => ['创建中', '开机中', '运行中', '关机中', 5 => '已关机', '已过期', '已删除', 9 => '创建失败'],
'example' => '2',
],
'Sessions' => [
'description' => '连接的会话列表。',
'type' => 'array',
'items' => [
'description' => '连接的会话。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '连接的用户ID。', 'type' => 'string', 'example' => 'alice'],
],
],
],
],
],
],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '信息。', 'type' => 'string', 'example' => 'Succeeded'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FotaPendingDesktops\\": [\\n {\\n \\"DesktopId\\": \\"ecd-bvdtu3jn97o1r****\\",\\n \\"DesktopName\\": \\"demo-computer\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-428216****\\",\\n \\"FotaProject\\": \\"windows\\",\\n \\"CurrentAppVersion\\": \\"0.0.1-D-20220513.143129\\",\\n \\"Status\\": 2,\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Succeeded\\"\\n}","type":"json"}]',
'title' => '获取待升级镜像的云电脑信息',
'changeSet' => [
['createdAt' => '2024-03-25T11:43:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-07-14T09:44:24.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaPendingDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeFotaPendingDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeFotaTasks' => [
'summary' => '获取镜像升级任务列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'TaskUid',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像升级任务的信息列表。',
'type' => 'array',
'items' => ['description' => '镜像升级任务的信息。可调用[DescribeFotaTasks](~~437001~~)获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'aot-c4khwrp9ocml4****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'UserStatus',
'in' => 'query',
'schema' => [
'description' => '设置镜像升级任务是否自动推送。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Running' => '自动推送', 'Pending' => '不自动推送'],
'example' => 'Pending',
],
],
[
'name' => 'FotaStatus',
'in' => 'query',
'schema' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'example' => 'windows'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '升级版本说明的语言类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en' => '英文', 'zh' => '简体中文'],
'example' => 'zh',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'FotaTasks' => [
'description' => '镜像升级任务信息。',
'type' => 'array',
'items' => [
'description' => '镜像升级任务信息。',
'type' => 'object',
'properties' => [
'TaskUid' => ['description' => '镜像升级任务的ID。', 'type' => 'string', 'example' => 'aot-c4khwrp9ocml4****'],
'FotaProject' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'example' => 'To be hidden.'],
'AppVersion' => ['description' => '镜像版本。可调用[DescribeImages](~~188895~~)获取该参数。', 'type' => 'string', 'example' => '0.0.1-D-20220513.143129'],
'Status' => [
'description' => '镜像升级任务是否自动推送。',
'type' => 'string',
'enumValueTitles' => ['Running' => '自动推送', 'Pending' => '不自动推送'],
'example' => 'valid',
],
'PublishTime' => ['description' => '升级版本的发布时间。', 'type' => 'string', 'example' => '2022-05-31T04:28:48Z'],
'PendingDesktopCount' => ['description' => '可升级到该版本的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ReleaseNote' => ['description' => '升级版本说明。', 'type' => 'string', 'example' => 'test'],
'Size' => ['description' => '升级包大小,单位为KB。', 'type' => 'integer', 'format' => 'int32', 'example' => '568533470'],
'PendingCustomImageCount' => ['description' => '可升级到该版本的自定义镜像数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'The parameter is not specified.'],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
],
],
],
],
'title' => '获取镜像升级任务列表',
'changeSet' => [
['createdAt' => '2023-12-06T02:37:44.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-11-23T06:17:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-03-28T04:46:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaTasks'],
],
],
'ramActions' => [],
'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"}]',
],
'DescribeGlobalDesktopRecords' => [
'summary' => '查询近期所有云电脑的基本信息,及对应的使用时长记录。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => [
'type' => 'string',
'enum' => ['Enterprise', 'Business', 'Lincore_team'],
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。'."\n"
.'- 上海'."\n"
.'- 新加坡', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '开始时间。支持的格式:'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2022-03-23T04:10:21Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。开始时间和结束时间间隔最大为30天,支持的格式:'."\n"
.'- Format格式:YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'required' => false, 'example' => '2022-08-31T06:56:45Z'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。 '."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页数量。最大值100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云桌面ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer'],
],
[
'name' => 'SubPayType',
'in' => 'query',
'schema' => ['description' => '云电脑购买方式。可选值为:'."\n"
."\n"
.'- prePaid:按月购买不限时长。'."\n"
.'- postPaid:按量购买。'."\n"
.'- monthPackage:按月时长包。', 'type' => 'string', 'required' => false, 'example' => 'monthPackage'],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => ['description' => '查询范围,默认为空,可选值为:'."\n"
."\n"
.'- ADVANCED:表示查询连接时长等统计记录。', 'type' => 'string', 'required' => false, 'example' => 'ADVANCED'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,若不指定则按照创建时间倒序排列。可选值为:'."\n"
."\n"
.'- uptime:表示按云电脑开机时长排序', 'type' => 'string', 'required' => false, 'example' => 'uptime'],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => ['description' => '排序方式,默认为增序。取值:'."\n"
.'- Asc:增序'."\n"
.'- Desc:降序', 'type' => 'string', 'required' => false, 'example' => 'Asc'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'TestUser'],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['description' => '云电脑规格。您可以调用[DescribeDesktopTypes](~~188882~~)查询云电脑支持的规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.2c4g'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '资源组ID。', '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' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Sessions' => [
'description' => '会话详情。',
'type' => 'array',
'items' => [
'description' => '会话详情。',
'type' => 'object',
'properties' => [
'Platform' => ['description' => '操作系统具体型号。', 'type' => 'string', 'example' => 'Windows 10'],
'StatusChangeTime' => ['description' => '云电脑状态变更时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1760583xxxx'],
'Memory' => ['description' => '云电脑的内存。单位:MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
'Cpu' => ['description' => 'vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'SubPayType' => ['description' => '云电脑购买方式。可选值为:'."\n"
."\n"
.'- prePaid:按月购买不限时长。'."\n"
.'- postPaid:按量购买。'."\n"
.'- monthPackage:按月时长包。', 'type' => 'string', 'example' => 'monthPackage'],
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'TestUser'],
'OsType' => ['description' => '操作系统类型。可选值:'."\n"
."\n"
.'- Windows'."\n"
.'- Linux', 'type' => 'string', 'example' => 'Linux'],
'SessionIdleTime' => ['description' => '会话空闲时长。单位:分钟。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'TestOfficeSite'],
'ConnectionStatus' => ['description' => '连接状态。', 'type' => 'string', 'example' => 'Connected'],
'Sessions' => [
'description' => '会话详情。',
'type' => 'array',
'items' => [
'description' => '终端用户信息。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'TestUser'],
'EstablishmentTime' => ['description' => '会话创建时间。', 'type' => 'string', 'example' => '2022-08-31T06:56:45Z'],
],
],
],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-g6t1ukbaea****'],
'EndUserIds' => [
'description' => '分配的终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'TestUser'],
],
'ResourceGroups' => [
'description' => '企业资源组名称。',
'type' => 'array',
'items' => [
'description' => '企业资源组名称。',
'type' => 'object',
'properties' => [
'ResourceGroupId' => ['description' => '企业资源组ID。', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8'],
'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => 'dms_test'],
],
],
],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-8904****'],
'UpTime' => ['description' => '云电脑开机时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '86400'],
'ProtocolType' => ['description' => '协议类型。'."\n"
."\n"
.'- HDX'."\n"
.'- ASP', 'type' => 'string', 'example' => 'ASP'],
'GpuSpec' => ['description' => 'GPU显存大小。', 'type' => 'string', 'example' => '8GiB'],
'LatestConnectionTime' => ['description' => '最近一次连接云电脑的时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
'TotalConnectionTime' => ['description' => '总连接时长。单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '240'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-iaqu3bi2xtie****'],
'DesktopGroupName' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'example' => 'DemoCCGroup'],
'DesktopStatus' => ['title' => '桌面状态', 'description' => '桌面状态', 'type' => 'string', 'example' => 'Running'],
'OfficeSiteType' => ['title' => '办公网络类型', 'description' => '办公网络类型', 'type' => 'string', 'example' => 'Simple'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询全局桌面及相关使用记录',
'description' => '- 国内站用户查询站点选择上海,国际站用户选择新加坡。'."\n"
.'- 默认支持查询已删除和未删除的全部云电脑。'."\n"
.'- 已删除的云电脑仅支持查询删除时间在三个月以内的。'."\n"
.'- 排序条件不能与其他条件共用。',
'changeSet' => [
['createdAt' => '2025-12-01T06:53:05.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktopRecords'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeGlobalDesktopRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 1,\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Sessions\\": [\\n {\\n \\"Platform\\": \\"Windows 10\\",\\n \\"StatusChangeTime\\": 0,\\n \\"Memory\\": 4096,\\n \\"DesktopName\\": \\"DemoComputer\\",\\n \\"Cpu\\": 2,\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"SessionIdleTime\\": 120,\\n \\"OfficeSiteName\\": \\"TestOfficeSite\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"TestUser\\",\\n \\"EstablishmentTime\\": \\"2022-08-31T06:56:45Z\\"\\n }\\n ],\\n \\"DesktopId\\": \\"ecd-g6t1ukbaea****\\",\\n \\"EndUserIds\\": [\\n \\"TestUser\\"\\n ],\\n \\"ResourceGroups\\": [\\n {\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"dms_test\\"\\n }\\n ],\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-8904****\\",\\n \\"UpTime\\": 86400,\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"GpuSpec\\": \\"8GiB\\",\\n \\"LatestConnectionTime\\": 120,\\n \\"TotalConnectionTime\\": 240,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"DesktopGroupId\\": \\"dg-iaqu3bi2xtie****\\",\\n \\"DesktopGroupName\\": \\"DemoCCGroup\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"OfficeSiteType\\": \\"Simple\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeGlobalTimerBatches' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。'."\n"
.'- 上海'."\n"
.'- 新加坡', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'TimerType',
'in' => 'query',
'schema' => ['description' => '需要查询的任务类型。仅有定时类任务可以查询到批次信息。'."\n"
."\n"
.'- TimerBoot:定时开机'."\n"
.'- TimerShutdown:定时关机'."\n"
.'- TimerReboot:定时重启'."\n"
.'- TimerReset:定时重置'."\n"
.'- TimerMaintenance:定时进入维护模式'."\n"
.'- TimerHibernate:定时休眠', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '返回最大数量。', 'type' => 'string', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'SearchRegionId',
'in' => 'query',
'schema' => ['description' => '搜索地域ID。用于过滤出指定地域的云电脑信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '定时任务组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-i1ruuudp92qpj****'],
],
[
'name' => 'ResourceTypes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'Desktop'],
],
],
],
'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' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'Results' => [
'description' => '结果列表。',
'type' => 'array',
'items' => [
'description' => '结果列表。',
'type' => 'object',
'properties' => [
'BatchId' => ['description' => '定时类任务执行的批次ID。', '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'],
'title' => '查询定时任务执行批次列表',
'summary' => '查询定时任务执行历史记录的批次信息,并且返回汇总的执行结果。',
'description' => '- 此接口为中心化域名,接入点为上海或新加坡,不支持其他地域调用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerBatches'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E54EB497-D7B7-5F04-B744-D8DFA7B******\\",\\n \\"Count\\": 1,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"SucceedCount\\": 0,\\n \\"FailedCount\\": 0,\\n \\"SkippedCount\\": 0,\\n \\"RunningCount\\": 0\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeGlobalTimerRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'TimerTypes',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '定时任务列表。',
'type' => 'array',
'items' => [
'description' => '定时任务类型。'."\n"
."\n"
.'**定时任务:**'."\n"
.'- TimerBoot:定时开机'."\n"
.'- TimerShutdown:定时关机'."\n"
.'- TimerReboot:定时重启'."\n"
.'- TimerReset:定时重置'."\n"
.'- TimerMaintenance:定时进入维护模式'."\n"
.'- TimerHibernate:定时休眠'."\n"
."\n"
.'**无操作任务:**'."\n"
.'- NoOperationShutdown:无操作关机'."\n"
.'- NoOperationReboot:无操作重启'."\n"
.'- NoOperationDisconnect:无操作断连'."\n"
.'- NoOperationHibernate:无操作休眠'."\n"
."\n"
.'**断连任务:**'."\n"
.'- NoConnectShutdown:断连关机'."\n"
.'- NoConnectHibernate:断连休眠',
'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' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
],
[
'name' => 'SearchRegionId',
'in' => 'query',
'schema' => ['description' => '搜索地域ID。用于过滤出指定地域的云电脑信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => ['description' => '定时类任务执行的批次ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-****'],
],
[
'name' => 'TimerResult',
'in' => 'query',
'schema' => [
'description' => '定时任务的执行结果。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['CONNECTED_NOT_RUN' => '云电脑已被连接,定时任务未执行', 'PAUSED' => '执行暂停', 'COMPLETED' => '已完成', 'FAILED' => '执行失败', 'RUNNING' => '运行中', 'TERMINATED' => '执行中止'],
'example' => 'RUNNING',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '定时任务组ID。', 'type' => 'string', 'required' => false, 'example' => 'ccg-0cvfvf6u1enx1****'],
],
[
'name' => 'ResultCategory',
'in' => 'query',
'schema' => [
'description' => '通过执行结果进行过滤。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SUCCEED' => '执行成功', 'FAILED' => '执行失败', 'RUNNING' => '执行中', 'SKIPPED' => '执行被跳过'],
'example' => 'SUCCEED',
],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'Retryable',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => ''],
],
[
'name' => 'DisplayResultName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'example' => 'FAILED', 'description' => ''],
],
[
'name' => 'ResourceTypes',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'Desktop'],
],
],
[
'name' => 'WuyingServerIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string', 'example' => 'ws-xxx'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '63740E03-1B4B-5A18-AC27-2745A4F2****'],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****'],
'Count' => ['description' => '总条目数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Results' => [
'description' => '返回结果信息。',
'type' => 'array',
'items' => [
'description' => '结果列表。',
'type' => 'object',
'properties' => [
'BatchId' => ['description' => '定时类任务执行的批次ID。', 'type' => 'string', 'example' => 'ccg-0cvfvf6u1enx1****'],
'TimerType' => ['description' => '定时任务类型。', 'type' => 'string', 'example' => 'TimerBoot'],
'TimerResult' => ['description' => '定时任务的执行结果。', 'type' => 'string', 'example' => 'RUNNING'],
'CreateTime' => ['description' => '记录创建时间。', 'type' => 'string', 'example' => '2023-08-03T08:27:29Z'],
'FinishTime' => ['description' => '任务结束时间。', 'type' => 'string', 'example' => '2025-01-21T02:00:45Z'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-0c951fy9arnk9****'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DesktopName'],
'TimerGroupId' => ['description' => '定时任务组ID。', 'type' => 'string', 'example' => 'ccg-xxxx'],
'ActionType' => ['description' => '执行的动作类型。', 'type' => 'string', 'example' => 'REBOOT'],
'Context' => ['description' => '定时任务执行过程中的记录信息。', 'type' => 'string', 'example' => '{}'],
'DisplayResultName' => ['type' => 'string', 'example' => 'SKIPPED', 'description' => ''],
'Retryable' => ['type' => 'boolean', 'example' => 'true', 'description' => ''],
'TimerRecordId' => ['type' => 'string', 'example' => 't-xxx', 'description' => ''],
'ResourceParentId' => ['type' => 'string', 'example' => 'p-xxx'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询全局定时任务执行记录',
'summary' => '查询各地域云电脑的定时任务执行记录。',
'changeSet' => [
['createdAt' => '2025-12-24T11:15:13.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerRecords'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63740E03-1B4B-5A18-AC27-2745A4F2****\\",\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6mnFXZiT7NdvGNgkInJ****\\",\\n \\"Count\\": 2,\\n \\"Results\\": [\\n {\\n \\"BatchId\\": \\"ccg-0cvfvf6u1enx1****\\",\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"TimerResult\\": \\"RUNNING\\",\\n \\"CreateTime\\": \\"2023-08-03T08:27:29Z\\",\\n \\"FinishTime\\": \\"2025-01-21T02:00:45Z\\",\\n \\"DesktopId\\": \\"ecd-0c951fy9arnk9****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DesktopName\\": \\"DesktopName\\",\\n \\"TimerGroupId\\": \\"ccg-xxxx\\",\\n \\"ActionType\\": \\"REBOOT\\",\\n \\"Context\\": \\"{}\\",\\n \\"DisplayResultName\\": \\"SKIPPED\\",\\n \\"Retryable\\": true,\\n \\"TimerRecordId\\": \\"t-xxx\\",\\n \\"ResourceParentId\\": \\"p-xxx\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeGuestApplications' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-asw3giklqvfqe****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '云电脑用户的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '272CF39E-B5DE-5BE3-A09B-B43F1026****'],
'Applications' => [
'description' => '应用信息列表。',
'type' => 'array',
'items' => [
'description' => '应用信息。',
'type' => 'object',
'properties' => [
'ApplicationName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'Google Chrome'],
'ApplicationVersion' => ['description' => '应用版本号。', 'type' => 'string', 'example' => '115.0.5790.110'],
'ProcessPath' => ['description' => '进程路径。', 'type' => 'string', 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe'],
'Pid' => ['description' => '进程ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1357'],
'CpuPercent' => ['description' => 'CPU使用率。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'MemPercent' => ['description' => '内存使用率。', 'type' => 'number', 'format' => 'double', 'example' => '1.8368155'],
'GpuPercent' => ['description' => 'GPU使用率。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'IoSpeed' => ['description' => 'IO读写速度(Byte/s)。', 'type' => 'number', 'format' => 'double', 'example' => '8919266'],
'IconUrl' => ['description' => '应用的图标地址。', 'type' => 'string', 'example' => 'https://app-center-icon-prod-shanghai.oss-cn-shanghai.aliyuncs.com/market/preload/default****.png'],
'Status' => [
'description' => '应用程序状态。',
'type' => 'string',
'enumValueTitles' => ['Idle' => '应用程序已在云电脑中安装但未运行', 'Running' => '应用程序已在云电脑中安装且在运行'],
'example' => 'Running',
],
'ProcessData' => [
'description' => '进程信息列表。',
'type' => 'array',
'items' => [
'description' => '进程信息。',
'type' => 'object',
'properties' => [
'ApplicationName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'Google Chrome'],
'ApplicationVersion' => ['description' => '应用版本号。', 'type' => 'string', 'example' => '115.0.5790.110'],
'ProcessPath' => ['description' => '进程路径。', 'type' => 'string', 'example' => 'C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe'],
'Pid' => ['description' => '进程ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1357'],
'CpuPercent' => ['description' => 'CPU使用率(%)。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'MemPercent' => ['description' => '内存使用率(%)。', 'type' => 'number', 'format' => 'double', 'example' => '1.8368155'],
'GpuPercent' => ['description' => 'GPU使用率(%)。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'Iospeed' => ['description' => 'IO读写速度(Byte/s)。', 'type' => 'number', 'format' => 'double', 'example' => '8919266'],
],
],
],
],
],
],
],
],
],
],
'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' => '查询云电脑指定用户的应用和进程信息',
'summary' => '查询云电脑指定授权用户的应用和进程信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGuestApplications'],
],
],
'ramActions' => [],
],
'DescribeImageModifiedRecords' => [
'summary' => '查询云电脑的镜像变更记录。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [],
'example' => 'cn-hangzhou',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-bd53sfmysz8ir****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l3d+SWeOobbIlDLjwhjkTk'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DC40EE61-7E83-59ED-AEA6-7EE9C437F352'],
'TotalCount' => ['description' => '镜像修改记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ImageModifiedRecords' => [
'description' => '镜像修改记录集合。',
'type' => 'array',
'items' => [
'description' => '镜像修改记录集合。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '镜像修改的状态。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['镜像变更中', '镜像变更成功', '镜像变更失败'],
'example' => '1',
],
'UpdateTime' => ['description' => '最后修改镜像的时间。', 'type' => 'string', 'example' => '2022-03-03T02:43:44.851Z'],
'NewImageName' => ['description' => '变更后的新镜像名称。', 'type' => 'string', 'example' => 'Windows server 2022 Mainland asp'],
'ImageName' => ['description' => '变更前镜像名称。', 'type' => 'string', 'example' => 'Windows server 2019 Mainland'],
'NewImageId' => ['description' => '变更后的新镜像ID。', 'type' => 'string', 'example' => 'desktopimage-windows-server-2022-64-ch-asp'],
'ImageId' => ['description' => '变更前镜像ID。', 'type' => 'string', 'example' => 'desktopimage-windows-server-2019-64-ch-asp'],
'Reason' => ['type' => 'string', 'description' => ''],
],
],
],
],
],
],
],
'title' => '查询镜像变更记录',
'changeSet' => [
['createdAt' => '2025-04-25T10:05:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-05-12T02:46:24.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImageModifiedRecords'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6koN7RqHg3d2z8LKmSoe821\\",\\n \\"RequestId\\": \\"DC40EE61-7E83-59ED-AEA6-7EE9C437F352\\",\\n \\"TotalCount\\": 20,\\n \\"ImageModifiedRecords\\": [\\n {\\n \\"Status\\": 1,\\n \\"UpdateTime\\": \\"2022-03-03T02:43:44.851Z\\",\\n \\"NewImageName\\": \\"Windows server 2022 Mainland asp\\",\\n \\"ImageName\\": \\"Windows server 2019 Mainland\\",\\n \\"NewImageId\\": \\"desktopimage-windows-server-2022-64-ch-asp\\",\\n \\"ImageId\\": \\"desktopimage-windows-server-2019-64-ch-asp\\",\\n \\"Reason\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeImagePermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-4zfb6zj728hhr****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
'AliUids' => [
'description' => '接受镜像共享的阿里云账号ID列表。',
'type' => 'array',
'items' => ['description' => '接受镜像共享的阿里云账号ID。', 'type' => 'string', 'example' => '176102063125****'],
],
],
],
],
],
'title' => '获取镜像已共享的阿里云账号列表',
'summary' => '获取当前镜像已共享的阿里云账号列表。',
'description' => '调用[ModifyImagePermission](~~436982~~)可将镜像共享给无影的其他用户或者取消已经共享的镜像。调用本接口可获取当前镜像已共享的阿里云账号列表。',
'changeSet' => [
['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImagePermission'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"AliUids\\": [\\n \\"176102063125****\\"\\n ]\\n}","type":"json"}]',
],
'DescribeImages' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'ImageType',
'in' => 'query',
'schema' => [
'description' => '镜像类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '系统镜像', 'CUSTOM' => '自定义镜像'],
'example' => 'SYSTEM',
],
],
[
'name' => 'ImageStatus',
'in' => 'query',
'schema' => [
'description' => '镜像状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Creating' => '创建中', 'Available' => '可用', 'CreateFailed' => '创建失败'],
'example' => 'Available',
],
],
[
'name' => 'GpuCategory',
'in' => 'query',
'schema' => [
'description' => '是否为GPU类型镜像。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '是GPU镜像', 'false' => '不是GPU镜像'],
'example' => 'false',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议 [推荐]'],
'example' => 'ASP',
],
],
[
'name' => 'LanguageType',
'in' => 'query',
'schema' => [
'description' => '操作系统语言。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en-US' => '英文', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日文'],
'example' => 'en-US',
],
],
[
'name' => 'DesktopInstanceType',
'in' => 'query',
'schema' => ['description' => '云电脑规格。可调用[DescribeDesktopTypes](~~436816~~)获取该参数。', 'type' => 'string', 'required' => false, 'example' => 'ecd.graphics.xlarge'],
],
[
'name' => 'ImageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID。可设置一个或多个。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****'],
'required' => false,
'example' => 'm-gx2x1dhsmusr2****',
'maxItems' => 100,
],
],
[
'name' => 'OsType',
'in' => 'query',
'schema' => [
'description' => '操作系统类型,默认为`null`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
],
[
'name' => 'GpuDriverVersion',
'in' => 'query',
'schema' => ['description' => 'GPU驱动版本号。', 'type' => 'string', 'required' => false, 'example' => '417.22'],
],
[
'name' => 'SessionType',
'in' => 'query',
'schema' => [
'description' => '会话类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SINGLE_SESSION' => '单会话镜像', 'MULTIPLE_SESSION' => '多会话镜像'],
'example' => 'SINGLE_SESSION',
],
],
[
'name' => 'FotaVersion',
'in' => 'query',
'schema' => ['description' => '镜像版本信息。', 'type' => 'string', 'required' => false, 'example' => '0.0.3-R-20220616.133609'],
],
[
'name' => 'ImageName',
'in' => 'query',
'schema' => ['description' => '镜像名称。', 'type' => 'string', 'required' => false, 'example' => 'Win_01'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB'],
'Images' => [
'description' => '镜像信息组成的集合。',
'type' => 'array',
'items' => [
'description' => '镜像信息。',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => '镜像的创建时间。', 'type' => 'string', 'example' => '2018-01-10T01:01:10Z'],
'Status' => [
'description' => '镜像状态。',
'type' => 'string',
'enumValueTitles' => ['Creating' => '创建中', 'Available' => '可用', 'CreateFailed' => '创建失败'],
'example' => 'Available',
],
'Progress' => ['description' => '镜像创建完成的进度。单位:%。', 'type' => 'string', 'example' => '100%'],
'DataDiskSize' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '150'],
'ImageType' => [
'description' => '镜像类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统镜像', 'CUSTOM' => '自定义镜像'],
'example' => 'SYSTEM',
],
'Description' => ['description' => '镜像描述。', 'type' => 'string', 'example' => 'This is description.'],
'Size' => ['description' => '镜像大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
'OsType' => ['description' => '操作系统类型。'."\n", 'type' => 'string', 'example' => 'WINDOWS'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议 [推荐]'],
'example' => 'ASP',
],
'Name' => ['description' => '镜像名称。', 'type' => 'string', 'example' => 'testImageName'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-gx2x1dhsmusr2****'],
'GpuCategory' => ['description' => '是否为GPU类型镜像。', 'type' => 'boolean', 'example' => 'false'],
'SupportedLanguages' => [
'description' => '操作系统语言。',
'type' => 'array',
'items' => [
'description' => '操作系统语言。可包含一种或多种。',
'type' => 'string',
'enumValueTitles' => ['en-US' => '英文', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日文'],
'example' => 'en-US',
],
],
'GpuDriverVersion' => ['description' => 'GPU驱动版本号。', 'type' => 'string', 'example' => '417.22'],
'AppVersion' => ['description' => '镜像版本。', 'type' => 'string', 'example' => '1.0.0'],
'VolumeEncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
'SharedCount' => ['description' => '已共享的镜像数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SessionType' => [
'description' => '镜像会话类型。',
'type' => 'string',
'enumValueTitles' => ['SINGLE_SESSION' => '单会话镜像', 'MULTIPLE_SESSION' => '多会话镜像'],
'example' => 'MULTIPLE_SESSION',
],
'UpdateTime' => ['description' => '最后修改镜像的时间。', 'type' => 'string', 'example' => '2021-12-22T02:48:43Z'],
'Platform' => [
'description' => '镜像的操作系统类型。',
'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',
],
],
],
],
],
],
],
],
'title' => '查询镜像的详细信息',
'summary' => '查询镜像的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-06-13T12:35:16.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-01-04T02:42:47.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-22T06:06:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更、错误码发生变更'],
['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-10-28T11:22:53.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImages'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeImages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\",\\n \\"Images\\": [\\n {\\n \\"CreationTime\\": \\"2018-01-10T01:01:10Z\\",\\n \\"Status\\": \\"Available\\",\\n \\"Progress\\": \\"100%\\",\\n \\"DataDiskSize\\": 150,\\n \\"ImageType\\": \\"SYSTEM\\",\\n \\"Description\\": \\"This is description.\\",\\n \\"Size\\": 40,\\n \\"OsType\\": \\"WINDOWS\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"Name\\": \\"testImageName\\",\\n \\"ImageId\\": \\"m-gx2x1dhsmusr2****\\",\\n \\"GpuCategory\\": false,\\n \\"SupportedLanguages\\": [\\n \\"en-US\\"\\n ],\\n \\"GpuDriverVersion\\": \\"417.22\\",\\n \\"AppVersion\\": \\"1.0.0\\",\\n \\"VolumeEncryptionEnabled\\": false,\\n \\"VolumeEncryptionKey\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"SharedCount\\": 1,\\n \\"SessionType\\": \\"MULTIPLE_SESSION\\",\\n \\"UpdateTime\\": \\"2021-12-22T02:48:43Z\\",\\n \\"Platform\\": \\"Windows Server 2019\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\n \\n 2018-01-10T01:01:10Z\\n Available\\n \\n 150\\n SYSTEM\\n This is description.\\n 40\\n WINDOWS\\n HDX\\n testImageName\\n m-gx2x1dhsmusr2****\\n false\\n en-US\\n \\n","errorExample":""}]',
],
'DescribeInvocations' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InvokeId',
'in' => 'query',
'schema' => ['description' => '脚本进程执行ID。取自[RunCommand](~~RunCommand~~)的返回参数。', 'type' => 'string', 'required' => false, 'example' => 't-hz0jdfwd9f****'],
],
[
'name' => 'CommandType',
'in' => 'query',
'schema' => [
'description' => '运维脚本的命令类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RunPowerShellScript' => '运行PowerShell脚本', 'RunBatScript' => '运行Bat脚本'],
'example' => 'RunPowerShellScript',
],
],
[
'name' => 'InvokeStatus',
'in' => 'query',
'schema' => [
'description' => '脚本执行的总执行状态。总执行状态取决于创建执行中的一台或多台云电脑的共同执行状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Finished' => '所有云电脑全部完成执行。或者手动停止部分云电脑的脚本进程,其余云电脑全部执行完成', 'Stopped' => '停止执行脚本', 'Failed' => '所有云电脑全部执行失败', 'Running' => '一旦有进行中的脚本进程,总的执行状态就为进行中 [默认值]', 'PartialFailed' => '部分云电脑有执行失败的脚本进程,则总执行状态为部分失败'],
'example' => 'Finished',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。如果指定了云电脑,则查询该云电脑所有的脚本执行记录。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'],
],
[
'name' => 'IncludeOutput',
'in' => 'query',
'schema' => [
'description' => '是否在结果中返回脚本运行的输出信息。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '返回', 'false' => '不返回 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'ContentEncoding',
'in' => 'query',
'schema' => [
'description' => '返回数据的编码方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Base64' => '返回Base64编码后的脚本内容和输出信息 [默认值]', 'PlainText' => '返回原始脚本内容和输出信息'],
'example' => 'PlainText',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:50。'."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '50', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。'."\n"
."\n"
.'> `DesktopId`参数即将弃用,请使用当前参数传递云电脑ID列表信息。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****'],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'IncludeInvokeDesktops',
'in' => 'query',
'schema' => [
'description' => '远程命令在多台云电脑上执行的情况下,是否返回所有云电脑的执行结果。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '返回', 'false' => '不返回'],
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '本次调用返回的查询凭证值。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'Invocations' => [
'description' => '脚本执行记录数组。',
'type' => 'array',
'items' => [
'description' => '脚本执行记录对象。',
'type' => 'object',
'properties' => [
'InvokeId' => ['description' => '执行ID。', 'type' => 'string', 'example' => 't-hz0jdfwd9f****'],
'CommandContent' => ['description' => '脚本内容,以Base64编码后传输。', 'type' => 'string', 'example' => 'cnBtIC1xYSB8IGdyZXAgdnNm****'],
'CommandType' => ['description' => '脚本类型。', 'type' => 'string', 'example' => 'RunPowerShellScript'],
'InvocationStatus' => ['description' => '脚本执行的总执行状态,总执行状态取决于本次调用的全部云电脑的共同执行状态,可能值:'."\n"
."\n"
.'- Pending:系统正在校验或发送命令。存在至少一台云电脑的脚本执行状态为Pending,则总执行状态为Pending。'."\n"
.'- Running:命令正在云电脑上运行。存在至少一台云电脑的脚本执行状态为Running,则总执行状态为Running。'."\n"
.'- Success:各个云电脑上的脚本执行状态均为Stopped或Success,且至少一个云电脑的脚本执行状态是Success,则总执行状态为Success。'."\n"
.'- Failed:各个云电脑上的脚本执行状态均为Stopped或Failed,则总执行状态为Failed。云电脑上的脚本执行状态一项或多项为以下状态时,返回值均为Failed状态:'."\n"
.' - 命令校验失败(Invalid)'."\n"
.' - 命令发送失败(Aborted)'."\n"
.' - 命令执行完成但退出码非0(Failed)'."\n"
.' - 命令执行超时(Timeout)'."\n"
.' - 命令执行异常(Error)'."\n"
.'- Stopping:正在停止任务。存在至少一台实例的脚本执行状态为Stopping,则总执行状态为Stopping。'."\n"
.'- Stopped:任务已停止。所有实例的脚本执行状态是Stopped,则总执行状态为Stopped。实例上的脚本执行状态为以下状态时,返回值均为Stopped状态:'."\n"
.' - 任务已取消(Cancelled)'."\n"
.' - 任务已终止(Terminated)'."\n"
.'- PartialFailed:部分实例执行成功且部分实例执行失败。各个实例的脚本执行状态均为Success、Failed或Stopped,则总执行状态为PartialFailed。', 'type' => 'string', 'example' => 'Pending'],
'CreationTime' => ['description' => '任务的创建时间。', 'type' => 'string', 'example' => '2020-12-19T09:15:46Z'],
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'User1'],
'InvokeDesktops' => [
'description' => '执行目标云电脑列表。',
'type' => 'array',
'items' => [
'description' => '执行目标云电脑。',
'type' => 'object',
'properties' => [
'InvocationStatus' => ['description' => '单台云电脑的脚本进度状态。', 'type' => 'string', 'example' => 'Success'],
'Output' => ['description' => '脚本进程的输出信息。'."\n"
."\n"
.'- 如果请求参数`IncludeOutput`设置为false,则不返回Output。'."\n"
.'- 如果请求参数`ContentEncoding`设置为Base64,则Output为Base64编码后的输出信息。', 'type' => 'string', 'example' => 'OutPutTestmsg'],
'CreationTime' => ['description' => '脚本进程的创建时间。', 'type' => 'string', 'example' => '2020-12-20T06:15:54Z'],
'UpdateTime' => ['description' => '任务状态的更新时间。', 'type' => 'string', 'example' => '2020-12-25T06:15:56Z'],
'Repeats' => ['description' => '命令在该云电脑上执行的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-7w78ozhjcwa3u****'],
'Dropped' => ['description' => 'Output字段中文字长度超出24 KB后,截断丢弃的文字长度。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'StartTime' => ['description' => '脚本进程在云电脑中开始执行的时间。', 'type' => 'string', 'example' => '2020-12-20T06:15:55Z'],
'StopTime' => ['description' => '如果调用了StopInvocation,则表示停止执行的时间。', 'type' => 'string', 'example' => '2020-12-25T09:15:47Z'],
'FinishTime' => ['description' => '脚本进程的结束时间。', 'type' => 'string', 'example' => '2020-12-20T06:15:56Z'],
'ExitCode' => ['description' => '脚本进程的退出代码。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ErrorCode' => ['description' => '命令的下发失败或执行失败原因的代码,可能值:'."\n"
."\n"
.'- 空:命令运行正常。'."\n"
.'- InstanceNotExists:指定的云电脑不存在或已释放。'."\n"
.'- InstanceReleased:执行任务期间,该云电脑被释放。'."\n"
.'- InstanceNotRunning:创建任务时,该云电脑不在运行。'."\n"
.'- CommandNotApplicable:命令不适用于指定的云电脑。'."\n"
.'- ClientNotRunning:云助手客户端未运行。'."\n"
.'- ClientNotResponse:云助手客户端无响应。'."\n"
.'- ClientIsUpgrading:云助手客户端正在升级中。'."\n"
.'- ClientNeedUpgrade:云助手客户端需要升级。'."\n"
.'- DeliveryTimeout:发送命令超时。'."\n"
.'- ExecutionTimeout:命令运行超时。'."\n"
.'- ExecutionException:命令运行发生异常。'."\n"
.'- ExecutionInterrupted:命令运行任务中断。'."\n"
.'- ExitCodeNonzero:命令执行结束,退出码非0。', 'type' => 'string', 'example' => 'InstanceNotExists'],
'ErrorInfo' => ['description' => '命令的下发失败或执行失败原因的详情,可能值:'."\n"
."\n"
.'- 空:命令运行正常。'."\n"
.'- the specified instance does not exists:指定的云电脑不存在或已释放。'."\n"
.'- the instance has released when create task:执行任务期间,该云电脑被释放。'."\n"
.'- the instance is not running when create task:创建任务时,该云电脑不在运行。'."\n"
.'- the command is not applicable:命令不适用于指定的云电脑。'."\n"
.'- the aliyun service is not running on the instance:云助手客户端未运行。'."\n"
.'- the aliyun service in the instance does not response:云助手客户端无响应。'."\n"
.'- the aliyun service in the instance is upgrading now:云助手客户端正在升级中。'."\n"
.'- the aliyun service in the instance need upgrade:云助手客户端需要升级。'."\n"
.'- the command delivery has been timeout:发送命令超时。'."\n"
.'- the command execution has been timeout:命令运行超时。'."\n"
.'- the command execution got an exception:命令运行发生异常。'."\n"
.'- the command execution has been interrupted:命令运行任务中断。'."\n"
.'- the command execution exit code is not zero:命令执行结束,退出码非0。', 'type' => 'string', 'example' => 'The specified instance does not exist.'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'demo1234'],
],
],
],
'InvokeDesktopCount' => ['description' => '执行脚本的云电脑总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'InvokeDesktopSucceedCount' => ['description' => '执行脚本成功的云电脑总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
],
'title' => '查询云助手脚本的执行列表和状态',
'summary' => '用于查询云助手脚本的执行列表和状态。',
'description' => '- 当您执行命令后,不代表命令一定成功执行,并且一定有预期的命令效果。您需要通过接口返回值来查看实际执行结果,以实际输出结果为准。'."\n"
.'- 您可以查询最近2周的执行信息,执行信息的保留上限为10万条。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-08-13T06:29:27.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-05-18T06:09:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-18T15:09:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-29T06:07:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-30T12:11:00.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\",\\n \\"Invocations\\": [\\n {\\n \\"InvokeId\\": \\"t-hz0jdfwd9f****\\",\\n \\"CommandContent\\": \\"cnBtIC1xYSB8IGdyZXAgdnNm****\\",\\n \\"CommandType\\": \\"RunPowerShellScript\\",\\n \\"InvocationStatus\\": \\"Pending\\",\\n \\"CreationTime\\": \\"2020-12-19T09:15:46Z\\",\\n \\"EndUserId\\": \\"User1\\",\\n \\"InvokeDesktops\\": [\\n {\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"Output\\": \\"OutPutTestmsg\\",\\n \\"CreationTime\\": \\"2020-12-20T06:15:54Z\\",\\n \\"UpdateTime\\": \\"2020-12-25T06:15:56Z\\",\\n \\"Repeats\\": 0,\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\",\\n \\"Dropped\\": 0,\\n \\"StartTime\\": \\"2020-12-20T06:15:55Z\\",\\n \\"StopTime\\": \\"2020-12-25T09:15:47Z\\",\\n \\"FinishTime\\": \\"2020-12-20T06:15:56Z\\",\\n \\"ExitCode\\": 0,\\n \\"ErrorCode\\": \\"InstanceNotExists\\",\\n \\"ErrorInfo\\": \\"The specified instance does not exist.\\",\\n \\"DesktopName\\": \\"demo1234\\"\\n }\\n ],\\n \\"InvokeDesktopCount\\": 1,\\n \\"InvokeDesktopSucceedCount\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n \\n 2020-12-19T09:15:46Z\\n cnBtIC1xYSB8IGdyZXAgdnNm****\\n Pending\\n RunPowerShellScript\\n t-hz0jdfwd9f****\\n \\n \\n \\n 0\\n Success\\n the specified instance does not exists\\n 0\\n 2020-12-20T06:15:55Z\\n ecd-7w78ozhjcwa3u****\\n 0\\n 2020-12-20T06:15:56Z\\n \\n 2020-12-25T06:15:56Z\\n 2020-12-20T06:15:54Z\\n InstanceNotExists\\n 2020-12-25T09:15:47Z\\n \\n \\n","errorExample":""}]',
],
'DescribeKmsKeys' => [
'summary' => '查询用户KMS密钥列表。如果是第一次访问,将尝试创建一个EDS的服务密钥,并返回结果。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'KmsServiceStatus' => [
'description' => 'KMS服务状态。',
'type' => 'string',
'enumValueTitles' => ['disabled ' => '未开启服务', 'enabled ' => '已开启服务'],
'example' => 'enabled',
],
'AuthorizeStatus' => [
'description' => '授权状态。',
'type' => 'string',
'enumValueTitles' => ['not_authorized' => '未完成授权', 'authorized' => '授权完成'],
'example' => 'authorized',
],
'Keys' => [
'description' => '用户主密钥CMK(Customer Master Key)。',
'type' => 'array',
'items' => [
'description' => '用户主密钥CMK(Customer Master Key)。',
'type' => 'object',
'properties' => [
'KeyId' => ['description' => '密钥ID。', 'type' => 'string', 'example' => '05754286-3ba2-4fa6-8d41-4323aca6****'],
'Arn' => ['description' => 'ARN资源描述。', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:key/05754286-3ba2-4fa6-8d41-4323aca6****'],
'Alias' => ['description' => '密钥别名。', 'type' => 'string', 'example' => 'TestAlias'],
'Type' => [
'description' => '密钥类型。',
'type' => 'string',
'enumValueTitles' => ['ServiceKey ' => '服务密钥', 'CustomKey ' => '用户密钥'],
'example' => 'ServiceKey',
],
],
],
],
],
],
],
],
'title' => '查询用户KMS密钥列表',
'changeSet' => [
['createdAt' => '2022-05-23T04:01:14.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeKmsKeys'],
],
],
'ramActions' => [],
'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"}]',
],
'DescribeModificationPrice' => [
'summary' => '查询按月购买不限时长云电脑或公网精品带宽的变配价格。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['cn-hangzhou' => 'cn-hangzhou'],
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID,可以是按月购买(不限时长)云电脑ID或者公网精品带宽ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-0gfv2z3sf95zvt****'],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => ['description' => '资源规格。'."\n"
."\n"
.'- 当`ResourceType`为`Desktop`时,枚举值包括:'."\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"
.'- 当`ResourceType`为`NetworkPackage`时,可以不传入该参数。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'eds.enterprise_office.8c16g'],
],
[
'name' => 'RootDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '系统盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '80'],
],
[
'name' => 'UserDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '50'],
],
[
'name' => 'RootDiskPerformanceLevel',
'in' => 'query',
'schema' => ['description' => '系统盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
],
[
'name' => 'UserDiskPerformanceLevel',
'in' => 'query',
'schema' => ['description' => '数据盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。要查询变配价格的资源类型不同时,必需参数也有所不同:'."\n"
."\n"
.'- 当`ResourceType`=`Desktop`时,必须传入参数`InstanceType`、`RootDiskSizeGib`、`UserDiskSizeGib`。'."\n"
.'- 当`ResourceType`=`NetworkPackage`时,必须传入参数`Bandwidth`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Desktop' => '云电脑 [默认值]', 'NetworkPackage' => '公网精品带宽'],
'example' => 'Desktop',
],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网带宽峰值。单位:Mbps。'."\n"
."\n"
.'> 按固定带宽计费时,取值范围为10\\~1000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3072', 'minimum' => '2', 'example' => '20'],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
],
[
'name' => 'ResourceSpecs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源规格模板列表。',
'type' => 'array',
'items' => [
'description' => '资源规格模板列表。',
'type' => 'object',
'properties' => [
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-6ghhzivgmnzgeyXXX'],
'RootDiskSizeGib' => ['description' => '系统盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
'UserDiskSizeGib' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['description' => '转售模式的资源归属用户ID,非转售模式无需填写该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1422724566551XXX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****'],
'PriceInfo' => [
'description' => '价格详细信息。',
'type' => 'object',
'properties' => [
'Rules' => [
'description' => '活动规则信息。',
'type' => 'array',
'items' => [
'description' => '活动规则信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => '买满1年,立享官网价格8.5折优惠。'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14806'],
],
],
],
'Price' => [
'description' => '价格信息。',
'type' => 'object',
'properties' => [
'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '79.0'],
'DiscountPrice' => ['description' => '折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '15.8'],
'Currency' => ['description' => '货币单位(CNY)。'."\n"
.'货币单位(USD)。', 'type' => 'string', 'example' => 'CNY'],
'TradePrice' => ['description' => '实际付款价格。取值为原价减去折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '63.2'],
'Promotions' => [
'description' => '促销活动信息列表。',
'type' => 'array',
'items' => [
'description' => '促销活动信息。',
'type' => 'object',
'properties' => [
'PromotionDesc' => ['description' => '促销信息描述。', 'type' => 'string', 'example' => '新品上市,立享优惠'],
'OptionCode' => ['description' => '促销活动规则描述。', 'type' => 'string', 'example' => 'test'],
'Selected' => ['description' => '是否被选中。', 'type' => 'boolean', 'example' => 'false'],
'PromotionId' => ['description' => '促销活动ID。', 'type' => 'string', 'example' => 'promo_option'],
'PromotionName' => ['description' => '促销活动名称。', 'type' => 'string', 'example' => 'Featured deals'],
],
],
],
'OrderLines' => [
'description' => '订单信息。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '订单信息。', '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\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]',
'title' => '查询变配价格',
'changeSet' => [
['createdAt' => '2025-11-04T08:21:23.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-09T03:02:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-29T01:40:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-12T08:48:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:50.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeModificationPrice'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeModificationPrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeNASFileSystems' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'NAS文件系统ID列表。',
'type' => 'array',
'items' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'required' => false, 'example' => '04f314****'],
'required' => false,
'example' => '04f314****',
'maxItems' => 100,
],
],
[
'name' => 'MatchCompatibleProfile',
'in' => 'query',
'schema' => ['description' => '是否在查询结果中仅包含只支持UPM的NAS文件系统。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
'FileSystems' => [
'description' => 'NAS文件系统信息集合。',
'type' => 'array',
'items' => [
'description' => 'NAS文件系统信息。',
'type' => 'object',
'properties' => [
'Capacity' => ['description' => 'NAS文件系统总容量,单位为GiB。'."\n"
."\n"
.'- 若存储规格为容量型,则容量固定为10 PiB,即10485760 GiB。'."\n"
.'- 若存储规格为性能型,则容量固定为1 PiB,即1048576 GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '10485760'],
'MountTargetStatus' => [
'description' => '挂载点状态。',
'type' => 'string',
'enumValueTitles' => ['Active' => '已激活', 'Inactive' => '未激活', 'Pending' => '创建中', 'Deleting' => '删除中', 'Invalid' => '已失效'],
'example' => 'Active',
],
'CreateTime' => ['description' => 'NAS文件系统的创建时间。', 'type' => 'string', 'example' => '2021-05-10T11:39Z'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'SupportAcl' => ['description' => '是否支持开启SMB ACL功能。', 'type' => 'boolean', 'example' => 'false'],
'StorageType' => [
'description' => 'NAS文件系统的存储规格。',
'type' => 'string',
'enumValueTitles' => ['Capacity' => '容量型', 'Performance' => '性能型'],
'example' => 'Capacity',
],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'test'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'FileSystemId' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'example' => '04f314****'],
'FileSystemType' => [
'description' => 'NAS文件系统的类型,目前仅支持通用型,即`standard`。',
'type' => 'string',
'enumValueTitles' => ['standard' => '通用型'],
'example' => 'standard',
],
'FileSystemName' => ['description' => 'NAS文件系统名称。', 'type' => 'string', 'example' => 'testNAS'],
'MeteredSize' => ['description' => 'NAS文件系统已使用的容量。单位:Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MountTargetDomain' => ['description' => '挂载点域名。', 'type' => 'string', 'example' => '04f314****-at***.cn-hangzhou.nas.aliyuncs.com'],
'Description' => ['description' => 'NAS文件系统描述。', 'type' => 'string', 'example' => 'testDescription'],
'ZoneId' => ['description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-f'],
'FileSystemStatus' => [
'description' => 'NAS文件系统状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已停止', 'Running' => '运行中', 'Deleted' => '已删除', 'Pending' => '创建中', 'Deleting' => '删除中', 'Invalid' => '已失效'],
'example' => 'Running',
],
'EncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'false'],
'ProfileCompatible' => ['description' => '是否支持UPM(User Profile Management)功能。', 'type' => 'boolean', 'example' => 'false'],
'DesktopGroups' => [
'description' => '支持UPM的NAS绑定的共享型云电脑对象列表。',
'type' => 'array',
'items' => [
'description' => '共享型云电脑对象信息。',
'type' => 'object',
'properties' => [
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-9eeyf15b25nyl****'],
'DesktopGroupName' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'example' => 'test_dg'],
],
],
],
'Scene' => [
'description' => 'NAS文件系统的存储方式。',
'type' => 'string',
'enumValueTitles' => ['Upm' => 'UPM NAS', 'ShareNas' => '共享存储NAS'],
'example' => 'Upm',
],
'AppInstanceGroups' => [
'description' => '支持UPM的NAS绑定的云应用交付组对象列表。',
'type' => 'array',
'items' => [
'description' => '支持UPM的NAS绑定的云应用交付组对象信息。',
'type' => 'object',
'properties' => [
'AppInstanceGroupId' => ['description' => '交付组ID。', 'type' => 'string', 'example' => 'aig-0bz55ibznu9p7****'],
'AppInstanceGroupName' => ['description' => '交付组名称。', 'type' => 'string', 'example' => 'DemoDeliveryGroup'],
],
],
],
'AllowOperateUserDrive' => ['description' => '> 该字段不对外开放使用。', 'type' => 'boolean'],
'SizeQuota' => ['type' => 'integer', 'format' => 'int64'],
'OfficeSites' => [
'description' => '办公网络列表。',
'type' => 'array',
'items' => [
'description' => '办公网络。',
'type' => 'object',
'properties' => [
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'DemoOfficeNetwork'],
],
],
],
'ProductType' => ['type' => 'string'],
],
],
],
],
],
],
],
'title' => '查询NAS文件系统信息',
'summary' => '查询NAS文件系统信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-12-19T08:10:57.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-27T01:45:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-27T01:32:48.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNASFileSystems'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeNASFileSystems',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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 \\"SizeQuota\\": 0,\\n \\"OfficeSites\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"OfficeSiteName\\": \\"DemoOfficeNetwork\\"\\n }\\n ],\\n \\"ProductType\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n false\\n testDescription\\n Capacity\\n cn-hangzhou-f\\n 2021-05-10T11:39Z\\n Active\\n 0\\n cn-hangzhou+dir-363353****\\n 04f314****-at***.cn-hangzhou.nas.aliyuncs.com\\n 10485760\\n standard\\n Running\\n testNAS\\n 04f314****\\n test\\n cn-hangzhou\\n\\n269BDB16-2CD8-4865-84BD-11C40BC21DB0\\ncaeba0bbb2be03f84eb48b699f0a4883\\n","errorExample":""}]',
],
'DescribeNetworkPackages' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '公网精品带宽ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => false, 'example' => 'np-amtp8e8q1o9e4****'],
'required' => false,
'example' => 'np-amtp8e8q1o9e4****',
'maxItems' => 100,
],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
'schema' => [
'description' => '按量付费公网精品带宽的计费方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PayByTraffic' => '按使用流量计费', 'PayByBandwidth' => '按固定带宽计费'],
'example' => 'PayByBandwidth',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['type' => 'string'],
'Value' => ['type' => 'string'],
],
],
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'],
'NetworkPackages' => [
'description' => '公网精品带宽信息列表。',
'type' => 'array',
'items' => [
'description' => '公网精品带宽信息。',
'type' => 'object',
'properties' => [
'NetworkPackageId' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****'],
'Bandwidth' => ['description' => '公网精品带宽的带宽大小。单位:Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ExpiredTime' => ['description' => '公网精品带宽到期时间。'."\n"
."\n"
.'- 如果是包年包月公网精品带宽,则返回实际的到期时间。'."\n"
.'- 如果是按量付费公网精品带宽,则返回`2099-12-31T15:59:59Z`。', 'type' => 'string', 'example' => '2099-12-31T15:59:59Z'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2021-05-10T02:35:26Z'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'PayType' => [
'description' => '付费类型。',
'type' => 'string',
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PostPaid',
],
'InternetChargeType' => [
'description' => '公网精品带宽的计费方式。'."\n"
."\n"
.'- 当参数`PayType`取值为`PrePaid`时,取值范围:'."\n"
.' - PayByBandwidth:按固定带宽计费。'."\n"
.'- 当参数`PayType`取值为`PostPaid`时,取值范围:'."\n"
.' - PayByTraffic:按使用流量计费。'."\n"
.' - PayByBandwidth:按固定带宽计费。',
'type' => 'string',
'enumValueTitles' => ['PayByTraffic' => '按使用流量计费', 'PayByBandwidth' => '按固定带宽计费'],
'example' => 'PayByTraffic',
],
'ReservationInternetChargeType' => [
'description' => '预留网络带宽的计费方式。',
'type' => 'string',
'enumValueTitles' => ['PayByTraffic' => '按使用流量计费', 'PayByBandwidth' => '按固定带宽计费'],
'example' => 'PayByBandwidth',
],
'ReservationBandwidth' => ['description' => '预留网络带宽峰值。单位:Mbps。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'ReservationActiveTime' => ['description' => '预留网络带宽生效时间。', 'type' => 'string', 'example' => '2021-07-10T00:00:00Z'],
'NetworkPackageStatus' => [
'description' => '公网精品带宽状态。',
'type' => 'string',
'enumValueTitles' => ['Creating' => '创建中', 'Released' => '已释放', 'InUse' => '使用中', 'Releasing' => '释放中'],
'example' => 'InUse',
],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'default'],
'OfficeSiteVpcType' => [
'description' => '办公网络类型。',
'type' => 'string',
'enumValueTitles' => ['standard' => '高级办公网络', 'customized' => '定制办公网络', 'basic' => '基础办公网络'],
'example' => 'basic',
],
'EipAddresses' => [
'description' => '公网精品带宽的公网出口IP地址。',
'type' => 'array',
'items' => ['description' => '公网精品带宽的公网出口IP地址。', 'type' => 'string', 'example' => '120.2.XX.XX'],
],
'BusinessStatus' => [
'description' => '业务状态。',
'type' => 'string',
'enumValueTitles' => ['Expired' => '到期', 'Normal' => '正常'],
'example' => 'Normal',
],
'Tags' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['type' => 'string'],
'Value' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
],
'title' => '查询公网精品带宽的详细信息',
'summary' => '查询一个或者多个公网精品带宽的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-10-26T06:48:41.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-30T03:32:28.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-07-28T02:06:26.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNetworkPackages'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeNetworkPackages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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 \\"Tags\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\ncaeba0bbb2be03f84eb48b699f0a4883\\n\\n cn-hangzhou+dir-363353****\\n np-amtp8e8q1o9e4****\\n 2099-12-31T15:59:59Z\\n 2021-05-10T02:35:26Z\\n 10\\n test\\n InUse\\n PayByTraffic\\n\\n","errorExample":""}]',
],
'DescribeOfficeSites' => [
'summary' => '查询办公网络的所有属性,包括ID、名称、状态、创建时间等。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteType',
'in' => 'query',
'schema' => [
'description' => '办公网络的账号体系类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'SIMPLE',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '办公网络ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
'required' => false,
'example' => 'cn-hangzhou+dir-363353****',
'maxItems' => 100,
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '办公网络状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['REGISTERING' => '注册中', 'DEREGISTERING' => '取消中', 'REGISTERED' => '已注册', 'NEEDCONFIGTRUST' => '需要配置信任关系', 'CONFIGTRUSTFAILED' => '配置信任关系失败', 'DEREGISTERED' => '已取消', 'ERROR' => '配置错误', 'CONFIGTRUSTING' => '配置信任关系中', 'NEEDCONFIGUSER' => '需要配置用户'],
'example' => 'REGISTERED',
],
],
[
'name' => 'SecurityProtection',
'in' => 'query',
'schema' => [
'description' => '办公网络安全防护配置。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SASE' => 'SASE', 'OFF' => '关闭'],
'example' => 'SASE',
],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AccountType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token。NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'OfficeSites' => [
'description' => '办公网络信息集合。',
'type' => 'array',
'items' => [
'description' => '办公网络对象。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '办公网络状态。',
'type' => 'string',
'enumValueTitles' => ['REGISTERING' => '注册中', 'DEREGISTERING' => '取消中', 'REGISTERED' => '已注册', 'NEEDCONFIGTRUST' => '需要配置信任关系', 'CONFIGTRUSTFAILED' => '配置信任关系失败', 'DEREGISTERED' => '已取消', 'ERROR' => '配置错误', 'CONFIGTRUSTING' => '配置信任关系中', 'NEEDCONFIGUSER' => '需要配置用户'],
'example' => 'REGISTERED',
],
'CreationTime' => ['description' => '办公网络创建时间。', 'type' => 'string', 'example' => '2021-05-06T05:58Z'],
'VpcId' => ['description' => '安全办公网络VPC ID。', 'type' => 'string', 'example' => 'vpc-uf6tz5k67puge5jn8****'],
'VpcType' => [
'description' => 'VPC的使用方式。',
'type' => 'string',
'enumValueTitles' => ['Basic' => '基础型', 'Customized' => '定制型', 'Standard' => '标准型'],
'example' => 'Basic',
],
'EnableAdminAccess' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'true',
],
'EnableCrossDesktopAccess' => ['description' => '是否开启办公网络内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。', 'type' => 'boolean', 'example' => 'false'],
'DesktopVpcEndpoint' => ['description' => 'VPC连接云电脑时所使用的终端节点。', 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com'],
'DesktopAccessType' => [
'description' => '连接云电脑时允许使用的接入方式。'."\n"
."\n"
.'> VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为`VPC`或者`Any`时,系统将自动为您开通私网连接服务。',
'type' => 'string',
'enumValueTitles' => ['INTERNET' => '只允许客户端通过公网连接云电脑。[默认值]', 'VPC' => '只允许处于VPC网络内的客户端连接云电脑。', 'ANY' => '不限制方式。使用客户端连接云电脑时可以自行选择连接方式。'],
'example' => 'INTERNET',
],
'SsoEnabled' => ['description' => '是否开启单点登录SSO。'."\n"
."\n", 'type' => 'boolean', 'example' => 'false'],
'CidrBlock' => ['description' => '办公网络VPC所包含的IPv4网段。', 'type' => 'string', 'example' => '47.100.XX.XX'],
'Bandwidth' => ['description' => '公网带宽峰值。可能值:0~1000Mbps。 '."\n"
.'如果为空或0,则表示没有开通互联网访问。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TrustPassword' => ['description' => '> 该参数暂未开放使用。', 'type' => 'string', 'example' => 'To be hidden.'],
'Name' => ['description' => '办公网络名称。同一地域下,该名称唯一。', 'type' => 'string', 'example' => 'test'],
'EnableInternetAccess' => ['description' => '是否已开通公网访问功能。', 'type' => 'boolean', 'example' => 'false'],
'DomainPassword' => ['description' => '域管理员的用户密码。', 'type' => 'string', 'example' => 'testPassword'],
'CustomSecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-bp1ce64o4g9mdf5u****'],
'OuName' => ['description' => '对接AD域中的组织单元。', 'type' => 'string', 'example' => 'example.com/Domain Controllers'],
'DomainUserName' => ['description' => '域管理员的用户名。', 'type' => 'string', 'example' => 'Administrator'],
'SubDomainName' => ['description' => 'AD子域DNS的用户名。', 'type' => 'string', 'example' => 'testSubDnsUserName'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'CenId' => ['description' => '云企业网实例ID。', 'type' => 'string', 'example' => 'cen-3gwy16dojz1m65****'],
'CenAttachStatus' => ['description' => '云企业网CEN的状态。', 'type' => 'string', 'example' => 'attached'],
'MfaEnabled' => ['description' => '是否开启多因素认证MFA。', 'type' => 'boolean', 'example' => 'false'],
'NetworkPackageId' => ['description' => '互联网访问包ID。', 'type' => 'string', 'example' => 'np-amtp8e8q1o9e4****'],
'DnsUserName' => ['description' => 'DNS用户名。', 'type' => 'string', 'example' => 'testDnsUserName '],
'OfficeSiteType' => [
'description' => '办公网络账号体系类型。',
'type' => 'string',
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'AD_CONNECTOR',
],
'ADConnectors' => [
'description' => 'AD Connector的信息集合。',
'type' => 'array',
'items' => [
'description' => 'AD Connector对象。',
'type' => 'object',
'properties' => [
'ConnectorStatus' => [
'description' => 'AD Connector的状态。',
'type' => 'string',
'enumValueTitles' => ['CONNECT_ERROR' => '连接错误', 'RUNNING' => '运行中', 'CONNECTING' => '连接中。需要完成AD域配置。', 'EXPIRED' => '欠费过期', 'CREATING' => '创建中'],
'example' => 'RUNNING',
],
'VSwitchId' => ['description' => 'AD Connector所在网络对应的交换机ID。', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****'],
'ADConnectorAddress' => ['description' => 'AD Connector的连接地址。', 'type' => 'string', 'example' => '172.24.*.*'],
'TrustKey' => ['description' => '配置AD信任关系时设置的信任密码。', 'type' => 'string', 'example' => 'password123***'],
'NetworkInterfaceId' => ['description' => 'AD Connector挂载的网卡ID。', 'type' => 'string', 'example' => 'eni-bp1i4wx78lgosrj6****'],
'Specification' => [
'description' => 'AD Connector规格。',
'type' => 'string',
'enumValueTitles' => [1 => '通用型', '高级型'],
'example' => '1',
],
],
],
],
'Logs' => [
'description' => '注册日志信息。',
'type' => 'array',
'items' => [
'description' => '注册日志对象。',
'type' => 'object',
'properties' => [
'Step' => ['description' => '日志信息对应的步骤。', 'type' => 'string', 'example' => 'CREATE_CONNECTOR'],
'Message' => ['description' => '日志详细信息。', 'type' => 'string', 'example' => 'code:success | message:Create Connector complete'],
'TimeStamp' => ['description' => '日志打印时间。', 'type' => 'string', 'example' => '2021-05-12T09:42Z'],
'Level' => [
'description' => '日志级别。',
'type' => 'string',
'enumValueTitles' => ['ERROR' => '错误', 'INFO' => '信息', 'WARN' => '警告'],
'example' => 'INFO',
],
],
],
],
'VSwitchIds' => [
'description' => '交换机ID数组。',
'type' => 'array',
'items' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bp19ocz3erfx15uon****'],
],
'FileSystemIds' => [
'description' => 'NAS文件系统ID数组。',
'type' => 'array',
'items' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'example' => '["05b534****"]'],
],
'SubDnsAddress' => [
'description' => 'AD子域的DNS地址数组。',
'type' => 'array',
'items' => ['description' => 'AD子域的DNS地址。', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]'],
],
'DnsAddress' => [
'description' => 'AD域对应的DNS地址数组。',
'type' => 'array',
'items' => ['description' => 'AD域对应的DNS地址。', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]'],
],
'CustomDnsAddress' => [
'description' => '自定义DNS地址数组。',
'type' => 'array',
'items' => ['description' => '自定义DNS地址。', 'type' => 'string', 'example' => ' ["172.24.XX.XX"]'],
],
'NeedVerifyLoginRisk' => ['description' => '仅适用于便捷账号办公网络,表示登录时是否需要二次验证。如果开启了登录二次验证,则便捷用户登录客户端时,系统将检测登录账号是否有安全风险。如果有风险,系统将发送验证码到该账号关联的邮箱,便捷用户使用验证码验证通过后才能登录客户端。', 'type' => 'boolean', 'example' => 'false'],
'DesktopCount' => ['description' => '已创建的云电脑数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalEdsCount' => ['description' => '云电脑数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalEdsCountForGroup' => ['description' => '共享型云电脑内的云电脑数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'NeedVerifyZeroDevice' => [
'description' => '是否开启可信设备校验。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '开启', 'false' => '不开启'],
'example' => 'true',
],
'CloudBoxOfficeSite' => [
'description' => '是否为云盒办公网络。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '云盒办公网络', 'false' => '公网办公网络'],
'example' => 'true',
],
'SsoType' => [
'description' => 'SSO类型。',
'type' => 'string',
'enumValueTitles' => ['SAML' => 'SAML'],
'example' => 'SAML',
],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
'AdHostname' => ['description' => '域控主机名。'."\n"
.'必须符合Windows主机命名规范。', 'type' => 'string', 'example' => 'beijing-ad01'],
'RdsLicenseStatus' => ['description' => 'RDS许可证的状态。', 'type' => 'string', 'example' => '2'],
'RdsLicenseAddress' => ['description' => 'RDS许可证的IP地址。', 'type' => 'string', 'example' => '47.100.XX.XX'],
'RdsLicenseDomainName' => ['description' => 'RDS许可证所在的域名称。', 'type' => 'string', 'example' => 'example.com'],
'BackupDns' => ['description' => '备用域控DNS地址。', 'type' => 'string', 'example' => '172.24.XX.XX'],
'BackupDCHostname' => ['description' => '备用域控主机名。', 'type' => 'string', 'example' => 'beijing-ad02'],
'EnableServiceRoute' => ['description' => '是否开启云服务路由访问管控。', 'type' => 'boolean', 'example' => 'false'],
'SubnetMode' => [
'description' => '办公网络子网模式。',
'type' => 'string',
'enumValueTitles' => ['跟随办公网络模式', '半管控模式'],
'example' => '0',
],
'SecurityProtection' => [
'description' => '办公网络安全防护配置。',
'type' => 'string',
'enumValueTitles' => ['SASE' => 'SASE', 'OFF' => '关闭'],
'example' => 'SASE',
],
'CustomAccessPoint' => ['description' => '自定义接入网关地址。', 'type' => 'string', 'example' => 'gw-****.com'],
'ResourceAmounts' => [
'description' => '资源数量列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'resourceType' => [
'description' => '资源类型。',
'type' => 'string',
'enumValueTitles' => ['desktop' => '云电脑', 'desktopGroup' => '共享型云电脑'],
'example' => 'desktop',
],
'amount' => ['description' => '资源数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'description' => '',
],
],
'TotalResourceAmount' => ['description' => '网卡总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'NmVersion' => [
'description' => '网络版本。新版支持无影云应用等产品。',
'type' => 'string',
'enumValueTitles' => ['DEFAULT' => '旧版', 'NM' => '新版'],
'example' => 'NM',
],
'AcceleratorId' => ['description' => '全球加速实例ID。', 'type' => 'string', 'example' => 'ga-bp1astu3yrplkzoo2****'],
'LdapUrl' => ['type' => 'string', 'description' => ''],
'IsLdap' => ['type' => 'boolean', 'description' => ''],
'DomainName' => ['description' => '企业AD的域名称。', 'type' => 'string', 'example' => 'example.com'],
'AccountType' => ['type' => 'string', 'description' => ''],
'AuthorityHost' => ['type' => 'string', 'description' => ''],
'TenantId' => ['type' => 'string', 'description' => ''],
'ClientId' => ['type' => 'string', 'description' => ''],
'EnvType' => ['type' => 'string'],
'VplVersion' => ['type' => 'string'],
'ClientSecret' => ['type' => 'string', 'description' => ''],
'Eid' => ['type' => 'string'],
'AccessAttribute' => ['type' => 'string'],
],
],
],
],
],
],
],
'title' => '查询办公网络的详细信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-12-23T02:19:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-07-07T09:58:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-10T02:56:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-01-20T07:27:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-12-06T03:14:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-10-23T08:47:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-08-05T02:52:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-10T12:27:19.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-06-01T13:41:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-04-29T06:51:17.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-07-12T03:55:31.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-06-13T08:13:02.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-19T03:15:20.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOfficeSites'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeOfficeSites',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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 \\"AccessAttribute\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n F369A091-002F-49C8-AD55-02A776297C7B\\n \\n REGISTERED\\n 2021-05-06T05:58Z\\n vpc-uf6tz5k67puge5jn8****\\n Basic\\n true\\n false\\n http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\n INTERNET\\n example.com\\t\\n false\\n 172.16.0.0/16\\n 10\\n 82Tg****\\n test\\n false\\n testPassword\\n sg-bp1ce64o4g9mdf5u****\\n example.com/Domain Controllers\\n Administrator\\n testSubDnsUserName\\n cn-hangzhou+dir-363353****\\n cen-3gwy16dojz1m65****\\n false\\n np-amtp8e8q1o9e4****\\n testDnsUserName\\t\\n AD_CONNECTOR\\n \\n RUNNING\\n vsw-bp19ocz3erfx15uon****\\n 172.24.*.*\\n password123***\\n eni-bp1i4wx78lgosrj6****\\n 1\\n \\n \\n CREATE_CONNECTOR\\n code:success | message:Create Connector complete\\n 2021-05-12T09:42Z\\n INFO\\n \\n vsw-bp19ocz3erfx15uon****\\n [\\"05b534****\\"]\\n [\\"172.24.*.*\\"]\\n [\\"172.24.*.*\\"]\\n false\\n 1\\n true\\n true\\n SAML\\n HDX\\n beijing-ad01\\n \\n","errorExample":""}]',
],
'DescribeOnlineUserCount' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '服务地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SearchRegionId',
'in' => 'query',
'schema' => ['description' => '搜索地域ID,过滤出指定地域的云资源信息。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '工作区ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai+dir-631324****'],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => ['description' => '> 该参数暂不对外开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
'AssignedUserCount' => ['description' => '已分配桌面的用户数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'OnlineUserCount' => ['description' => '在线用户数,包含便捷用户、AD用户。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AdAssignedUserCount' => ['description' => '已分配桌面的AD用户数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'SimpleAssignedUserCount' => ['description' => '已分配桌面的便捷用户数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
],
'description' => '',
],
],
],
'title' => '查询在线用户数量指标',
'summary' => '查询在线用户数、已分配桌面用户数等指标。',
'description' => '请确保在使用该接口前,已充分了解无影产品的资源类型和产品类型。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"AssignedUserCount\\": 10,\\n \\"OnlineUserCount\\": 1,\\n \\"AdAssignedUserCount\\": 2,\\n \\"SimpleAssignedUserCount\\": 8\\n}","type":"json"}]',
],
'DescribePolicyGroups' => [
'summary' => '查询云电脑策略的详细信息。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100'."\n"
.'- 默认值:10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的NextToken参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑策略ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy'],
'required' => false,
'example' => 'system-all-enabled-policy',
'maxItems' => 100,
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '云电脑策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ALL' => '全部策略', 'IP' => '根据IP生效', 'GLOBAL' => '全局生效 [默认值]'],
'example' => 'GLOBAL',
],
],
[
'name' => 'ExternalPolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要在查询结果中排除的云电脑策略ID列表。',
'type' => 'array',
'items' => ['description' => '要在查询结果中排除的云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-0cid8v30p16k4****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'],
'Count' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'DescribePolicyGroups' => [
'description' => '云电脑策略的详细信息。',
'type' => 'array',
'items' => [
'description' => '云电脑策略的详细信息。',
'type' => 'object',
'properties' => [
'PolicyStatus' => [
'description' => '云电脑策略状态。',
'type' => 'string',
'enumValueTitles' => ['AVAILABLE' => '可用', 'CREATING' => '创建中'],
'example' => 'AVAILABLE',
],
'Html5Access' => [
'description' => 'Web客户端访问策略。',
'type' => 'string',
'enumValueTitles' => ['off' => '禁止 [默认值]', 'on' => '允许'],
'example' => 'off',
],
'WatermarkType' => [
'description' => '水印类型。',
'type' => 'string',
'enumValueTitles' => ['EndUserId' => '用户名', 'Custom' => '自定义文本', 'DesktopIp' => '云电脑IP地址', 'ClientIp' => '客户端IP地址', 'HostName' => '云电脑ID后15位', 'ClientTime' => '云电脑当前时间'],
'example' => 'EndUserId',
],
'PreemptLogin' => [
'description' => '云电脑抢占策略。'."\n"
."\n"
.'> 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为`off`,且不可修改。',
'type' => 'string',
'enumValueTitles' => ['off' => '禁止抢占'],
'example' => 'off',
],
'WatermarkCustomText' => ['description' => '若参数`WatermarkType`传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。', 'type' => 'string', 'example' => 'custom-watermark'],
'Clipboard' => [
'description' => '剪贴板权限。',
'type' => 'string',
'enumValueTitles' => ['read' => '单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地', 'readwrite' => '双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地', 'write' => '单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑', 'off' => '双向禁止。云电脑和本地之间无法进行复制操作 [默认值]'],
'example' => 'off',
],
'PolicyGroupId' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'pg-gx2x1dhsmthe9****'],
'PrinterRedirection' => [
'description' => '打印机重定向策略。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '打开'],
'example' => 'on',
],
'WatermarkTransparency' => [
'description' => '水印显示的深浅程度。',
'type' => 'string',
'enumValueTitles' => ['LIGHT' => '较浅', 'DARK' => '较深', 'MIDDLE' => '中等'],
'example' => 'LIGHT',
],
'Html5FileTransfer' => [
'description' => 'Web客户端文传输策略。',
'type' => 'string',
'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭 [默认值]'],
'example' => 'off',
],
'UsbRedirect' => [
'description' => 'USB重定向。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'PolicyGroupType' => [
'description' => '云电脑策略类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统策略', 'CUSTOM' => '自定义策略'],
'example' => 'SYSTEM',
],
'Watermark' => [
'description' => '水印。',
'type' => 'string',
'enumValueTitles' => ['blind' => '开启盲水印', 'off' => '关闭水印', 'on' => '开启明水印'],
'example' => 'on',
],
'VisualQuality' => [
'description' => '图像显示质量策略。',
'type' => 'string',
'enumValueTitles' => ['high' => '高清', 'low' => '流畅', 'medium' => '自适应 [默认值]', 'lossless' => '无损'],
'example' => 'medium',
],
'EdsCount' => ['description' => '关联了该策略的云电脑和云电脑池的总数量。仅自定义策略会返回结果。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Name' => ['description' => '云电脑策略名称。', 'type' => 'string', 'example' => 'testPolicyGroupName'],
'LocalDrive' => [
'description' => '本地磁盘映射权限。',
'type' => 'string',
'enumValueTitles' => ['read' => '只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件', 'readwrite' => '读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件', 'off' => '关闭。云电脑上没有本地磁盘的映射 [默认值]'],
'example' => 'readwrite',
],
'AuthorizeSecurityPolicyRules' => [
'description' => '安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则列表。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '安全组管控规则的规则方向。',
'type' => 'string',
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'inflow',
],
'Policy' => [
'description' => '安全组管控规则的授权策略。',
'type' => 'string',
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求', 'accept' => '允许策略,接收所有访问请求'],
'example' => 'accept',
],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'example' => 'test'],
'PortRange' => ['description' => '安全组管控规则的端口范围。', 'type' => 'string', 'example' => '22/22'],
'IpProtocol' => [
'description' => '安全组管控规则的协议类型。',
'type' => 'string',
'enumValueTitles' => ['tcp' => 'TCP协议', 'udp' => 'UDP协议', 'all' => '支持所有协议', 'gre' => 'GRE协议', 'icmp' => 'ICMP(IPv4)协议'],
'example' => 'tcp',
],
'Priority' => ['description' => '安全组管控规则的优先级,数字越小,代表优先级越高。', 'type' => 'string', 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'example' => '47.100.XX.XX/16'],
],
],
],
'AuthorizeAccessPolicyRules' => [
'description' => '客户端IP白名单列表。仅白名单网段内的IP地址可访问云电脑。',
'type' => 'array',
'items' => [
'description' => '客户端访问IP白名单。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端访问IP地址段备注信息。', 'type' => 'string', 'example' => 'test'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'example' => '47.100.XX.XX/16'],
],
],
],
'ClientTypes' => [
'description' => '登录方式管控列表。用于控制可通过哪些客户端访问云电脑。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '是否允许某一类型的客户端连接云电脑。',
'type' => 'string',
'enumValueTitles' => ['OFF' => '不允许', 'ON' => '允许'],
'example' => 'ON',
],
'ClientType' => [
'description' => '客户端类型。',
'type' => 'string',
'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'windows' => 'Windows客户端', 'ios' => 'iOS客户端', 'macos' => 'macOS客户端'],
'example' => 'windows',
],
],
],
],
'PreemptLoginUsers' => [
'description' => '可抢占云电脑的一组用户的用户名。',
'type' => 'array',
'items' => ['description' => '可抢占云电脑的用户的用户名。', 'type' => 'string', 'example' => 'Alice'],
],
'GpuAcceleration' => [
'description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'UsbSupplyRedirectRule' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'example' => '04**'],
'ProductId' => ['description' => '产品ID。', 'type' => 'string', 'example' => '08**'],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => 'Test rule'],
'UsbRedirectType' => [
'description' => 'USB重定向类型。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [1 => '允许', '拒绝'],
'example' => '1',
],
'DeviceClass' => ['description' => '设备类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'example' => '0Eh'],
'DeviceSubclass' => ['description' => '设备子类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'example' => 'xxh'],
'UsbRuleType' => [
'description' => 'USB重定向规则类型。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [1 => '设备类别', '设备厂商'],
'example' => '1',
],
],
],
],
'DomainResolveRuleType' => [
'description' => '域名解析策略开关。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'DomainResolveRule' => [
'description' => '域名解析策略列表。',
'type' => 'array',
'items' => [
'description' => '域名解析策略详情。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'example' => '*.example.com'],
'Policy' => [
'description' => '解析策略。',
'type' => 'string',
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'example' => '测试规则'],
],
],
],
'NetRedirectRule' => [
'description' => '网络重定向策略列表。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'array',
'items' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '策略内容。', 'type' => 'string', 'example' => '*.example.com'],
'RuleType' => [
'description' => '策略类型。',
'type' => 'string',
'enumValueTitles' => ['prc' => '进程', 'domain' => '域名'],
'example' => 'domain',
],
'Policy' => [
'description' => '策略类型。',
'type' => 'string',
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
],
],
],
'Recording' => [
'description' => '是否开启录屏。',
'type' => 'string',
'enumValueTitles' => ['byaction_cmd_ft' => '用户操作录屏(执行命令和传输文件时均触发)', 'ALLTIME' => '全程录屏,从连接云电脑开始到断开云电脑连接', 'PERIOD' => '间隔录屏,需设置录屏开始和结束时间', 'byaction_commands' => '用户操作录屏(仅执行命令时触发)', 'OFF' => '不开启录屏', 'byaction_file_transfer' => '用户操作录屏(仅传输文件时触发)'],
'example' => 'OFF',
],
'RecordingStartTime' => ['description' => ' 录屏开始时间,取值:HH:MM:SS。只有Recording取值是PERIOD时,该返回值有实际意义。', 'type' => 'string', 'example' => '08:00:00'],
'RecordingEndTime' => ['description' => ' 录屏结束时间,取值:HH:MM:SS。只有Recording取值是PERIOD时,该返回值有实际意义。', 'type' => 'string', 'example' => '08:59:00'],
'RecordingFps' => [
'description' => '录屏帧率。单位:FPS(帧/秒)。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'],
'example' => '5',
],
'RecordingExpires' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'CameraRedirect' => [
'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启 [默认值]'],
'example' => 'on',
],
'NetRedirect' => [
'description' => '网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
'AppContentProtection' => [
'description' => '是否开启防截屏功能。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
'RecordContent' => [
'description' => '是否开启自定义录屏。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
'RecordContentExpires' => ['description' => '自定义录屏的文件过期时间,默认30天。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'RemoteCoordinate' => [
'description' => '远程协助键鼠控制权限。',
'type' => 'string',
'enumValueTitles' => ['optionalControl' => '默认关闭,可以点击申请键鼠操作权限打开', 'fullControl' => '完全控制', 'disableControl' => '不控制'],
'example' => 'fullControl',
],
'RecordingDuration' => [
'description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'],
'example' => '10',
],
'Scope' => [
'description' => '策略的生效范围。',
'type' => 'string',
'enumValueTitles' => ['IP' => '根据IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
'ScopeValue' => [
'description' => '`Scope`取值为`IP`的时候填写。当`Scope`为`IP`时生效,否则不生效。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block。', 'type' => 'string', 'example' => '47.100.XX.XX/24'],
],
'RecordingAudio' => [
'description' => '录制云电脑声音选项。',
'type' => 'string',
'enumValueTitles' => ['off' => '仅录制画面不录制声音 [默认值]', 'on' => '开启声音录制'],
'example' => 'on',
],
'InternetCommunicationProtocol' => [
'description' => '网络通信协议。',
'type' => 'string',
'enumValueTitles' => ['TCP' => '只允许使用TCP [默认值]', 'BOTH' => '允许自动在TCP和UDP之间切换'],
'example' => 'BOTH',
],
'VideoRedirect' => [
'description' => '多媒体重定向。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭媒体重定向', 'on' => '打开媒体重定向'],
'example' => 'off',
],
'WatermarkTransparencyValue' => ['description' => '水印透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'WatermarkColor' => ['description' => '水印字体颜色。 取值范围: 0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WatermarkFontSize' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'WatermarkFontStyle' => [
'description' => '水印字体样式。',
'type' => 'string',
'enumValueTitles' => ['plain' => '普通', 'bold' => '加粗'],
'example' => 'plain',
],
'WatermarkDegree' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'example' => '-10'],
'WatermarkRowAmount' => ['description' => '水印行数。'."\n"
."\n"
.'> 此参数暂未开放使用。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'EndUserApplyAdminCoordinate' => [
'description' => '用户申请管理员协助开关。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'EndUserGroupCoordinate' => [
'description' => '用户之间流协同开关。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'CpuProtectedMode' => [
'description' => 'CPU保护模式开关。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'CpuRateLimit' => ['description' => 'CPU整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'CpuSampleDuration' => ['description' => 'CPU整体采样时长,取值范围: 10\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'CpuSingleRateLimit' => ['description' => 'CPU单核使用率百分比,取值范围: 70\\~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'CpuDownGradeDuration' => ['description' => 'CPU降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'CpuProcessors' => [
'description' => '不受CPU使用率限制约束进程白名单。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'example' => 'chrome.exe'],
],
'MemoryProtectedMode' => [
'description' => '内存保护模式开关。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'MemoryRateLimit' => ['description' => '内存整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MemorySampleDuration' => ['description' => '内存整体采样时长,取值范围: 30\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemorySingleRateLimit' => ['description' => '单个进程内存使用率百分比,取值范围: 30\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemoryDownGradeDuration' => ['description' => '单个进程内存降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MemoryProcessors' => [
'description' => '不受内存使用率限制约束进程白名单。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'example' => 'notepad.exe'],
],
'WatermarkSecurity' => [
'description' => '盲水印安全优先规则。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
'WatermarkAntiCam' => [
'description' => '盲水印防拍照功能。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'WatermarkPower' => [
'description' => '盲水印增强功能。',
'type' => 'string',
'enumValueTitles' => ['high' => '高', 'low' => '低', 'medium' => '中'],
'example' => 'medium',
],
'RecordingUserNotify' => [
'description' => '录屏客户端消息通知功能。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'RecordingUserNotifyMessage' => ['description' => '录屏客户端通知内容。默认无需填写。', 'type' => 'string', 'example' => 'Your cloud desktop is being recorded.'],
'AdminAccess' => ['description' => '用户连接云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。', 'type' => 'string', 'example' => 'deny'],
'MaxReconnectTime' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
'DisplayMode' => [
'description' => '显示模式。',
'type' => 'string',
'enumValueTitles' => ['clientCustom' => '用户自主配置', 'adminOffice' => '日常办公场景', 'adminDesign' => '3D应用场景', 'adminCustom' => '管理员自定义参数'],
'example' => 'adminCustom',
],
'StreamingMode' => [
'description' => '流模式适配场景。',
'type' => 'string',
'enumValueTitles' => ['intelligent' => '日常办公场景(智能模式)', 'smooth' => '设计及3D应用场景(流畅优先)'],
'example' => 'smooth',
],
'ColorEnhancement' => [
'description' => '设计及3D应用场景选择是否开启色彩增强。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'SmoothEnhancement' => [
'description' => '日常办公场景选择,是否开启平滑度增强。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'QualityEnhancement' => [
'description' => '设计及3D应用场景选择是否开启画质增强。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'VideoEncPolicy' => [
'description' => '视频编码策略。',
'type' => 'string',
'enumValueTitles' => ['qualityFirst' => '画面质量优先', 'bandwidthFirst' => '码率策略优先'],
'example' => 'qualityFirst',
],
'TargetFps' => ['description' => '目标帧率,取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'VideoEncMinQP' => ['description' => '视频编码最小QP,最高质量。取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'VideoEncMaxQP' => ['description' => '视频编码最大QP,画面最低质量,取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'VideoEncAvgKbps' => ['description' => '视频编码平均码率,取值范围:1000\\~50000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'VideoEncPeakKbps' => ['description' => '视频编码峰值码率,取值范围:1000\\~50000。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
'DeviceRedirects' => [
'description' => '设备重定向规则列表。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'enumValueTitles' => ['printer' => '打印机', 'scanner' => '扫描仪', 'camera' => '摄像头', 'adb' => 'Android设备'],
'example' => 'camera',
],
'RedirectType' => ['description' => '重定向类型,取值范围:'."\n"
."\n"
.'- usbRedirect,usb重定向。'."\n"
.'- deviceRedirect,设备重定向。'."\n"
.'- off,关闭。', 'type' => 'string', 'example' => 'usbRedirect'],
],
],
],
'DeviceRules' => [
'description' => '自定义外设规则列表。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'enumValueTitles' => ['usbKey' => 'UKey', 'other' => '其他', 'graphicsTablet' => '手绘板', 'printer' => '打印机', 'cardReader' => '读卡器', 'scanner' => '扫描仪', 'storage' => '存储设备', 'camera' => '摄像头', 'adb' => 'Android设备', 'networkInterfaceCard' => '网卡设备'],
'example' => 'storage',
],
'DeviceName' => ['description' => '设备名称', 'type' => 'string', 'example' => 'sandisk'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'example' => '0x0781'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'example' => '0x55b1'],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭重定向'],
'example' => 'usbRedirect',
],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'example' => '2:0'],
'Platforms' => ['type' => 'string', 'description' => ''],
],
],
],
'WyAssistant' => [
'description' => '是否在云电脑悬浮球内提供无影AI助手功能入口。',
'type' => 'string',
'enumValueTitles' => ['off' => '不提供', 'on' => '提供'],
'example' => 'on',
],
'ResourceRegionId' => ['description' => '云电脑策略所属的地域。'."\n"
."\n"
.'> 若为无地域策略,则该值为`center`。', 'type' => 'string', 'example' => 'center'],
'DomainList' => [
'description' => '访问域名权限管控。域名支持通配符(\\*),多个域名之间以半角逗号隔开。',
'type' => 'string',
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
'StatusMonitor' => [
'description' => '是否在云电脑悬浮球内提供状态监控功能入口。',
'type' => 'string',
'enumValueTitles' => ['off' => '不提供', 'on' => '提供'],
'example' => 'on',
],
'MobileRestart' => [
'description' => '通过移动端(包括Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供重启按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'enumValueTitles' => ['off' => '不提供', 'on' => '提供'],
'example' => 'off',
],
'MobileShutdown' => [
'description' => '通过移动端(包括Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供关机按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'enumValueTitles' => ['off' => '不提供', 'on' => '提供'],
'example' => 'off',
],
'DesktopCount' => ['description' => '已关联该策略的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DesktopGroupCount' => ['description' => '已关联该策略的云电脑池数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ResourceGroupCount' => ['description' => '已关联该策略的资源组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RecordEventFilePaths' => [
'description' => '录屏审计中的文件监控绝对路径列表。',
'type' => 'array',
'items' => ['description' => '录屏审计中的文件监控绝对路径。', 'type' => 'string', 'example' => 'd:/data'],
],
'RecordEventRegisters' => [
'description' => '录屏审计中的注册表监控绝对路径列表。',
'type' => 'array',
'items' => ['description' => '录屏审计中的注册表监控绝对路径。', 'type' => 'string', 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR'],
'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR',
],
'RecordEventDuration' => ['description' => '录屏审计中检测到事件发生后录屏的时长。单位:分钟。取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ResetDesktop' => ['description' => '重置云电脑。', 'type' => 'string', 'example' => 'null'],
'FileTransfer' => ['description' => '文件传输。', 'type' => 'string', 'example' => 'null'],
'DeviceConnectHint' => ['type' => 'string', 'description' => ''],
'ResolutionModel' => ['type' => 'string', 'description' => ''],
'ResolutionWidth' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'ResolutionHeight' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'FileMigrate' => ['type' => 'string', 'description' => ''],
'WuyingKeeper' => ['type' => 'string', 'description' => ''],
'InternetPrinter' => ['type' => 'string', 'description' => ''],
'SafeMenu' => ['type' => 'string', 'description' => ''],
'ScreenDisplayMode' => ['type' => 'string', 'description' => ''],
'ClientControlMenu' => ['type' => 'string', 'description' => ''],
'FileTransferSpeedLocation' => ['type' => 'string', 'description' => ''],
'FileTransferAddress' => ['type' => 'string', 'description' => ''],
'FileTransferSpeed' => ['type' => 'string', 'description' => ''],
'CpdDriveClipboard' => ['type' => 'string', 'description' => ''],
'UseTime' => ['type' => 'string', 'description' => ''],
'AutoReconnect' => ['title' => '客户端自动重连配置项', 'description' => '客户端自动重连配置项', 'type' => 'string', 'example' => 'off'],
'MobileWuyingKeeper' => ['title' => '移动端无影管家开关', 'description' => '移动端无影管家开关', 'type' => 'string', 'example' => 'off'],
'MobileSafeMenu' => ['title' => '移动端Windows安全控制开关', 'description' => '移动端Windows安全控制开关', 'type' => 'string', 'example' => 'off'],
'MobileWyAssistant' => ['title' => '移动端无影小颖开关', 'description' => '移动端无影小颖开关', 'type' => 'string', 'example' => 'off'],
'ExternalDrive' => ['type' => 'string', 'description' => ''],
'ClientCreateSnapshot' => ['type' => 'string', 'description' => ''],
'WatermarkShadow' => ['type' => 'string', 'description' => ''],
'AcademicProxy' => ['type' => 'string', 'description' => ''],
'ModelLibrary' => ['type' => 'string', 'description' => ''],
'PortProxy' => ['type' => 'string', 'description' => ''],
'DiskOverload' => ['type' => 'string', 'description' => ''],
'CpuOverload' => ['type' => 'string', 'description' => ''],
'MemoryOverload' => ['type' => 'string', 'description' => ''],
'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'],
'KeyboardControl' => ['type' => 'string'],
'AdminKeyboardOnWindows' => ['type' => 'string'],
'AdminKeyboardOnFullScreen' => ['type' => 'string'],
'RecordEventLevels' => [
'title' => '录屏事件等级开关',
'description' => '录屏事件等级开关',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string'],
'EventLevel' => ['title' => '事件等级', 'description' => '事件等级', 'type' => 'string'],
],
'description' => '',
],
],
'RecordEventFileExts' => [
'title' => '录屏事件后缀',
'description' => '录屏事件后缀',
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
],
'Description' => ['type' => 'string'],
'NetworkPrinter' => ['type' => 'string'],
'EndUserCount' => ['type' => 'string'],
'OrganizationCount' => ['type' => 'string'],
],
],
],
],
],
],
],
'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\\": \\"Test rule\\",\\n \\"UsbRedirectType\\": 1,\\n \\"DeviceClass\\": \\"0Eh\\",\\n \\"DeviceSubclass\\": \\"xxh\\",\\n \\"UsbRuleType\\": 1\\n }\\n ],\\n \\"DomainResolveRuleType\\": \\"on\\",\\n \\"DomainResolveRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"Policy\\": \\"allow\\",\\n \\"Description\\": \\"测试规则\\"\\n }\\n ],\\n \\"NetRedirectRule\\": [\\n {\\n \\"Domain\\": \\"*.example.com\\",\\n \\"RuleType\\": \\"domain\\",\\n \\"Policy\\": \\"allow\\"\\n }\\n ],\\n \\"Recording\\": \\"OFF\\",\\n \\"RecordingStartTime\\": \\"08:00:00\\",\\n \\"RecordingEndTime\\": \\"08:59:00\\",\\n \\"RecordingFps\\": 5,\\n \\"RecordingExpires\\": 15,\\n \\"CameraRedirect\\": \\"on\\",\\n \\"NetRedirect\\": \\"off\\",\\n \\"AppContentProtection\\": \\"off\\",\\n \\"RecordContent\\": \\"off\\",\\n \\"RecordContentExpires\\": 30,\\n \\"RemoteCoordinate\\": \\"fullControl\\",\\n \\"RecordingDuration\\": 10,\\n \\"Scope\\": \\"GLOBAL\\",\\n \\"ScopeValue\\": [\\n \\"47.100.XX.XX/24\\"\\n ],\\n \\"RecordingAudio\\": \\"on\\",\\n \\"InternetCommunicationProtocol\\": \\"BOTH\\",\\n \\"VideoRedirect\\": \\"off\\",\\n \\"WatermarkTransparencyValue\\": 10,\\n \\"WatermarkColor\\": 0,\\n \\"WatermarkFontSize\\": 10,\\n \\"WatermarkFontStyle\\": \\"plain\\",\\n \\"WatermarkDegree\\": -10,\\n \\"WatermarkRowAmount\\": 5,\\n \\"EndUserApplyAdminCoordinate\\": \\"on\\",\\n \\"EndUserGroupCoordinate\\": \\"on\\",\\n \\"CpuProtectedMode\\": \\"on\\",\\n \\"CpuRateLimit\\": 70,\\n \\"CpuSampleDuration\\": 10,\\n \\"CpuSingleRateLimit\\": 70,\\n \\"CpuDownGradeDuration\\": 30,\\n \\"CpuProcessors\\": [\\n \\"chrome.exe\\"\\n ],\\n \\"MemoryProtectedMode\\": \\"on\\",\\n \\"MemoryRateLimit\\": 70,\\n \\"MemorySampleDuration\\": 30,\\n \\"MemorySingleRateLimit\\": 30,\\n \\"MemoryDownGradeDuration\\": 30,\\n \\"MemoryProcessors\\": [\\n \\"notepad.exe\\"\\n ],\\n \\"WatermarkSecurity\\": \\"on\\",\\n \\"WatermarkAntiCam\\": \\"off\\",\\n \\"WatermarkPower\\": \\"medium\\",\\n \\"RecordingUserNotify\\": \\"off\\",\\n \\"RecordingUserNotifyMessage\\": \\"Your cloud desktop is being recorded.\\",\\n \\"AdminAccess\\": \\"deny\\",\\n \\"MaxReconnectTime\\": 120,\\n \\"DisplayMode\\": \\"adminCustom\\",\\n \\"StreamingMode\\": \\"smooth\\",\\n \\"ColorEnhancement\\": \\"off\\",\\n \\"SmoothEnhancement\\": \\"off\\",\\n \\"QualityEnhancement\\": \\"off\\",\\n \\"VideoEncPolicy\\": \\"qualityFirst\\",\\n \\"TargetFps\\": 30,\\n \\"VideoEncMinQP\\": 20,\\n \\"VideoEncMaxQP\\": 20,\\n \\"VideoEncAvgKbps\\": 1000,\\n \\"VideoEncPeakKbps\\": 1000,\\n \\"DeviceRedirects\\": [\\n {\\n \\"DeviceType\\": \\"camera\\",\\n \\"RedirectType\\": \\"usbRedirect\\"\\n }\\n ],\\n \\"DeviceRules\\": [\\n {\\n \\"DeviceType\\": \\"storage\\",\\n \\"DeviceName\\": \\"sandisk\\",\\n \\"DeviceVid\\": \\"0x0781\\",\\n \\"DevicePid\\": \\"0x55b1\\",\\n \\"RedirectType\\": \\"usbRedirect\\",\\n \\"OptCommand\\": \\"2:0\\",\\n \\"Platforms\\": \\"\\"\\n }\\n ],\\n \\"WyAssistant\\": \\"on\\",\\n \\"ResourceRegionId\\": \\"center\\",\\n \\"DomainList\\": \\"off\\",\\n \\"StatusMonitor\\": \\"on\\",\\n \\"MobileRestart\\": \\"off\\",\\n \\"MobileShutdown\\": \\"off\\",\\n \\"DesktopCount\\": 1,\\n \\"DesktopGroupCount\\": 1,\\n \\"ResourceGroupCount\\": 1,\\n \\"RecordEventFilePaths\\": [\\n \\"d:/data\\"\\n ],\\n \\"RecordEventRegisters\\": [\\n \\"计算机\\\\\\\\HKEY_LOCAL_MACHINE\\\\\\\\SYSTEM\\\\\\\\CurrentControlSet\\\\\\\\Services\\\\\\\\USBSTOR\\"\\n ],\\n \\"RecordEventDuration\\": 10,\\n \\"ResetDesktop\\": \\"null\\",\\n \\"FileTransfer\\": \\"null\\",\\n \\"DeviceConnectHint\\": \\"\\",\\n \\"ResolutionModel\\": \\"\\",\\n \\"ResolutionWidth\\": 0,\\n \\"ResolutionHeight\\": 0,\\n \\"FileMigrate\\": \\"\\",\\n \\"WuyingKeeper\\": \\"\\",\\n \\"InternetPrinter\\": \\"\\",\\n \\"SafeMenu\\": \\"\\",\\n \\"ScreenDisplayMode\\": \\"\\",\\n \\"ClientControlMenu\\": \\"\\",\\n \\"FileTransferSpeedLocation\\": \\"\\",\\n \\"FileTransferAddress\\": \\"\\",\\n \\"FileTransferSpeed\\": \\"\\",\\n \\"CpdDriveClipboard\\": \\"\\",\\n \\"UseTime\\": \\"\\",\\n \\"AutoReconnect\\": \\"off\\",\\n \\"MobileWuyingKeeper\\": \\"off\\",\\n \\"MobileSafeMenu\\": \\"off\\",\\n \\"MobileWyAssistant\\": \\"off\\",\\n \\"ExternalDrive\\": \\"\\",\\n \\"ClientCreateSnapshot\\": \\"\\",\\n \\"WatermarkShadow\\": \\"\\",\\n \\"AcademicProxy\\": \\"\\",\\n \\"ModelLibrary\\": \\"\\",\\n \\"PortProxy\\": \\"\\",\\n \\"DiskOverload\\": \\"\\",\\n \\"CpuOverload\\": \\"\\",\\n \\"MemoryOverload\\": \\"\\",\\n \\"ResolutionDpi\\": 0,\\n \\"HoverConfigMsg\\": \\"\\",\\n \\"MultiScreen\\": \\"\\",\\n \\"HoverShutdown\\": \\"\\",\\n \\"HoverRestart\\": \\"\\",\\n \\"HoverHibernate\\": \\"\\",\\n \\"ClientShutdown\\": \\"\\",\\n \\"ClientRestart\\": \\"\\",\\n \\"ClientHibernate\\": \\"\\",\\n \\"KeyboardControl\\": \\"\\",\\n \\"AdminKeyboardOnWindows\\": \\"\\",\\n \\"AdminKeyboardOnFullScreen\\": \\"\\",\\n \\"RecordEventLevels\\": [\\n {\\n \\"EventType\\": \\"\\",\\n \\"EventLevel\\": \\"\\"\\n }\\n ],\\n \\"RecordEventFileExts\\": [\\n \\"\\"\\n ],\\n \\"Description\\": \\"\\",\\n \\"NetworkPrinter\\": \\"\\",\\n \\"EndUserCount\\": \\"\\",\\n \\"OrganizationCount\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6kb60RyIe8hZIdhSybWz5t4\\n 2CB27899-306D-56E9-A8F1-AD83D9FEDF3B\\n \\n pg-8whrmp8dewbdv****\\n on\\n sg-new-02\\n CUSTOM\\n off\\n AVAILABLE\\n off\\n \\n ON\\n windows\\n \\n \\n ON\\n linux\\n \\n \\n ON\\n macos\\n \\n \\n OFF\\n ios\\n \\n \\n OFF\\n android\\n \\n \\n ON\\n html5\\n \\n off\\n off\\n 1\\n off\\n medium\\n on\\n off\\n \\n","errorExample":""}]',
'title' => '查询云电脑策略详细信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-18T03:49:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-03T16:22:05.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-01-16T11:29:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-12-19T08:52:30.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-27T09:48:03.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-24T09:36:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-14T11:32:22.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyGroups'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribePolicyGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribePrice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '52841',
'abilityTreeNodes' => ['FEATUREgwsENR35V'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DesktopMonthPackage' => '云电脑(按月时长包)', 'Desktop' => '云电脑(按需购买/按月购买-不限时长)[默认值]', 'Bandwidth' => '公网精品带宽', 'DesktopGroup' => '共享型云电脑'],
'example' => 'Desktop',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => ['description' => '资源规格。'."\n"
."\n"
.'- 当`ResourceType`为`Desktop`时,该字段必填。可以调用[DescribeDesktopTypes](~~DescribeDesktopTypes~~)查询可用的值(对应`DesktopTypeId`的值)。'."\n"
."\n"
.'- 当`ResourceType`为`DesktopGroup`时,取值为`large`。'."\n"
."\n"
.'- 当`ResourceType`为`Bandwidth`时,可以不传入该参数。', 'type' => 'string', 'required' => false, 'example' => 'eds.general.2c2g'],
],
[
'name' => 'RootDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '系统盘大小。单位:GiB。当`ResourceType`为`Desktop`时,该字段必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '80'],
],
[
'name' => 'UserDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '65536', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'OsType',
'in' => 'query',
'schema' => [
'description' => '操作系统类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows [默认值]'],
'example' => 'Windows',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '计费周期。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Month' => '月', 'Year' => '年', 'Hour' => '小时 [默认值]'],
'example' => 'Hour',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '购买时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Hour`时,取值范围为:1。'."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1、2、3。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Amount',
'in' => 'query',
'schema' => ['description' => '资源数量。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '促销活动ID。', 'type' => 'string', 'required' => false, 'example' => '123456'],
],
[
'name' => 'InternetChargeType',
'in' => 'query',
'schema' => [
'description' => '互联网访问包的计费方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PayByTraffic' => '按使用流量计费', 'PayByBandwidth' => '按固定带宽计费'],
'example' => 'PayByTraffic',
],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网带宽峰值。单位:Mbps。'."\n"
."\n"
.'- 按固定带宽计费时,取值范围为10\\~1000。'."\n"
.'- 按使用流量计费时,取值范围为10\\~200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5120', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'RootDiskPerformanceLevel',
'in' => 'query',
'schema' => ['description' => '系统盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
],
[
'name' => 'UserDiskPerformanceLevel',
'in' => 'query',
'schema' => ['description' => '数据盘的性能等级。当云电脑规格设置为图形型或者高主频时,支持设置磁盘性能等级。关于各性能等级磁盘的差异,请参见[ESSD云盘](~~122389~~)。', 'type' => 'string', 'required' => false, 'example' => 'PL0'],
],
[
'name' => 'GroupDesktopCount',
'in' => 'query',
'schema' => ['description' => '共享型云电脑的数量,默认值为1。'."\n"
."\n"
.'> 当`ResourceType`为`DesktopGroup`时,该值有效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => [
'description' => '按月购买云电脑时的时长包类型。当`ResourceType`为`DesktopMonthPackage`时,该字段必填。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [120 => '120小时/月', 250 => '250小时/月'],
'example' => '120',
],
],
[
'name' => 'RootDiskCategory',
'in' => 'query',
'schema' => [
'description' => '系统盘类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_auto' => '极速云盘', 'cloud_essd' => '增强型SSD云盘,仅部分规格支持'],
'example' => '40',
],
],
[
'name' => 'UserDiskCategory',
'in' => 'query',
'schema' => [
'description' => '数据盘类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cloud_efficiency' => '高效云盘', 'cloud_auto' => '极速云盘', 'cloud_essd' => '增强型SSD云盘,仅部分规格支持'],
'example' => '80',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['description' => '转售模式的资源归属用户ID,非转售模式无需填写该参数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1422724566551XXX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B1175630-3C44-4389-A3C1-15639FFC8EBC'],
'PriceInfo' => [
'description' => '价格详细信息。',
'type' => 'object',
'properties' => [
'Rules' => [
'description' => '活动规则信息。',
'type' => 'array',
'items' => [
'description' => '活动规则信息。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => '买满1年,立享官网价格8.5折优惠。'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '587'],
],
],
],
'Price' => [
'description' => '价格信息。',
'type' => 'object',
'properties' => [
'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '79.0'],
'DiscountPrice' => ['description' => '折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '15.8'],
'Currency' => ['description' => '货币单位(CNY)。'."\n"
.' 货币单位(USD)。', 'type' => 'string', 'example' => 'CNY/USD'],
'TradePrice' => ['description' => '实际付款价格。取值为原价减去折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '63.2'],
'Promotions' => [
'description' => '促销活动信息。',
'type' => 'array',
'items' => [
'description' => '促销活动信息。',
'type' => 'object',
'properties' => [
'PromotionDesc' => ['description' => '促销信息描述。', 'type' => 'string', 'example' => '新品上市,立享优惠'],
'OptionCode' => ['description' => '促销活动规则描述。', 'type' => 'string', 'example' => 'test'],
'Selected' => ['description' => '是否被选中。', 'type' => 'boolean', 'example' => 'false'],
'PromotionId' => ['description' => '促销活动ID。', 'type' => 'string', 'example' => '123456'],
'PromotionName' => ['description' => '促销活动名称。', 'type' => 'string', 'example' => 'Featured deals'],
],
],
],
'OrderLines' => [
'description' => '订单信息。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '订单信息。', 'example' => '5376483****'],
],
'SpPrice' => ['description' => '节省计划下的价格。', 'type' => 'integer', 'format' => 'int64', 'example' => '50.00'],
],
],
'FreeCdsQuota' => ['description' => '是否有免费企业网盘。', 'type' => 'boolean', 'example' => 'true'],
'FreeCdsSize' => ['description' => '企业网盘的免费容量。单位:GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
'description' => '',
],
],
],
'title' => '查询新购价格',
'summary' => '查询无影商品的新购价格。',
'changeSet' => [
['createdAt' => '2025-11-04T08:21:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-09T03:02:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-09T02:21:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-09-27T07:36:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-25T11:10:38.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-08T02:37:03.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-22T01:24:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-28T13:08:15.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'],
],
],
'ramActions' => [],
'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\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n },\\n \\"SpPrice\\": 50\\n },\\n \\"FreeCdsQuota\\": true,\\n \\"FreeCdsSize\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n B1175630-3C44-4389-A3C1-15639FFC8EBC\\n \\n \\n 2.796\\n 0\\n CNY\\n 2.796\\n \\n \\n","errorExample":""}]',
],
'DescribeQosRules' => [
'summary' => '查询限速规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '公网精品带宽ID。', '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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'QosRules' => [
'description' => '限速规则列表。',
'type' => 'array',
'items' => [
'description' => '限速规则详情。',
'type' => 'object',
'properties' => [
'QosRuleId' => ['description' => '限速规则ID。', 'type' => 'string', 'example' => 'qos-chvkz5ekzgcb6bo0f'],
'QosRuleName' => ['description' => '限速规则名称。', 'type' => 'string', 'example' => 'test'],
'NetworkPackageId' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'example' => 'np-5cjh3sqs1ty3s02xq'],
'Upload' => ['description' => '上行带宽。', 'type' => 'string', 'example' => '10'],
'Download' => ['description' => '下行带宽。', 'type' => 'string', 'example' => '10'],
'DesktopGroupCount' => ['type' => 'integer', 'format' => 'int32'],
'DesktopCount' => ['description' => '组内云电脑数量。', 'type' => 'string', 'example' => '0'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询限速规则。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeQosRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QosRules\\": [\\n {\\n \\"QosRuleId\\": \\"qos-chvkz5ekzgcb6bo0f\\",\\n \\"QosRuleName\\": \\"test\\",\\n \\"NetworkPackageId\\": \\"np-5cjh3sqs1ty3s02xq\\",\\n \\"Upload\\": \\"10\\",\\n \\"Download\\": \\"10\\",\\n \\"DesktopGroupCount\\": 0,\\n \\"DesktopCount\\": \\"0\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRecordFile' => [
'summary' => '查询全地域录屏文件列表',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云桌面ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户id', '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' => '录屏文件状态。'."\n"
.'- 0 :上传成功。'."\n"
.'- 1 :上传中。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'RecordType',
'in' => 'query',
'schema' => ['description' => '录屏文件类型。'."\n"
.'- alltime : 全程录屏。'."\n"
.'- period : 间隔录屏。'."\n"
.'- event :时间录屏。'."\n"
.'- session : 会话录屏。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'alltime'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,若不指定则按照录屏开始时间倒序。'."\n"
.'- startTime : 录屏开始时间。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'startTime'],
],
[
'name' => 'OrderSort',
'in' => 'query',
'schema' => ['description' => '排序方向。'."\n"
.'- asc : 正序。'."\n"
.'- desc : 倒序。', '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'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['type' => 'string', 'default' => 'desktop'],
],
],
'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' => '录屏文件状态。'."\n"
.'- 0 :上传成功。'."\n"
.'- 1 :上传中。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RecordExpire' => ['description' => '录屏文件过期时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1774656000000'],
'RecordType' => ['description' => '录屏文件类型。'."\n"
.'- alltime : 全程录屏。'."\n"
.'- period : 间隔录屏。'."\n"
.'- event :时间录屏。'."\n"
.'- session : 会话录屏。', 'type' => 'integer', 'format' => 'int32', 'example' => 'period'],
'EndUserId' => ['description' => '终端用户名称。', 'type' => 'string', 'example' => 'Alice'],
'RecordEndTime' => ['description' => '录制结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。'."\n", 'type' => 'string', 'example' => '2025-12-18T06:02:25Z'],
'RecordStartTime' => ['description' => '录制开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。', 'type' => 'string', 'example' => '2025-12-18T06:02:25Z'],
'FileName' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'Task3'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-7yulhw1g1attet7d2'],
'FileSize' => ['description' => '文件大小。单位:Byte。', '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' => '管控策略ID。', 'type' => 'string', 'example' => 'pg-**'],
'RegionId' => ['description' => '录屏云电脑所在地域。', 'type' => 'string', 'example' => 'cn-beijing'],
'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-f3s3dgt8dtb0vlqc8'],
'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => 'resource'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询全地域录屏文件列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordFile'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeRecordFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05C2791F-41A7-5E7C-B5E4-1401FD0E****\\",\\n \\"TotalCount\\": 2,\\n \\"RecordFiles\\": [\\n {\\n \\"Status\\": 1,\\n \\"RecordExpire\\": 1774656000000,\\n \\"RecordType\\": 0,\\n \\"EndUserId\\": \\"Alice\\",\\n \\"RecordEndTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"RecordStartTime\\": \\"2025-12-18T06:02:25Z\\",\\n \\"FileName\\": \\"Task3\\",\\n \\"DesktopId\\": \\"ecd-7yulhw1g1attet7d2\\",\\n \\"FileSize\\": 139,\\n \\"EventDetails\\": [\\n {\\n \\"EventTime\\": 60,\\n \\"EventType\\": \\"UserInput\\",\\n \\"EventName\\": \\"{\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageInfo\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"mouse_move\\\\\\\\\\\\\\",\\\\\\\\n\\\\\\\\t\\\\\\\\\\\\\\"messageType\\\\\\\\\\\\\\" : \\\\\\\\\\\\\\"UserInput\\\\\\\\\\\\\\"\\\\\\\\n}\\\\\\\\n\\\\\\"\\"\\n }\\n ],\\n \\"DesktopName\\": \\"fvt-ecd\\",\\n \\"PolicyId\\": \\"pg-**\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ResourceGroupId\\": \\"rg-f3s3dgt8dtb0vlqc8\\",\\n \\"ResourceGroupName\\": \\"resource\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeRecordings' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。不指定时,表示查询该地域下所有云电脑。', 'type' => 'string', 'required' => false, 'example' => 'ecd-hlh41mk78dugw****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询的开始时间。使用UTC+8时间,格式为`YYYYMMDDhhmmss`。', 'type' => 'string', 'required' => false, 'example' => '20230424000000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询的结束时间。使用UTC+8时间,格式为`YYYYMMDDhhmmss`。', 'type' => 'string', 'required' => false, 'example' => '20230424004441'],
],
[
'name' => 'NeedSignedUrl',
'in' => 'query',
'schema' => [
'description' => '是否需要返回URL。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '返回URL', 'false' => '不返回URL [默认值]'],
'example' => 'false',
],
],
[
'name' => 'SignedUrlExpireMinutes',
'in' => 'query',
'schema' => ['description' => '返回URL的有效时间。单位:分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'StandardStartTime',
'in' => 'query',
'schema' => ['description' => '查询的开始时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'required' => false, 'example' => '2025-01-27T02:20:10Z'],
],
[
'name' => 'StandardEndTime',
'in' => 'query',
'schema' => ['description' => '查询的结束时间。按照ISO 8601标准表示,并使用 UTC+0 时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'required' => false, 'example' => '2025-01-27T02:30:10Z'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nbCQ7ar+fECeh1IuWQXi39R5eoJ68zWp99mTAKRRNRhw=='],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '327CFE78-1C0D-51AC-A9C6-BCEDF0DD44D6'],
'Recordings' => [
'description' => '云电脑录屏信息集合。',
'type' => 'array',
'items' => [
'description' => '云电脑录屏信息。',
'type' => 'object',
'properties' => [
'EndTime' => ['description' => '录制的结束时间。', 'type' => 'string', 'example' => '2023-04-10T07:26:06Z'],
'FilePath' => ['description' => '文件路径。', 'type' => 'string', 'example' => 'pg-4w5nk44zo5yl1****/1mk78dugw344.mp4'],
'StartTime' => ['description' => '录制的开始时间。', 'type' => 'string', 'example' => '2023-04-10T07:26:06Z'],
'RecordingType' => [
'description' => '录制类型。',
'type' => 'string',
'enumValueTitles' => ['byaction_cmd_ft' => '由事件触发录屏-复制粘贴和文件传输都触发', 'period' => '间隔录屏', 'session' => '监听会话生命周期录屏', 'byaction_commands' => '由事件触发录屏-复制粘贴触发', 'alltime' => '全程录屏', 'byaction_file_transfer' => '由事件触发录屏-文件传输触发'],
'example' => 'alltime',
],
'RecordingSize' => ['description' => '录制文件大小。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1742845'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-10v0vuvm616sk****'],
'EndUserIds' => [
'description' => '终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'alice'],
],
'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-6dn811rzrwh9w****'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'DemoComputer'],
'SignedUrl' => ['description' => '录屏文件下载地址。', 'type' => 'string', 'example' => 'https://eds-recording-bucket-cn-hangzhou-137187566615****.oss-cn-hangzhou.aliyuncs.com/pg-28l5tdjd33txz****/ecd-e0so9m9u6chf1****_gftest001_alltime_s0_****.mp4?Expires=171256****&OSSAccessKeyId=STS.****&Signature=****4WyAA'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询录屏详细信息',
'summary' => '查询录屏文件的详细信息。',
'changeSet' => [
['createdAt' => '2025-01-16T11:29:55.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-04-24T08:11:11.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordings'],
],
],
'ramActions' => [],
'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"}]',
],
'DescribeRefundPrice' => [
'summary' => '查询按月购买云电脑的退订价格。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'RefundType',
'in' => 'query',
'schema' => [
'description' => '退订类型。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['RemainRefund' => '退余款,并释放资源', 'RenewRefund' => '退续费,只修改实例到期时间'],
'example' => 'RemainRefund',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。可设置一个或多个,N取值范围:1\\~20。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'PriceInfo' => [
'description' => '价格详细信息。',
'type' => 'object',
'properties' => [
'Currency' => ['description' => '货币单位(CNY)。'."\n"
.'货币单位(USD)。', 'type' => 'string', 'example' => 'CNY'],
'RefundFee' => ['description' => '本次退款金额。', 'type' => 'number', 'format' => 'float', 'example' => '3990.75'],
],
],
],
'description' => '',
],
],
],
'title' => '查询按月购买云电脑的退订价格',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-05-26T07:17:11.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRefundPrice'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"PriceInfo\\": {\\n \\"Currency\\": \\"CNY\\",\\n \\"RefundFee\\": 3990.75\\n }\\n}","type":"json"}]',
],
'DescribeRegions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'AcceptLanguage',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '指定业务Location的展示语言,默认是中文。 ',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'],
'example' => 'zh',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Regions' => [
'description' => '地域信息数组。',
'type' => 'array',
'items' => [
'description' => '地域信息对象。',
'type' => 'object',
'properties' => [
'RegionEndpoint' => ['description' => '地域对应的Endpoint。', 'type' => 'string', 'example' => 'ecd.cn-hangzhou.aliyuncs.com'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'LocalName' => ['description' => '地域的展示名,根据当前语言环境转换。', '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\\": \\"China (Hangzhou)\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查看可选的地域和可用区',
'summary' => '查询无影云桌面支持的阿里云地域信息。',
'changeSet' => [
['createdAt' => '2022-08-02T02:02:06.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:49.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeRenewalPrice' => [
'summary' => '查询无影商品的续费价格。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。具体传入的值取决于要查询续费价格的资源类型(ResourceType):'."\n"
."\n"
.'* 当`ResourceType`=`Desktop`时(即查询云电脑续费价格),`InstanceId`需要传入云电脑ID。'."\n"
.'* 参数`ResourceType`=`DesktopGroup`时(即查询云电脑池续费价格),`InstanceId`需要传入云电脑池ID。'."\n"
.'* 参数`ResourceType`=`Bandwidth`时(即查询公网精品带宽续费价格),`InstanceId`需要传入公网精品带宽ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ecd-6ldllk9zxcpfhs****'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Desktop' => '云电脑 [默认值]', 'Bandwidth' => '公网精品带宽', 'DesktopGroup' => '云电脑池'],
'example' => 'Desktop',
],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '续费时长的单位,即参数`Period`的单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '续费时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1、2、3。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '实例ID。具体传入的值取决于要查询续费价格的资源类型(ResourceType)。',
'type' => 'array',
'items' => ['description' => '实例ID。同参数`InstanceId`。', 'type' => 'string', 'required' => false, 'example' => 'ecd-6ldllk9zxcpfhs****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '72E47B1E-6B11-5A11-A27C-7A80F866****'],
'PriceInfo' => [
'description' => '价格详细信息。',
'type' => 'object',
'properties' => [
'Rules' => [
'description' => '活动规则信息。',
'type' => 'array',
'items' => [
'description' => '活动规则。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '规则描述。', 'type' => 'string', 'example' => '买满1年,立享官网价格8.5折优惠。'],
'RuleId' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '29644'],
],
],
],
'Price' => [
'description' => '价格。',
'type' => 'object',
'properties' => [
'OriginalPrice' => ['description' => '原价。', 'type' => 'number', 'format' => 'float', 'example' => '79.0'],
'DiscountPrice' => ['description' => '折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '15.8'],
'Currency' => ['description' => '货币单位(CNY)。'."\n"
.'货币单位(USD)。', 'type' => 'string', 'example' => 'CNY'],
'TradePrice' => ['description' => '实际付款价格。取值为原价减去折减的价格。', 'type' => 'number', 'format' => 'float', 'example' => '63.2'],
'Promotions' => [
'description' => '促销活动信息。',
'type' => 'array',
'items' => [
'description' => '促销活动信息。',
'type' => 'object',
'properties' => [
'PromotionDesc' => ['description' => '促销信息描述。', 'type' => 'string', 'example' => '新品上市,立享优惠'],
'OptionCode' => ['description' => '促销活动规则描述。', 'type' => 'string', 'example' => 'test'],
'Selected' => ['description' => '是否被选中。', 'type' => 'boolean', 'example' => 'false'],
'PromotionId' => ['description' => '促销活动ID。', 'type' => 'string', 'example' => 'promo_option'],
'PromotionName' => ['description' => '促销活动名称。', 'type' => 'string', 'example' => 'Featured deals'],
],
],
],
'OrderLines' => [
'description' => '订单信息。',
'type' => 'object',
'additionalProperties' => ['type' => 'string', 'description' => '订单信息。', 'example' => '5376483****'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '服务内部异常,请稍候重试。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"72E47B1E-6B11-5A11-A27C-7A80F866****\\",\\n \\"PriceInfo\\": {\\n \\"Rules\\": [\\n {\\n \\"Description\\": \\"买满1年,立享官网价格8.5折优惠。\\",\\n \\"RuleId\\": 29644\\n }\\n ],\\n \\"Price\\": {\\n \\"OriginalPrice\\": 79,\\n \\"DiscountPrice\\": 15.8,\\n \\"Currency\\": \\"CNY\\",\\n \\"TradePrice\\": 63.2,\\n \\"Promotions\\": [\\n {\\n \\"PromotionDesc\\": \\"新品上市,立享优惠\\",\\n \\"OptionCode\\": \\"test\\",\\n \\"Selected\\": false,\\n \\"PromotionId\\": \\"promo_option\\",\\n \\"PromotionName\\": \\"Featured deals\\"\\n }\\n ],\\n \\"OrderLines\\": {\\n \\"key\\": \\"5376483****\\"\\n }\\n }\\n }\\n}","type":"json"}]',
'title' => '查询续费价格',
'changeSet' => [
['createdAt' => '2025-07-29T01:40:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-11-01T02:05:34.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-04T10:25:00.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-04T10:25:00.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeRenewalPrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeResourceByCenterPolicyId' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'pg-53iyi2aar0nd6****'],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '产品类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['app' => '云应用', 'resourceGroup' => '资源组', 'desktop' => '云电脑', 'desktopGroup' => '共享型云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6l69tQX7yFxx6/4dbooBAOc'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '48174475-5EB2-5F99-A9E9-6F892D645****'],
'ResourceModelList' => [
'description' => '资源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '资源状态。', 'type' => 'string', 'example' => 'Stopped'],
'Cpu' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '64'],
'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'desktop'],
'ProductType' => ['description' => '产品类型。', 'type' => 'string', 'example' => 'desktop'],
'OsType' => ['description' => '操作系统类型。', 'type' => 'string', 'example' => 'Linux'],
'GpuCount' => ['description' => 'GPU核数。', 'type' => 'number', 'format' => 'double', 'example' => '0.125'],
'Memory' => ['description' => '内存大小。单位:MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '10240'],
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'ecd-7o96aa08fr****'],
'ResourceName' => ['description' => '资源名称。', 'type' => 'string', 'example' => 'O&M'],
'ProtocolType' => ['description' => '协议类型。', 'type' => 'string', 'example' => 'ASP'],
'DesktopType' => ['description' => '目标云电脑规格。您可以调用[DescribeDesktopTypes](~~188882~~)查询无影云电脑支持的规格ID。', 'type' => 'string', 'example' => 'eds.enterprise_office.8c32g'],
'PayType' => ['description' => '付费类型。', 'type' => 'string', 'example' => 'postPaid'],
'GpuSpec' => ['description' => 'GPU类型。', 'type' => 'string', 'example' => '2GiB'],
'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-d7pasxsd3b9nhq**'],
'ResourceGroupName' => ['description' => '资源组名称。', 'type' => 'string', 'example' => 'test'],
'ResourceGroupRelCount' => ['description' => '资源组关联数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'AppModelList' => [
'description' => '云应用列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppId' => ['description' => '应用ID。资源类型为App的资源特有参数。', 'type' => 'string', 'example' => '18'],
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'alipic-powergem'],
],
'description' => '',
],
],
'ResourceRegionId' => ['description' => '资源所在地域。'."\n", 'type' => 'string', 'example' => 'cn-shenzhen'],
],
'description' => '',
],
],
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'Count' => ['description' => '总数。', '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\\": \\"O&M\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.8c32g\\",\\n \\"PayType\\": \\"postPaid\\",\\n \\"GpuSpec\\": \\"2GiB\\",\\n \\"ResourceGroupId\\": \\"rg-d7pasxsd3b9nhq**\\",\\n \\"ResourceGroupName\\": \\"test\\",\\n \\"ResourceGroupRelCount\\": 10,\\n \\"AppModelList\\": [\\n {\\n \\"AppId\\": \\"18\\",\\n \\"AppName\\": \\"alipic-powergem\\"\\n }\\n ],\\n \\"ResourceRegionId\\": \\"cn-shenzhen\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"Count\\": \\"2\\"\\n}","type":"json"}]',
'title' => '查询无地域策略关联的资源',
'summary' => '查询无地域策略绑定的云资源。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeResourceByCenterPolicyId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSessionStatistic' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'SearchRegionId',
'in' => 'query',
'schema' => ['description' => '搜索地域ID。用于过滤出指定地域的桌面信息。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '工作区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai+dir-259382****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1679449506572'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间。', 'type' => 'string', 'required' => false, 'example' => '1677808889806'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '查询时间间隔,单位为秒。取值范围:'."\n"
."\n"
.'- 60'."\n"
.'- 120', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '总数。', 'type' => 'string', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C5528624-C6ED-5CA4-A4A2-7C30DBF2****'],
'Statistic' => [
'description' => '统计信息。',
'type' => 'array',
'items' => [
'description' => '统计信息。',
'type' => 'object',
'properties' => [
'TimePoint' => ['description' => '时间点。', 'type' => 'integer', 'format' => 'int64', 'example' => '1690164443508'],
'Count' => ['description' => '区间内会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询会话统计',
'summary' => '查询全地域的会话统计信息。',
'description' => '- 该接口为中心化接口,只可通过上海地域的服务进行调用。'."\n"
.'- 当前最多支持查询1小时内的实时数据统计。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeSessionStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"RequestId\\": \\"C5528624-C6ED-5CA4-A4A2-7C30DBF2****\\",\\n \\"Statistic\\": [\\n {\\n \\"TimePoint\\": 1690164443508,\\n \\"Count\\": 4\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeSnapshots' => [
'summary' => '查询一台云电脑的快照列表和快照的详细信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****'],
],
[
'name' => 'SnapshotName',
'in' => 'query',
'schema' => ['description' => '快照的显示名称。长度为2\\~127个英文或中文字符。必须以大小写字母或中文开头。可以包含数字、下划线(\\_)或者短划线(-)。为防止和自动快照的名称冲突,不能以`auto`开头。', 'type' => 'string', 'required' => false, 'example' => 'Test data disk'],
],
[
'name' => 'SourceDiskType',
'in' => 'query',
'schema' => [
'description' => '需制作快照的磁盘。'."\n"
."\n"
.'> 取值不区分大小写。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Data' => '数据盘', 'System' => '系统盘'],
'example' => 'system',
],
],
[
'name' => 'SnapshotType',
'in' => 'query',
'schema' => [
'description' => '快照类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['all' => '所有快照类型 [默认值]', 'auto' => '自动快照', 'user' => '手动创建的快照'],
'example' => 'user',
],
],
[
'name' => 'OsType',
'in' => 'query',
'schema' => [
'description' => '操作系统类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Linux' => 'Linux操作系统', 'Windows' => 'Windows操作系统'],
'example' => 'Windows',
],
],
[
'name' => 'Creator',
'in' => 'query',
'schema' => ['description' => '创建者。', 'type' => 'string', 'required' => false, 'example' => 'Administrator'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '快照创建的开始时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'required' => false, 'example' => '2020-11-30T06:32:31Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '快照创建的结束时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'required' => false, 'example' => '2020-11-31T06:32:31Z'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => '8051af8d01b5479bec9f5ddf02e4a8fbd0ab6e7e43f8****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
'Snapshots' => [
'description' => '快照信息集合。',
'type' => 'array',
'items' => [
'description' => '快照信息。',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => '快照的创建时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z'],
'Status' => [
'description' => '快照状态。',
'type' => 'string',
'enumValueTitles' => ['PROGRESSING' => '创建中', 'FAILED' => '创建失败', 'ACCOMPLISHED' => '创建完毕'],
'example' => 'ACCOMPLISHED',
],
'SnapshotType' => [
'description' => '快照创建类型。',
'type' => 'string',
'enumValueTitles' => ['AUTO' => '自动创建快照', 'USER' => '手动创建快照'],
'example' => 'USER',
],
'SnapshotName' => ['description' => '快照名称。', 'type' => 'string', 'example' => 'testSnapshotName'],
'Progress' => ['description' => '快照创建进度。单位为百分比。', 'type' => 'string', 'example' => '100%'],
'Description' => ['description' => '快照描述信息。', 'type' => 'string', 'example' => 'testDescription'],
'SnapshotId' => ['description' => '快照ID。', 'type' => 'string', 'example' => 's-2zeipxmnhej803x7****'],
'RemainTime' => ['description' => '正在创建的快照剩余完成时间。单位为秒。'."\n"
."\n"
.'> 当`Status`为`PROGRESSING`时,`RemainTime`的值显示为`-1`,表示正在计算剩余时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'SourceDiskSize' => ['description' => '源磁盘容量。单位:GiB。', 'type' => 'string', 'example' => '150'],
'SourceDiskType' => [
'description' => '源磁盘类型。',
'type' => 'string',
'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'],
'example' => 'SYSTEM',
],
'DesktopId' => ['description' => '快照所属的云电脑ID。', 'type' => 'string', 'example' => 'ecd-g03l3tlm8djoj****'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'test'],
'DesktopStatus' => [
'description' => '云电脑状态。',
'type' => 'string',
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Running',
],
'DiskStatus' => [
'description' => '快照所属的磁盘状态。',
'type' => 'string',
'enumValueTitles' => ['Available' => '使用中', 'Deleted' => '已删除'],
'example' => 'Available',
],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => 'Administrator'],
'ProtocolType' => [
'description' => '协议类型。',
'type' => 'string',
'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研协议'],
'example' => 'ASP',
],
'OsType' => [
'description' => '操作系统类型。',
'type' => 'string',
'enumValueTitles' => ['Linux' => 'Linux操作系统', 'Windows' => 'Windows操作系统'],
'example' => 'Windows',
],
'VolumeEncryptionEnabled' => ['description' => '是否开启磁盘加密。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。可通过[ListKeys](~~28951~~)接口获取。', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****'],
'DeletionTime' => ['description' => '快照创建时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为`yyyy-mm-ddthh:mm:ssz`。', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z'."\n"],
'RestorePointId' => ['description' => '还原点ID。', 'type' => 'string', 'example' => 'rp-btgmaa20wkcju****'],
'RestorePointName' => ['description' => '还原点名称。', 'type' => 'string', 'example' => '数据盘备份'],
'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":"\\n AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\n \\n ACCOMPLISHED\\n \\n testDescription\\n \\n testSnapshotName\\n s-2zeipxmnhej803x7****\\n 150\\n 2020-12-20T14:52:28Z\\n USER\\n 30\\n SYSTEM\\n \\n","errorExample":""}]',
'title' => '查询云电脑的快照列表和详细信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-10T09:28:15.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-01-15T02:17:22.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-01T07:41:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-19T06:39:52.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:48.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:48.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSnapshots'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeSnapshots',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeTemplates' => [
'summary' => '查询云电脑模板详情。',
'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' => '需要查询的模板ID列表。',
'type' => 'array',
'items' => ['description' => '需要查询的模板ID。', 'type' => 'string', 'required' => false, 'example' => 'b-216bi6zpvsy****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'TemplateName',
'in' => 'formData',
'schema' => ['title' => '模板名称', 'description' => '使用模板名称查询。', 'type' => 'string', 'required' => false, 'example' => 'My cloud desktop template 001'],
],
[
'name' => 'TemplateType',
'in' => 'formData',
'schema' => [
'title' => '模板类型',
'description' => '指定查询的模板类型,不传则表示查询所有类型的模板。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['USER_TEMPLATE' => '用户自定义模板', 'SYSTEM_TEMPLATE' => '阿里云提供的系统模板'],
'example' => 'USER_TEMPLATE',
],
],
[
'name' => 'ImageId',
'in' => 'formData',
'schema' => ['description' => '云电脑镜像ID,可以从镜像管理页面查询,支持系统镜像、自定义镜像等类型。', 'type' => 'string', 'required' => false, 'example' => 'm-dnz9xjgbm8*****'],
],
[
'name' => 'Keyword',
'in' => 'formData',
'schema' => ['description' => '关键字。支持模糊搜索模板ID、模板名称字段。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'ProductType',
'in' => 'formData',
'schema' => [
'title' => '产品类型',
'description' => '产品类型。固定填写`CloudDesktop`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['CloudDesktop' => '云电脑'],
'example' => 'CloudDesktop',
],
],
[
'name' => 'BizRegionId',
'in' => 'formData',
'schema' => ['title' => '业务地域', 'description' => '模板查询时的地域过滤条件。 '."\n"
."\n"
.'> 如果设置了该参数, 则查询出的结果会把其他不匹配的地域化配置屏蔽。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'BizType',
'in' => 'formData',
'schema' => ['title' => '业务类型', 'description' => '> 该参数暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '分页查询时,当前页的页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'minimum' => '0'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页查询时,每页最大行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'maximum' => '100', 'minimum' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListResult',
'description' => 'ListResult',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '查询的模板信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GmtCreate' => ['description' => '模板的创建时间(UTC时间)。', 'type' => 'string', 'example' => '2025-04-25T05:18:46.000+00:00'],
'GmtModified' => ['description' => '模板的更新时间(UTC时间)。', 'type' => 'string', 'example' => '2025-04-25T05:18:46.000+00:00'],
'TemplateId' => ['description' => '模板ID。', 'type' => 'string', 'example' => 'b-0caoeogs88y*****'],
'TemplateName' => ['description' => '模板名称。', 'type' => 'string', 'example' => 'My template 001'],
'Description' => ['description' => '模板描述', 'type' => 'string', 'example' => 'My template'],
'TemplateType' => [
'description' => '模板类型。',
'type' => 'string',
'enumValueTitles' => ['USER_TEMPLATE' => '用户自定义模板', 'SYSTEM_TEMPLATE' => '系统模板'],
'example' => 'USER_TEMPLATE',
],
'ProductType' => [
'description' => '产品类型。',
'type' => 'string',
'enumValueTitles' => ['CloudDesktop' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'SystemDiskSize' => ['description' => '系统盘大小。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'SystemDiskPerformanceLevel' => [
'description' => '系统盘类型。',
'type' => 'string',
'enumValueTitles' => ['PL1' => 'ESSD高速云盘PL1等级', 'PL0' => 'ESSD高速云盘PL0等级', 'AutoPL' => 'SSD高速云盘'],
'example' => 'AutoPL',
],
'DataDiskList' => [
'description' => '数据盘大小和规格配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Size' => ['description' => '数据盘大小。单位:GiB。', 'type' => 'string', 'example' => '100'],
'PerformanceLevel' => [
'description' => '数据盘性能等级。',
'type' => 'string',
'enumValueTitles' => ['PL1' => 'ESSD高速云盘PL1等级', 'PL0' => 'ESSD高速云盘PL0等级', 'AutoPL' => 'SSD高速云盘'],
'example' => 'AutoPL',
],
],
'description' => '',
],
],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-5q8ehbihx*****'],
'ImageType' => [
'description' => '镜像类型。',
'type' => 'string',
'enumValueTitles' => ['User' => '用户自定义镜像', 'Shared' => '共享镜像', 'System' => '系统镜像', 'Community' => '社区镜像'],
'example' => 'User',
],
'DefaultLanguage' => [
'description' => '模板设置的默认启动语言。',
'type' => 'string',
'enumValueTitles' => ['en-US' => '英语', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日语'],
'example' => 'zh-CN',
],
'PolicyGroupId' => ['description' => '策略ID。', 'type' => 'string', 'example' => 'pg-0caoeogkhz*****'],
'TimerGroupId' => ['description' => '定时任务组ID。', 'type' => 'string', 'example' => 'bcc-dweha*****'],
'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-a5fqjjqaejt***'],
'ResourceTagList' => [
'description' => '云电脑标签。Key-Value格式。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'env'],
'Value' => ['description' => '属性值。', 'type' => 'string', 'example' => 'test'],
],
'description' => '',
],
],
'RegionConfigList' => [
'description' => '地域相关的配置参数。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shenzhen'],
'SnapshotPolicyId' => ['description' => '快照策略ID。', 'type' => 'string', 'example' => 'sp-b9fasjuu0*****'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-beijing+dir-3040*****'],
'SubnetId' => ['description' => '子网ID。', 'type' => 'string', 'example' => 'vsw-dgea1*****'],
'VolumeEncryptionEnable' => ['description' => '是否开启了磁盘加密设置参数。', 'type' => 'boolean', 'example' => 'false'],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。', 'type' => 'string', 'example' => '3bc77be0-cbce-4a29-b07b-13f16394****'],
'ResourceInstanceType' => ['description' => '云电脑规格ID。', 'type' => 'string', 'example' => 'eds.enterprise_office.4c8g'],
'MemorySize' => ['description' => '内存大小。单位:MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '8192'],
'CpuCount' => ['description' => '云电脑规格包含的vCPU数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'GpuSpec' => ['description' => 'GPU显存信息。只要在规格是图形型的场景才会显示。', 'type' => 'string', 'example' => '4GiB'],
],
'description' => '',
],
],
'RequestId' => ['description' => '请求ID。', '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*******'],
],
'description' => '',
],
],
'ChargeType' => ['type' => 'string', 'description' => ''],
'Period' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'PeriodUnit' => ['type' => 'string', 'description' => ''],
'AutoPay' => ['type' => 'boolean', 'description' => ''],
'AutoRenew' => ['type' => 'boolean', 'description' => ''],
'UserDuration' => ['type' => 'string', 'description' => ''],
'PostPaidAfterUsedUp' => ['type' => 'boolean', 'description' => ''],
],
'description' => '',
],
],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '94'],
'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'True'],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1871984F-51F6-5588-BAF6-*******'],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '查询云电脑模板详情',
'changeSet' => [
['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"GmtModified\\": \\"2025-04-25T05:18:46.000+00:00\\",\\n \\"TemplateId\\": \\"b-0caoeogs88y*****\\",\\n \\"TemplateName\\": \\"My template 001\\",\\n \\"Description\\": \\"My template\\",\\n \\"TemplateType\\": \\"USER_TEMPLATE\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"SystemDiskSize\\": 80,\\n \\"SystemDiskPerformanceLevel\\": \\"AutoPL\\",\\n \\"DataDiskList\\": [\\n {\\n \\"Size\\": \\"100\\",\\n \\"PerformanceLevel\\": \\"AutoPL\\"\\n }\\n ],\\n \\"ImageId\\": \\"m-5q8ehbihx*****\\",\\n \\"ImageType\\": \\"User\\",\\n \\"DefaultLanguage\\": \\"zh-CN\\",\\n \\"PolicyGroupId\\": \\"pg-0caoeogkhz*****\\",\\n \\"TimerGroupId\\": \\"bcc-dweha*****\\",\\n \\"ResourceGroupId\\": \\"rg-a5fqjjqaejt***\\",\\n \\"ResourceTagList\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"RegionConfigList\\": [\\n {\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"SnapshotPolicyId\\": \\"sp-b9fasjuu0*****\\",\\n \\"OfficeSiteId\\": \\"cn-beijing+dir-3040*****\\",\\n \\"SubnetId\\": \\"vsw-dgea1*****\\",\\n \\"VolumeEncryptionEnable\\": false,\\n \\"VolumeEncryptionKey\\": \\"3bc77be0-cbce-4a29-b07b-13f16394****\\",\\n \\"ResourceInstanceType\\": \\"eds.enterprise_office.4c8g\\",\\n \\"MemorySize\\": 8192,\\n \\"CpuCount\\": 4,\\n \\"GpuSpec\\": \\"4GiB\\"\\n }\\n ],\\n \\"RequestId\\": \\"1871984F-51F6-5588-BAF6-******\\",\\n \\"SiteConfigList\\": [\\n {\\n \\"SiteId\\": \\"mainland\\",\\n \\"AppRuleId\\": \\"bwr-5a5371e0*******\\"\\n }\\n ],\\n \\"ChargeType\\": \\"\\",\\n \\"Period\\": 0,\\n \\"PeriodUnit\\": \\"\\",\\n \\"AutoPay\\": 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"}]',
],
'DescribeTimerGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['cn-shanghai' => 'cn-shanghai'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '配置组ID。', 'type' => 'string', 'required' => true, 'example' => 'cg-hs3i1w39o68ma****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Data' => [
'description' => '配置组信息。',
'type' => 'object',
'properties' => [
'GroupId' => ['description' => '配置组ID。', 'type' => 'string', 'example' => 'cg-75aazkg2tnqb2*****'],
'Name' => ['description' => '配置组名称。', 'type' => 'string', 'example' => 'Scheduled task'],
'Description' => ['description' => '配置组描述信息。', 'type' => 'string', 'example' => 'Scheduled task'],
'Type' => [
'description' => '配置组类型。',
'type' => 'string',
'enumValueTitles' => ['Timer' => '定时任务'],
'example' => 'Timer',
],
'ProductType' => [
'description' => '配置组使用的产品类型。',
'type' => 'string',
'enumValueTitles' => ['CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'ConfigTimers' => [
'description' => '定时任务的配置信息,列表结构。',
'type' => 'array',
'items' => [
'description' => '定时任务的配置信息。',
'type' => 'object',
'properties' => [
'TimerType' => [
'description' => '定时任务类型。',
'type' => 'string',
'enumValueTitles' => ['NoOperationDisconnect' => '无操作断连', 'NoConnect' => '断连任务(需指定OperationType)', 'TimerBoot' => '定时开机', 'TimerReset' => '定时重置', 'NoOperationShutdown' => '无操作关机', 'NoOperationHibernate' => '无操作休眠', 'TimerShutdown' => '定时关机', 'NoOperationReboot' => '无操作重启', 'TimerReboot' => '定时重启'],
'example' => 'TimerBoot',
],
'CronExpression' => ['description' => '定时任务Cron表达式。', 'type' => 'string', 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n"],
'Interval' => ['description' => '时间间隔,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Enforce' => ['description' => '是否强制执行。为true表示忽略桌面及连接状态检测,强制执行定时任务。', 'type' => 'boolean', 'example' => 'false'],
'ResetType' => [
'description' => '重置定时任务重置类型。',
'type' => 'string',
'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '重置系统盘', 'RESET_TYPE_USER_DISK' => '重置数据盘', 'RESET_TYPE_BOTH' => '重置系统盘和数据盘'],
'example' => 'RESET_TYPE_SYSTEM',
],
'AllowClientSetting' => ['description' => '是否允许终端用户自行配置定时任务。', 'type' => 'boolean', 'example' => 'true'],
'OperationType' => [
'description' => '断连定时任务类型。',
'type' => 'string',
'enumValueTitles' => ['Hibernate' => '休眠', 'Shutdown' => '关机'],
'example' => 'Shutdown',
],
'TriggerType' => [
'description' => '无操作定时任务触发配置类型。',
'type' => 'string',
'enumValueTitles' => ['Advanced' => '智能判断', 'Standard' => '标准判断'],
'example' => 'Standard',
],
'ProcessWhitelist' => [
'description' => '无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。',
'type' => 'array',
'items' => ['description' => '进程名称。', 'type' => 'string', 'example' => 'chrome'],
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'SegmentTimers' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartCronExpression' => ['type' => 'string', 'description' => ''],
'EndCronExpression' => ['type' => 'string', 'description' => ''],
'OperationType' => ['type' => 'string', 'description' => ''],
'Interval' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'TriggerType' => ['type' => 'string', 'description' => ''],
'ProcessWhitelist' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'Timezone' => ['type' => 'string', 'description' => ''],
'Enforce' => ['type' => 'boolean', 'description' => ''],
'ResetType' => ['type' => 'string', 'description' => ''],
'ImageId' => ['title' => '变更镜像定时任务使用,指定需要变更的镜像ID', 'description' => '变更镜像定时任务使用,指定需要变更的镜像ID', 'type' => 'string', 'example' => 'm-5b0vjqbiqu010XXXXXX'],
'LockScreenTime' => ['title' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用', 'description' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用', 'type' => 'integer', 'format' => 'int32', 'example' => '1800'],
'AppointmentTimer' => ['title' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务', 'description' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务', 'type' => 'integer', 'format' => 'int64', 'example' => '1764660600967'],
'PatchId' => ['type' => 'string', 'example' => 'KB5082063'],
'CreateSnapshot' => ['type' => 'boolean', 'default' => 'false'],
'VerificationTime' => ['type' => 'integer', 'format' => 'int32'],
'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32'],
'IpSegments' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
'description' => '',
],
'description' => '',
],
],
],
],
'BindCount' => ['description' => '配置组绑定的资源数。', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
'Status' => [
'description' => '配置组状态。',
'type' => 'string',
'enumValueTitles' => ['AVAILABLE' => '可用', 'UNAVAILABLE' => '已删除', 'DELETING' => '删除中', 'UPDATING' => '修改中'],
'example' => 'AVAILABLE',
],
'BindCountMap' => [
'description' => '配置绑定资源的数量信息。',
'type' => 'object',
'additionalProperties' => ['type' => 'integer', 'format' => 'int32', 'description' => '绑定资源的数量。', 'example' => '10'],
],
'IsBind' => ['title' => '系统定时任务检查使用,当前定时任务不支持解绑和绑定', 'description' => '系统定时任务检查使用,当前定时任务不支持解绑和绑定', 'type' => 'boolean'],
'IsUpdate' => ['title' => '系统定时任务检查使用,当前定时任务不支持修改', 'description' => '系统定时任务检查使用,当前定时任务不支持修改', 'type' => 'boolean'],
'InnerTimerName' => ['title' => '前端展示使用,系统定时任务名称映射code', 'description' => '前端展示使用,系统定时任务名称映射code', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE'],
'InnerTimerDesc' => ['title' => '前端展示使用,系统定时任务描述使用code', 'description' => '前端展示使用,系统定时任务描述使用code', 'type' => 'string', 'example' => 'INNER_TIMER_10_MINUTES_HIBERNATE_NO_UPDATE_DESC'],
],
],
],
],
],
],
'title' => '查询配置组详细信息',
'summary' => '查询指定配置组的详细信息。',
'changeSet' => [
['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-05-26T02:20:25.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Data\\": {\\n \\"GroupId\\": \\"cg-75aazkg2tnqb2*****\\",\\n \\"Name\\": \\"Scheduled task\\",\\n \\"Description\\": \\"Scheduled task\\",\\n \\"Type\\": \\"Timer\\",\\n \\"ProductType\\": \\"CLOUD_DESKTOP\\",\\n \\"ConfigTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 0 16 ? * 1,2,3,4,5,6,7\\\\n\\",\\n \\"Interval\\": 10,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"Shutdown\\",\\n \\"TriggerType\\": \\"Standard\\",\\n \\"ProcessWhitelist\\": [\\n \\"chrome\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"SegmentTimers\\": [\\n {\\n \\"StartCronExpression\\": \\"\\",\\n \\"EndCronExpression\\": \\"\\",\\n \\"OperationType\\": \\"\\",\\n \\"Interval\\": 0,\\n \\"TriggerType\\": \\"\\",\\n \\"ProcessWhitelist\\": [\\n \\"\\"\\n ],\\n \\"NotificationTime\\": 0,\\n \\"TimerOrder\\": 0,\\n \\"Timezone\\": \\"\\",\\n \\"Enforce\\": true,\\n \\"ResetType\\": \\"\\",\\n \\"ImageId\\": \\"m-5b0vjqbiqu010XXXXXX\\",\\n \\"LockScreenTime\\": 1800,\\n \\"AppointmentTimer\\": 1764660600967,\\n \\"PatchId\\": \\"KB5082063\\",\\n \\"CreateSnapshot\\": true,\\n \\"VerificationTime\\": 0,\\n \\"VerificationNotificationTime\\": 0,\\n \\"IpSegments\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"BindCount\\": 50,\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"BindCountMap\\": {\\n \\"key\\": 10\\n },\\n \\"IsBind\\": 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"}]',
],
'DescribeUserConnectionRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑池ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '授权用户ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice'],
],
[
'name' => 'EndUserType',
'in' => 'query',
'schema' => [
'description' => '用户账号体系类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'SIMPLE',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
.'最大值:100。'."\n"
.'默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'ConnectStartTimeFrom',
'in' => 'query',
'schema' => ['description' => '以开始连接时间作为筛选条件的最小值。格式为Unix时间戳。单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631239200000'],
],
[
'name' => 'ConnectStartTimeTo',
'in' => 'query',
'schema' => ['description' => '以开始连接时间作为筛选条件的最大值。格式为Unix时间戳。单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631241000000'],
],
[
'name' => 'ConnectEndTimeFrom',
'in' => 'query',
'schema' => ['description' => '以终止连接时间作为筛选条件的最小值。格式为Unix时间戳。单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631266200000'],
],
[
'name' => 'ConnectEndTimeTo',
'in' => 'query',
'schema' => ['description' => '以终止连接时间作为筛选条件的最大值。格式为Unix时间戳。单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1631268000000'],
],
[
'name' => 'ConnectDurationFrom',
'in' => 'query',
'schema' => ['description' => '以连接时长作为筛选条件的最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'ConnectDurationTo',
'in' => 'query',
'schema' => ['description' => '以连接时长作为筛选条件的最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-138dsptkrt00u****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03'],
'ConnectionRecords' => [
'description' => '用户连接记录数组。',
'type' => 'array',
'items' => [
'description' => '用户连接记录对象。',
'type' => 'object',
'properties' => [
'ConnectionRecordId' => ['description' => '连接记录ID。', 'type' => 'string', 'example' => '528'],
'ConnectStartTime' => ['description' => '开始连接时间。', 'type' => 'string', 'example' => '2022-01-19T10:12:38Z'],
'DesktopName' => ['description' => '连接的云电脑名称。', 'type' => 'string', 'example' => 'demoComputer'],
'ConnectDuration' => ['description' => '连接时长。单位为毫秒。', 'type' => 'string', 'example' => '1800000'],
'ConnectEndTime' => ['description' => '断开连接时间。', 'type' => 'string', 'example' => '2022-02-27T20:03:13Z'],
'DesktopId' => ['description' => '连接的云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
],
],
],
],
],
],
],
'title' => '查询共享型云电脑的用户连接记录',
'summary' => '查询云电脑池的授权用户连接池化云电脑的具体记录。',
'changeSet' => [
['createdAt' => '2022-05-13T03:56:50.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserConnectionRecords'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeUserConnectionRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\",\\n \\"ConnectionRecords\\": [\\n {\\n \\"ConnectionRecordId\\": \\"528\\",\\n \\"ConnectStartTime\\": \\"2022-01-19T10:12:38Z\\",\\n \\"DesktopName\\": \\"demoComputer\\",\\n \\"ConnectDuration\\": \\"1800000\\",\\n \\"ConnectEndTime\\": \\"2022-02-27T20:03:13Z\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 2CC66B0A-BA3B-5D87-BFBE-11AAAD7A8E03\\n \\n 528\\n 2022-01-19T10:12:38Z\\n testName\\n 3405035000\\n 2022-02-27T20:03:13Z\\n ud-2hawufy3uedi1****\\n \\n","errorExample":""}]',
],
'DescribeUsersInGroup' => [
'summary' => '查询共享型云电脑所有授权用户的详情,包括用户名、邮箱地址、手机号、获得授权的云电脑ID等。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-8ttn55ujj8nj8****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'- 最大值:100。'."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '授权用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'ConnectState',
'in' => 'query',
'schema' => [
'description' => '用户连接状态。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => ['未连接', '已连接'],
'example' => '1',
],
],
[
'name' => 'QueryUserDetail',
'in' => 'query',
'schema' => [
'description' => '是否查询用户详情。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '查询用户详情 [默认值]', 'false' => '不查询用户详情'],
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => '模糊查询字符串。包含该字符串的结果都将被匹配出来。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'OrgId',
'in' => 'query',
'schema' => ['description' => '用户所属的组织ID。', 'type' => 'string', 'required' => false, 'example' => 'org-d0fua2oyukw8j****'],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '授权用户ID列表。',
'type' => 'array',
'items' => ['description' => '授权用户ID。只支持精确匹配。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'UsersCount' => ['description' => '符合查询条件的共享型云电脑授权用户总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'OnlineUsersCount' => ['description' => '符合查询条件且目前已连接云电脑的共享型云电脑授权用户总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'UserOuPath' => ['type' => 'string', 'description' => ''],
'UserGroupName' => ['type' => 'string', 'description' => ''],
'EndUsers' => [
'description' => '授权用户信息列表。',
'type' => 'array',
'items' => [
'description' => '授权用户信息。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '授权用户ID。', 'type' => 'string', 'example' => 'alice'],
'EndUserEmail' => ['description' => '授权用户的邮箱地址。', 'type' => 'string', 'example' => 'alice@example.com'],
'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'testName'],
'ConnectionStatus' => [
'description' => '连接状态。',
'type' => 'string',
'enumValueTitles' => ['未连接', '连接中'],
'example' => '1',
],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
'EndUserType' => [
'description' => '用户账号体系类型。',
'type' => 'string',
'enumValueTitles' => ['SIMPLE' => '便捷账号', 'AD_CONNECTOR' => '企业AD账号'],
'example' => 'SIMPLE',
],
'EndUserPhone' => ['description' => '授权用户的手机号。', 'type' => 'string', 'example' => '1381111****'],
'EndUserName' => ['description' => '授权用户的用户名。', 'type' => 'string', 'example' => 'alice'],
'ExternalInfo' => [
'description' => '附加信息。',
'type' => 'object',
'properties' => [
'ExternalName' => ['description' => '外部名称。', 'type' => 'string', 'example' => 'nameDemo'],
'JobNumber' => ['description' => '工号。', 'type' => 'string', 'example' => '123'],
],
],
'UserSetPropertiesModels' => [
'description' => '用户座位信息列表。',
'type' => 'array',
'items' => [
'description' => '用户座位信息。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '用户ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'UserName' => ['description' => '用户名称。', 'type' => 'string', 'example' => 'nameDemo'],
'PropertyId' => ['description' => '属性ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'PropertyKey' => ['description' => '属性名称。', 'type' => 'string', 'example' => 'key'],
'PropertyType' => [
'description' => '属性类型。',
'type' => 'integer',
'format' => 'int32',
'exclusiveMinimum' => false,
'enumValueTitles' => [1 => '系统属性', '用户自定义属性'],
'example' => '1',
],
'PropertyValues' => [
'description' => '属性值数组。',
'type' => 'array',
'items' => [
'description' => '属性值对象。',
'type' => 'object',
'properties' => [
'PropertyValueId' => ['description' => '属性值ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'PropertyValue' => ['description' => '属性值。', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
'UserDesktopId' => ['description' => '用户对应的虚拟云电脑ID。', 'type' => 'string', 'example' => 'ud-i896ze8hazpvl****'],
'EndUserRemark' => ['description' => '用户备注。', 'type' => 'string', 'example' => 'Note'],
'DisplayName' => ['description' => '企业AD账号的显示名称。', 'type' => 'string', 'example' => 'alice'],
'UserPrincipalName' => ['type' => 'string', 'description' => ''],
'DisplayNameNew' => ['type' => 'string', 'description' => ''],
],
],
],
],
],
],
],
'title' => '查询共享型云电脑授权用户详情',
'changeSet' => [
['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-10T09:08:39.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-06-17T03:44:55.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-04-13T08:12:45.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2022-04-13T08:12:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersInGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"UsersCount\\": 1,\\n \\"OnlineUsersCount\\": 0,\\n \\"UserOuPath\\": \\"\\",\\n \\"UserGroupName\\": \\"\\",\\n \\"EndUsers\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EndUserEmail\\": \\"alice@example.com\\",\\n \\"DesktopName\\": \\"testName\\",\\n \\"ConnectionStatus\\": \\"1\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"EndUserType\\": \\"SIMPLE\\",\\n \\"EndUserPhone\\": \\"1381111****\\",\\n \\"EndUserName\\": \\"alice\\",\\n \\"ExternalInfo\\": {\\n \\"ExternalName\\": \\"nameDemo\\",\\n \\"JobNumber\\": \\"123\\"\\n },\\n \\"UserSetPropertiesModels\\": [\\n {\\n \\"UserId\\": 123,\\n \\"UserName\\": \\"nameDemo\\",\\n \\"PropertyId\\": 123,\\n \\"PropertyKey\\": \\"key\\",\\n \\"PropertyType\\": 1,\\n \\"PropertyValues\\": [\\n {\\n \\"PropertyValueId\\": 123,\\n \\"PropertyValue\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"UserDesktopId\\": \\"ud-i896ze8hazpvl****\\",\\n \\"EndUserRemark\\": \\"Note\\",\\n \\"DisplayName\\": \\"alice\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 750E6E83-F9FC-528A-AE24-1FAE249B30FE\\n 1\\n 0\\n \\n alice\\n alice@example.com\\n testName\\n 1\\n ud-7ftf5b6yu77b0****\\n SIMPLE\\n 1871234****\\n alice\\n \\n","errorExample":""}]',
],
'DescribeUsersPassword' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-gq8u6whi9f6k8****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7B4B17B-5C8A-514C-AA4D-F8090E3A63E9'],
'DesktopUsers' => [
'description' => '云电脑镜像内账号的列表。',
'type' => 'array',
'items' => [
'description' => '云电脑镜像内账号。',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => '云电脑镜像内账号的展示名称。', 'type' => 'string', 'example' => 'demo_user01_1488****'],
'Password' => ['description' => '云电脑镜像内账号的密码。', 'type' => 'string', 'example' => '3q8p-NDey-2Nac-TWcQ-****'],
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'demo_user01'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询云电脑镜像内账号的密码',
'summary' => '查询云电脑镜像内账号的密码。例如,在云电脑上的Chrome浏览器查询缓存的密码时,会要求终端用户输入该密码进行验证。',
'changeSet' => [
['createdAt' => '2022-08-04T10:18:13.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersPassword'],
],
],
'ramActions' => [],
'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"}]',
],
'DescribeVirtualMFADevices' => [
'summary' => '查询AD账号绑定的虚拟MFA设备。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '返回结果的最大数量。取值范围:1~500。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '100'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证。取值为上一次调用此API时返回的NextToken参数值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-269345****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'AD账号的用户名列表。',
'type' => 'array',
'items' => ['description' => 'AD账号的用户名。', 'type' => 'string', 'required' => false, 'example' => 'testuser'],
'required' => false,
'example' => 'testuser',
'maxItems' => 100,
],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FB550AAB-FB36-4A91-93F6-F4374AF65403'],
'VirtualMFADevices' => [
'description' => '虚拟MFA设备信息集合。',
'type' => 'array',
'items' => [
'description' => '虚拟MFA设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => ['description' => '虚拟MFA设备的序列号。', 'type' => 'string', 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****'],
'GmtUnlock' => ['description' => '虚拟MFA设备被锁定后的自动解锁时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2020-12-21T15:21:28Z'],
'EndUserId' => ['description' => '使用该虚拟MFA设备的AD账号用户名。', 'type' => 'string', 'example' => 'usertest'],
'ConsecutiveFails' => ['description' => '连续绑定或者认证虚拟MFA设备失败的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-269345****'],
'status' => [
'description' => '虚拟MFA设备状态。',
'type' => 'string',
'enumValueTitles' => ['LOCKED' => '已锁定', 'UNBOUND' => '未绑定', 'NORMAL' => '正常'],
'example' => 'NORMAL',
],
'DirectoryId' => ['description' => '> 该参数正在邀测中,暂未开放使用。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'],
'GmtEnabled' => ['description' => '虚拟MFA设备启用时间。按照[ISO 8601](~~25696~~)标准表示,并使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。', 'type' => 'string', 'example' => '2020-12-20T14:52:28Z'],
'AdUser' => [
'type' => 'object',
'properties' => [
'EndUser' => ['type' => 'string', 'description' => ''],
'DisplayName' => ['type' => 'string', 'description' => ''],
'DisplayNameNew' => ['type' => 'string', 'description' => ''],
'UserPrincipalName' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
],
],
],
],
],
'title' => '查询AD账号绑定的虚拟MFA设备',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-23T16:26:33.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-06-07T02:59:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVirtualMFADevices'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeVirtualMFADevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as\\",\\n \\"RequestId\\": \\"FB550AAB-FB36-4A91-93F6-F4374AF65403\\",\\n \\"VirtualMFADevices\\": [\\n {\\n \\"SerialNumber\\": \\"a25f297f-f2e1-4a44-bbf1-5f48a6e5****\\",\\n \\"GmtUnlock\\": \\"2020-12-21T15:21:28Z\\",\\n \\"EndUserId\\": \\"usertest\\",\\n \\"ConsecutiveFails\\": 1,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-269345****\\",\\n \\"status\\": \\"NORMAL\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"GmtEnabled\\": \\"2020-12-20T14:52:28Z\\",\\n \\"AdUser\\": {\\n \\"EndUser\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n\\n 2020-12-20T14:52:28Z\\n cn-hangzhou+dir-269345****\\n usertest\\n cn-hangzhou+dir-gx2x1dhsmu52rd****\\n a25f297f-f2e1-4a44-bbf1-5f48a6e5****\\n 1\\n 2020-12-21T15:21:28Z\\n NORMAL\\n\\nFB550AAB-FB36-4A91-93F6-F4374AF65403\\nAAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL23as\\n","errorExample":""}]',
],
'DescribeZones' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ZoneType',
'in' => 'query',
'schema' => ['description' => '查询可用区的类型。默认取值为`AvailabilityZone`,即普通云上可用区。', 'type' => 'string', 'required' => false, 'example' => 'AvailabilityZone'],
],
[
'name' => 'VpcAccessZone',
'in' => 'query',
'schema' => ['type' => 'boolean'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Zones' => [
'description' => '可用区信息集合。',
'type' => 'array',
'items' => [
'description' => '可用区。',
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'],
],
],
],
],
],
],
],
'title' => '查询指定地域支持的可用区',
'summary' => '查询无影云电脑在某一个阿里云地域下支持的可用区信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeZones'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Zones\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 5BEFE642-A383-4A18-8939-FB7DE4526F65\\n \\n cn-hangzhou-h\\n \\n","errorExample":""}]',
],
'DetachCen' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '将高级办公网络与云企业网实例解绑',
'summary' => '将高级办公网络与已加入的云企业网实例解绑。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:47.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachCen'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\r\\n","errorExample":""}]',
],
'DetachEndUser' => [
'summary' => '为无影硬件终端移除绑定用户。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'DeviceId',
'in' => 'query',
'schema' => ['description' => '无影硬件终端的SN。', 'type' => 'string', 'required' => true, 'example' => '12OERSLDO7M3****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '需要为无影硬件终端移除的绑定用户ID。', 'type' => 'string', 'required' => true, 'example' => 'alice'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '便捷办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'],
],
[
'name' => 'AdDomain',
'in' => 'query',
'schema' => ['description' => 'AD办公网络地址。', 'type' => 'string', 'required' => false, 'example' => 'xn--0zw****'],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => [
'description' => '客户端类型 。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [1 => '无影硬件终端'],
'example' => '1',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为无影硬件终端移除绑定用户',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachEndUser'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DisableDesktopsInGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-84mztzatmipf2****'],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '34FB4D97-C0D9-5534-ABC6-90C7EBD5****'],
],
],
],
],
'title' => '禁用共享型云电脑中的云电脑',
'summary' => '禁用共享型云电脑中的云电脑。禁用后,云电脑的状态变为unavailable。',
'changeSet' => [
['createdAt' => '2022-03-02T07:11:28.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDesktopsInGroup'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:DisableDesktopsInGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34FB4D97-C0D9-5534-ABC6-90C7EBD5****\\"\\n}","type":"json"}]',
],
'DisconnectDesktopSessions' => [
'summary' => '断开云电脑会话。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Sessions',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '会话详情。',
'type' => 'array',
'items' => [
'description' => '会话详情。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '连接会话的终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'DesktopId' => ['description' => '终端用户连接的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-90g15fkhsxxxn****'],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
[
'name' => 'PreCheck',
'in' => 'query',
'schema' => ['description' => '是否进行预检查。若执行预检查,则不会真正执行断连操作,只会将不符合执行条件的会话列表返回。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '本次请求的ID。', 'type' => 'string', 'example' => '2507CFA8-FEAB-5208-98F5-5E028C50XXXX'],
'InvalidSessions' => [
'description' => '无效会话列表。',
'type' => 'array',
'items' => [
'description' => '无效会话列表。',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '终端用户ID。', 'type' => 'string', 'example' => 'alice'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-2jv6wugbkp65p****'],
],
],
],
],
'description' => '',
],
],
],
'title' => '断开云电脑会话',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisconnectDesktopSessions'],
],
],
'ramActions' => [],
'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"}]',
],
'DissociateNetworkPackage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '公网精品带宽ID。可调用[DescribeNetworkPackages](~~216079~~)获取该参数。', 'type' => 'string', 'required' => true, 'example' => 'np-*********'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '从办公网络解绑公网精品带宽',
'summary' => '将公网精品带宽与此前绑定的办公网络解绑。',
'changeSet' => [
['createdAt' => '2022-05-30T01:26:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateNetworkPackage'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'DownloadCdsFile' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-643267****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63f3257b68b018170b194d87b875512d108f****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E3ED9519-DD73-5C86-9C0A-43C9281C****'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'DownloadFileModel' => [
'description' => '文件下载地址的URL。',
'type' => 'object',
'properties' => [
'StreamUrl' => ['description' => '已废弃。', 'type' => 'string', 'example' => '无'],
'DownloadUrl' => ['description' => '下载地址。', 'type' => 'string', 'example' => 'https://pds-****-bj-169380****.oss-cn-beijing.aliyuncs.com/A0SK****?di=****&dr=1030&f=667d****&response-content-disposition=attachment%3B%20'],
'Size' => ['description' => '文件大小,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594642'],
'DownloadType' => ['description' => '已废弃。', 'type' => 'string', 'example' => '无'],
'ExpirationSecond' => ['description' => '已废弃。', 'type' => 'string', 'example' => '无'],
'ExpirationTime' => ['description' => '文件下载链接的过期时间。', 'type' => 'string', 'example' => '2024-07-18T02:55:49.795Z'],
'FileId' => ['description' => '文件ID。', 'type' => 'string', 'example' => '667d5a322ebf7409e91c485d808fb3bd8a73****'],
],
],
],
'description' => '',
],
],
],
'title' => '下载企业网盘文件',
'summary' => '获取目标文件的下载链接。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadCdsFile'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DownloadCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E3ED9519-DD73-5C86-9C0A-43C9281C****\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"DownloadFileModel\\": {\\n \\"StreamUrl\\": \\"无\\",\\n \\"DownloadUrl\\": \\"https://pds-****-bj-169380****.oss-cn-beijing.aliyuncs.com/A0SK****?di=****&dr=1030&f=667d****&response-content-disposition=attachment%3B%20\\",\\n \\"Size\\": 1594642,\\n \\"DownloadType\\": \\"无\\",\\n \\"ExpirationSecond\\": \\"无\\",\\n \\"ExpirationTime\\": \\"2024-07-18T02:55:49.795Z\\",\\n \\"FileId\\": \\"667d5a322ebf7409e91c485d808fb3bd8a73****\\"\\n }\\n}","type":"json"}]',
],
'ExportClientEvents' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'EventType',
'in' => 'query',
'schema' => [
'description' => '要查询的事件类型。当EventTypes不为空时,则以EventTypes组合类型为查询过滤条件。当EventTypes为空,且EventType为空,则查询所有事件。',
'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' => '开始时间。按照[ISO 8601](~~25696~~)标准表示,并需要使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。 '."\n"
.'如果不填,则按`EndTime`指定的时间往前查询。', 'type' => 'string', 'required' => false, 'example' => '2022-03-23T04:10:21Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '结束时间。按照[ISO 8601](~~25696~~)标准表示,并需要使用UTC+0时间,格式为YYYY-MM-DDThh:mm:ssZ。 '."\n"
.'如果不填,则按当前时间。', 'type' => 'string', 'required' => false, 'example' => '2022-03-23T07:11:01Z'],
],
[
'name' => 'EventTypes',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '要查询的事件类型组合,可以多个事件组合,查询结果包含所有组合的事件。',
'type' => 'array',
'items' => [
'description' => '要查询的事件类型。',
'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' => '前端页面显示的语言类型,后端根据该语言类型设置导出文件的语言类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['zh-CN' => '简体中文 [默认值]', 'en-GB' => '英语(英国)'],
'example' => 'zh-CN',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '导出的记录数量。'."\n"
.'最大值:5000。'."\n"
.'默认值:5000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Url' => ['description' => '事件导出列表的下载地址。', '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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '导出客户端事件列表',
'summary' => '导出客户端事件列表。',
'changeSet' => [
['createdAt' => '2022-11-22T03:44:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-01-20T05:16:56.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportClientEvents'],
],
],
'ramActions' => [],
'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"}]',
],
'ExportDesktopGroupInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑所属的办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-467671****'],
],
[
'name' => 'DesktopGroupName',
'in' => 'query',
'schema' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'CloudComputerPool01'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。'."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-53iyi2aar0nd6****'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑的计费方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'ExpiredTime',
'in' => 'query',
'schema' => ['description' => '包年包月共享型云电脑的到期时间。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59Z'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑ID。可设置1~100个。', 'type' => 'string', 'required' => false, 'example' => 'dg-2i8qxpv6t1a03****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑的授权用户ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑的授权用户ID。可设置1~100个。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'LangType',
'in' => 'query',
'schema' => [
'description' => '语言类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['zh-CN' => '简体中文', 'en-GB' => '英文(英国)'],
'example' => 'zh-CN',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表,最多包含20个子项。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。可以为空字符串。最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'Url' => ['description' => '共享型云电脑列表导出文件的下载地址。导出文件包含的共享型云电脑详细信息包括:'."\n"
."\n"
.'- 共享型云电脑ID/名称'."\n"
.'- 办公网络ID/名称'."\n"
.'- 共享型云电脑模板'."\n"
.'- CPU/内存'."\n"
.'- 系统盘/数据盘'."\n"
.'- 安全策略名称'."\n"
.'- 当前授权用户数量'."\n"
.'- 付费类型'."\n"
.'- 创建时间'."\n"
.'- 到期时间', 'type' => 'string', 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********'],
'RequestId' => ['description' => '请求ID。', '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.', 'description' => '导出桌面组列表失败,请重试,如果依然失败请提交工单反馈; 可能原因:依赖的OSS服务权限被意外关停等'],
],
],
'title' => '导出共享型云电脑列表',
'summary' => '调用本接口导出的共享型云电脑列表将保存为XLSX文件。每条共享型云电脑数据包括共享型云电脑ID和名称、办公网络ID和名称、共享型云电脑模板、安全策略名称等。',
'changeSet' => [
['createdAt' => '2024-06-14T11:07:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-02T07:06:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-05-13T03:21:30.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopGroupInfo'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ExportDesktopGroupInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********\\",\\n \\"RequestId\\": \\"24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktopGroups_202203********_xBjqdCT***.xlsx?*********\\n 24E05D3E-08F4-551E-B1F0-F6D84EE0BCCC\\n","errorExample":""}]',
],
'ExportDesktopListInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '云电脑所属的云电脑池ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-boyczi8enfyc5***'],
],
[
'name' => 'DesktopStatus',
'in' => 'query',
'schema' => [
'description' => '云电脑状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'],
'example' => 'Running',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => ['description' => '当前正在使用云电脑的用户名。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'DesktopName',
'in' => 'query',
'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑关联的策略ID。', 'type' => 'string', 'required' => false, 'example' => 'system-all-enabled-policy'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '云电脑的计费方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费 [默认值]', 'PrePaid' => '包年包月'],
'example' => 'PostPaid',
],
],
[
'name' => 'ExpiredTime',
'in' => 'query',
'schema' => ['description' => '包年包月云电脑的到期时间。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-12-31T15:59Z'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑的授权用户名列表。可设置1~100个。'."\n"
."\n"
.'> 在同一时段内,只有一个用户可以连接和使用该云电脑。',
'type' => 'array',
'items' => ['description' => '云电脑的授权用户名。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'LangType',
'in' => 'query',
'schema' => [
'description' => '前端页面显示的语言类型,后端根据该语言类型设置导出文件的语言类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['zh-CN' => '简体中文 [默认值]', 'en-GB' => '英语(英国)'],
'example' => '`zh-CN`',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。一个标签由一对键值对组成,用于标记资源。您可以使用标签来分组管理云电脑,便于搜索和批量操作,详情参见[使用标签管理云电脑](~~203781~~)。',
'type' => 'array',
'items' => [
'description' => '标签键值对。可为每台云电脑设置1~20个键值对,一个标签键只能对应一个标签值。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。如果传入`Tag`,则`Key`是必填的。不可超过128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或者`https://`,也不能仅包含空格。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'],
'Value' => ['description' => '标签值。不可超过128个字符,不能以`aliyun`或`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'Url' => ['description' => '云电脑列表导出文件的下载地址。', 'type' => 'string', 'example' => 'https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********'],
'RequestId' => ['description' => '请求ID。', '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.', 'description' => '导出桌面列表失败,请重试,如果依然失败请提交工单反馈;'."\n"
.'可能原因:依赖的OSS服务权限被意外关停等'],
],
],
'title' => '导出云电脑列表',
'summary' => '将云电脑列表导出为CSV文件。',
'description' => '调用本接口导出的云电脑列表将保存为CSV文件,每条云电脑数据包括以下字段:'."\n"
."\n"
.'- 云电脑ID/云电脑名称'."\n"
.'- 办公网络ID/办公网络名称'."\n"
.'- 规格/系统/协议'."\n"
.'- 系统盘/数据盘'."\n"
.'- 状态'."\n"
.'- 购买方式'."\n"
.'- 过期时间'."\n"
.'- 剩余时长/总时长'."\n"
.'- 分配用户数/当前使用用户'."\n"
.'- 办公网络类型'."\n"
.'- 创建时间'."\n"
.'- 标签'."\n"
.'- 是否加密'."\n"
.'- IP'."\n"
.'- 主机名',
'changeSet' => [
['createdAt' => '2022-10-14T06:26:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-07T06:26:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-02T07:06:09.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-05-13T03:21:30.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopListInfo'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n https://cn-hangzhou-servicemanager.oss-cn-hangzhou.aliyuncs.com/A0_DESKTOP/EDS_CloudDesktops%20List_2022**********_w3fq******.csv?**********\\n D3DFB159-0FAD-5C96-9E1F-DDBF15534B71\\n","errorExample":""}]',
],
'GetAsyncTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****'],
],
[
'name' => 'AsyncTaskId',
'in' => 'query',
'schema' => ['description' => '异步任务ID。调用[CopyCdsFile](~~2247626~~)接口复制文件夹时,因为是后台异步复制,所以会返回该字段。调用本接口并传入该异步任务ID即可获取任务详细信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '81a8a07a-aec4-4dd5-80da-ae69e482****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'string',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Data' => [
'description' => '数据信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态。',
'type' => 'string',
'enumValueTitles' => ['Failed' => '失败', 'Running' => '运行中', 'PartialSucceed' => '部分成功', 'Succeed' => '成功'],
'example' => 'Failed',
],
'TotalProcess' => ['description' => '异步任务需处理总量,如服务端打包下载需打包的文件量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'Url' => ['description' => '异步任务生成数据的下载地址,如服务端打包下载任务生成下载地址。', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899eff525?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'],
'ErrCode' => ['description' => '异步任务错误码。', 'type' => 'integer', 'format' => 'int64', 'example' => 'InternalError'],
'AsyncTaskId' => ['description' => '异步任务ID。', 'type' => 'string', 'example' => '000e89fb-cf8f-11e9-8ab4-b6e98080****'],
'Message' => ['description' => '异步任务的错误信息。', 'type' => 'string', 'example' => 'The request failed due to some unknown errors. Please try again later.'],
'ConsumedProcess' => ['description' => '异步任务已处理总量,如服务端打包下载已打包的文件量。', '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' => '获取异步任务信息',
'summary' => '根据CopyCdsFile接口获得的AsyncTaskId返回参数获取文件夹复制异步任务的详细信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsyncTask'],
],
],
'ramActions' => [],
],
'GetConnectionTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '云电脑授权用户的用户名。必须传入云电脑现有的授权用户才能成功生成凭证。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => '云电脑授权用户的密码。', 'type' => 'string', 'required' => false, 'example' => 'Ab123456'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '云电脑连接任务ID。', 'type' => 'string', 'required' => false, 'example' => '2afbad19-778a-4fc5-9674-1f19c638****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '需生成连接凭证的云电脑ID。必须传入该字段才能成功生成凭证。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => '客户端唯一标识。若使用无影客户端,可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949'],
],
[
'name' => 'CommandContent',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '当前参数可以配置自定义用户态应用,当成功获取凭证后,自动执行应用。'."\n"
."\n"
.'- appPath:String类型,应用启动文件路径,例如:`"C:\\\\Program Files (x86)\\\\000\\\\000.exe"`,注意路径分隔符要用双斜杠(\\\\\\)。'."\n"
.'- appParameter:String类型,应用启动参数,例如:`"meetingid 000 meetingname aaa"`,注意参数与参数之间直接用空格。', '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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TaskStatus' => [
'description' => '任务状态。',
'type' => 'string',
'enumValueTitles' => ['FAILED' => '获取凭证失败', 'RUNNING' => '获取凭证中', 'FINISHED' => '获取完成'],
'example' => 'FINISHED',
],
'Ticket' => ['description' => '云电脑连接凭证。', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********'],
'TaskId' => ['description' => '云电脑连接任务ID。', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c638****'],
'TaskCode' => ['description' => '用于连接用户实例的Ticket,使用时需要先将其内容执行base64的解码,并保存为xxx.ica文件,然后打开这个文件。Python代码示例:'."\n"
."\n"
.'```'."\n"
.'import base64'."\n"
.'response = {'."\n"
.' "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",'."\n"
.' "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",'."\n"
.'}'."\n"
.'f = open (\'xxx.ica\', \'w\')'."\n"
.'out = base64.b64decode(response[\'Ticket\'])'."\n"
.'f.write(out)'."\n"
.'f.close()'."\n"
.'```', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********'],
'TaskMessage' => ['description' => '云电脑连接任务ID。', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c638****'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
],
'description' => '',
],
],
],
'title' => '获取连接凭证',
'summary' => '获取云电脑连接凭证。',
'description' => '云电脑的状态必须为运行中(Running),使用该接口获取的Ticket过期时间为10分钟。',
'changeSet' => [
['createdAt' => '2024-11-13T06:38:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-09-28T12:16:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-23T06:16:16.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '500', 'countWindow' => 30, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetConnectionTicket',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n}","type":"json"}]',
],
'GetCoordinateTicket' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CoId',
'in' => 'query',
'schema' => ['description' => '协同流ID。来自接口[ApplyCoordinationForMonitoring](~~ApplyCoordinationForMonitoring~~)返回的`Coid`。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'co-0sot77uale3****'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '云电脑连接任务ID。首次请求时不需要填写。首次请求如果没有返回Ticket,则后续请求根据首次返回的`TaskId`填写。', 'type' => 'string', 'required' => false, 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户的用户名。管理员侧不需要。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '用户类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['TENANT_ADMIN' => '管理员'],
'example' => 'TENANT_ADMIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'CoId' => ['description' => '协同流ID。', 'type' => 'string', 'example' => 'co-0sot77uale3****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TaskStatus' => [
'description' => '任务状态。',
'type' => 'string',
'enumValueTitles' => ['Finished' => '获取完成', 'Failed' => '获取凭证失败', 'Running' => '获取凭证中'],
'example' => 'Finished',
],
'TaskId' => ['description' => '云电脑连接任务ID。', 'type' => 'string', 'example' => '39cc15e5-6998-4b9f-9b2c-7a4cc3e2****'],
'Ticket' => ['description' => '协同流凭证。', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********'],
],
'description' => '',
],
],
],
'title' => '获取协同流凭证',
'summary' => '获取协同流凭证,用于进行远程协助或共享协同。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCoordinateTicket'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:GetCoordinateTicket',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CoId\\": \\"co-0sot77uale3****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"Finished\\",\\n \\"TaskId\\": \\"39cc15e5-6998-4b9f-9b2c-7a4cc3e2****\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\"\\n}","type":"json"}]',
],
'GetDesktopGroupDetail' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1B5268CE-5EB3-545F-9F38-A8BCF710****'],
'Desktops' => [
'description' => '共享型云电脑信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '共享型云电脑的状态。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['未支付', '正常', '欠费或已过期'],
'example' => '1',
],
'CreationTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-11-06T08:28Z'],
'PayType' => [
'description' => '付费类型。',
'type' => 'string',
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
'ResetType' => [
'description' => '云电脑重置类型。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['不重置', '只重置系统盘', '只重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '0',
],
'LoadPolicy' => [
'description' => '多会话多台共享型云电脑的负载均衡策略。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '0',
],
'PolicyGroupName' => ['description' => '共享型云电脑关联的策略名称。', 'type' => 'string', 'example' => 'All enabled policy'],
'Creator' => ['description' => '创建者的阿里云账号ID。', 'type' => 'string', 'example' => '155177335370****'],
'MaxDesktopsCount' => ['description' => '- 对于按量付费的共享型云电脑,该参数表示云电脑的最大创建数量。'."\n"
.'- 对于包年包月的共享型云电脑,该参数表示初始购买的云电脑数量(`BuyDesktopsCount`)与允许自动创建的云电脑数量之和。', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'AllowAutoSetup' => [
'description' => '是否允许包年包月共享型云电脑自动创建云电脑。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['不允许', '允许'],
'example' => '1',
],
'ResType' => [
'description' => '资源类型,目前仅支持ECS。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['ECS'],
'example' => '0',
],
'SystemDiskSize' => ['description' => '系统盘容量。单位为GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
'PolicyGroupId' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'example' => 'pg-9cktlowtxfl6****'],
'OwnBundleId' => ['description' => '云电脑模板ID。', 'type' => 'string', 'example' => 'b-1se9fb37r5tfq****'],
'GpuCount' => ['description' => 'GPU核数。', 'type' => 'number', 'format' => 'float', 'example' => '4'],
'AllowBufferCount' => ['description' => '该参数仅适用于按量付费的共享型云电脑,表示始终预留为已开机且空闲待连接状态的云电脑数量。取值范围:'."\n"
.' '."\n"
.'- 0:不预留'."\n"
.'- N:预留N台(1≤N≤100)', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Memory' => ['description' => '内存大小。单位为MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'],
'GpuSpec' => ['description' => 'GPU规格。', 'type' => 'string', 'example' => 'NVIDIA T4'],
'DirectoryId' => ['description' => '目录ID(办公网络ID)。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'OwnBundleName' => ['description' => '云电脑模板名称。', 'type' => 'string', 'example' => 'BundleDemo'],
'DataDiskCategory' => ['description' => '用户磁盘类型。', 'type' => 'string', 'example' => 'cloud_essd'],
'DesktopGroupName' => ['description' => '要查询的共享型云电脑名称。', 'type' => 'string', 'example' => 'CloudComputerPool01'."\n"],
'BindAmount' => ['description' => '多会话多台共享型云电脑中每台云电脑允许的并发会话数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'OwnType' => [
'description' => '共享型云电脑类型。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['单台共享型云电脑(单会话)', '多台共享型云电脑(多会话)'],
'example' => '0',
],
'SystemDiskCategory' => ['description' => '系统盘类型。', 'type' => 'string', 'example' => 'cloud_essd'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-990541****'],
'KeepDuration' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '180000'],
'MinDesktopsCount' => ['description' => '- 对于按量付费的共享型云电脑,该参数表示云电脑的最小创建数量。'."\n"
.'- 对于包年包月的共享型云电脑,该参数等同于`BuyDesktopsCount`,表示初始购买的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'DataDiskSize' => ['description' => '用户磁盘容量。单位为GiB。', 'type' => 'string', 'example' => '80'],
'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****'],
'OfficeSiteName' => ['description' => '共享型云电脑所属的办公网络名称。', 'type' => 'string', 'example' => 'test'],
'DirectoryType' => [
'description' => '目录类型。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'SIMPLE',
],
'Cpu' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'Comments' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'comment'],
'OfficeSiteType' => [
'description' => '办公网络的账号体系类型。',
'type' => 'string',
'enumValueTitles' => ['PERSONAL' => '个人型办公网络', 'SIMPLE' => '便捷办公网络', 'AD_CONNECTOR' => 'AD办公网络', 'RAM' => 'RAM型办公网络'],
'example' => 'SIMPLE',
],
'TimerInfos' => [
'description' => '定时时间列表。',
'type' => 'array',
'items' => [
'description' => '定时时间。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [1 => '启用', '禁用', '删除'],
'example' => '1',
],
'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 58 11 ? * 2'],
'TimerType' => [
'description' => '定时任务类型。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => [1 => '定时重置', '定时开机', '定时关机', '定时重启'],
'example' => '1',
],
'Forced' => ['description' => '是否强制执行该定时任务。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
'RatioThreshold' => ['description' => '会话占用率阈值,用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。', 'type' => 'number', 'format' => 'float', 'example' => '0.85'],
'ConnectDuration' => ['description' => '会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3600000'],
'IdleDisconnectDuration' => ['description' => '用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '900000'],
'Version' => ['description' => '共享型云电脑版本号。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'StopDuration' => ['description' => '空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '180000'],
'ProfileFollowSwitch' => ['description' => '是否开启用户数据漫游。', 'type' => 'boolean', 'example' => 'false'],
'NasFileSystemID' => ['description' => '用户数据漫游功能使用的NAS文件系统ID。', 'type' => 'string', 'example' => '0783b4****'],
'NasFileSystemName' => ['description' => '用户数据漫游功能使用的NAS文件系统名称。', 'type' => 'string', 'example' => 'abcd'],
'TimingStrategyInfo' => ['description' => '定时应用信息。', 'type' => 'string', 'example' => 'abcd'],
'ScaleTimerInfos' => [
'description' => '定时任务信息。',
'type' => 'array',
'items' => [
'description' => '定时任务信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '定时任务类型。',
'type' => 'string',
'enumValueTitles' => ['drop' => '下降策略', 'normal' => '正常策略', 'peak' => '高峰策略', 'rise' => '上升策略'],
'example' => 'rise',
],
'Cron' => ['description' => '定时任务的Cron表达式。', 'type' => 'string', 'example' => '0 0 0 * * ? '],
'LoadPolicy' => [
'description' => '多会话多台共享型云电脑的负载均衡策略。',
'type' => 'integer',
'format' => 'int32',
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '1',
],
'BuyResAmount' => ['description' => '伸缩策略参数之一:购买云电脑数。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'MinResAmount' => ['description' => '伸缩策略参数之一:云电脑最小数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxResAmount' => ['description' => '伸缩策略参数之一:云电脑最大数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'KeepDuration' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '180000'],
'RatioThreshold' => ['description' => '会话占用率阈值,用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。', 'type' => 'number', 'format' => 'float', 'example' => '0.85'],
],
],
],
'PolicyGroupIds' => [
'description' => '共享型云电脑关联的策略ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑关联的策略ID。', 'type' => 'string', 'example' => 'pd-abcd***'],
],
'PolicyGroupNames' => [
'description' => '共享型云电脑关联的策略名称列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑关联的策略名称。', 'type' => 'string', 'example' => 'All enabled policy'],
],
'BuyDesktopsCount' => ['description' => '该参数仅适用于包年包月的共享型云电脑,表示初始购买的云电脑数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****'],
'ExpiredTime' => ['description' => '包年包月共享型云电脑的到期时间。', 'type' => 'string', 'example' => '2021-12-31T15:59Z'],
'OsType' => ['type' => 'string', 'description' => ''],
'ProtocolType' => ['type' => 'string', 'description' => ''],
'ExpiredTimes' => [
'type' => 'array',
'items' => ['type' => 'string', 'description' => ''],
'description' => '',
],
'EnvType' => ['type' => 'string'],
'EnvId' => ['type' => 'string'],
],
],
],
],
],
],
'title' => '获取共享型云电脑详情',
'summary' => '获取一个共享型云电脑的详细信息。',
'changeSet' => [
['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-11T06:37:55.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDesktopGroupDetail'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetDesktopGroupDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'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 \\"EnvType\\": \\"\\",\\n \\"EnvId\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1B5268CE-5EB3-545F-9F38-A8BCF7105777\\n \\n 2022-02-17T14:51:07Z\\n PrePaid\\n test-policy\\n 1007214305******\\n 10\\n 1\\n 0\\n 80\\n pg-53iyi2aar0nd6****\\n bundle_eds_general_4c8g_s8d5_win2019\\n 1\\n 0\\n 16384\\n 16 GiB\\n cn-hangzhou+dir-adde******\\n test\\n cloud_ssd\\n test1\\n cloud_ssd\\n cn-hangzhou+dir-467671****\\n 1000\\n 1\\n 50\\n dg-2i8qxpv6t1a03****\\n testName\\n SIMPLE\\n 4\\n 2022-03-17T16:00:00Z\\n test\\n SIMPLE\\n 1\\n 0\\n \\n","errorExample":""}]',
],
'GetOfficeSiteSsoStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'SsoStatus' => [
'description' => '是否开启单点登录SSO。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '开启SSO', 'false' => '关闭SSO'],
'example' => 'false',
],
'RequestId' => ['description' => '请求ID。', '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":"\\n 9C013BF3-BA83-400E-85DF-861804F0948A\\n false\\n","errorExample":""}]',
'title' => '查询办公网络单点登录SSO开关状态',
'summary' => '查询办公网络是否开启了单点登录SSO功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOfficeSiteSsoStatus'],
],
],
'ramActions' => [],
],
'GetSpMetadata' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '办公网络ID,与`OfficeSiteId`含义相同。建议停止使用`DirectoryId`,改为使用`OfficeSiteId`。`DirectoryId`和`OfficeSiteId`只能填写一个,不可同时填写。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-400695****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'SpMetadata' => ['description' => 'SP元数据。', 'type' => 'string', 'example' => ''],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '获取服务提供商元数据',
'summary' => '获取基于SAML 2.0的服务提供商SP(Service Provider)的元数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSpMetadata'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetSpMetadata',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SpMetadata\\": \\"\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n <?xml version=************/md:EntityDescriptor>\\n D3506372-0840-466F-9E73-98D58432D6A7\\n","errorExample":""}]',
],
'HibernateDesktops' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-eumyo1qzxscjf****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '101AE027-8299-5E6E-A782-6C91C962****'],
],
],
],
],
'title' => '休眠一台或多台云电脑',
'summary' => '对云电脑执行休眠操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HibernateDesktops'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:HibernateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"101AE027-8299-5E6E-A782-6C91C962****\\"\\n}","type":"json"}]',
],
'ListCdsFiles' => [
'summary' => '查询网盘中的文件列表,以及获取文件的下载链接。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '分配了网盘的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-320357****'],
],
[
'name' => 'ParentFileId',
'in' => 'query',
'schema' => ['description' => '父文件ID。可通过本接口的返回参数`FileId`获取。', 'type' => 'string', 'required' => false, 'example' => '63636837e47e5a24a8a940218bef395c210e****'],
],
[
'name' => 'FileIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '需要查询的文件ID列表。',
'type' => 'array',
'items' => ['description' => '需要查询的文件ID。', 'type' => 'string', 'required' => false, 'example' => '[\\"635d3c12f70beed7b6f84a9bb7bd51aad910****\\"]'],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'description' => '文件列表排序方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['CreateTimeDesc' => '按创建时间降序排序', 'ModifiedTimeAsc' => '按修改时间升序排序', 'NameDesc' => '按文件名称降序排序', 'SizeAsc' => '按文件大小升序排序', 'ModifiedTimeDesc' => '按修改时间降序排序', 'CreateTimeAsc' => '按创建时间升序排序', 'SizeDesc' => '按文件大小降序排序', 'NameAsc' => '按文件名称升序排序'],
'example' => 'CreateTimeDesc',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '文件状态。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['available' => '只返回正常文件', 'uploading' => '只返回上传中的文件'],
'example' => 'available',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '查询凭证(Token)。取值为上一次调用该接口返回的`NextToken`参数值,初次调用接口时无需设置该参数。', 'type' => 'string', 'required' => false, 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。默认值:100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '100'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '登录的地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,`NextToken`为空表示没有下一个。', 'type' => 'string', 'example' => 'aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****'."\n"],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '40D86754-20FD-53DC-A9B8-25F7FECC****'],
'Count' => ['description' => '文件列表条目总数量。', 'type' => 'string', 'example' => '2'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'FileModels' => [
'description' => '文件列表。',
'type' => 'array',
'items' => [
'description' => '文件信息。',
'type' => 'object',
'properties' => [
'ContentType' => ['description' => '文件内容类型。', 'type' => 'string', 'example' => 'application/json'],
'FileType' => [
'description' => '文件类型。',
'type' => 'string',
'enumValueTitles' => ['file' => '文件', 'folder' => '文件夹'],
'example' => 'file',
],
'FileExtension' => ['description' => '文件的后缀名。', 'type' => 'string', 'example' => 'pdf'],
'FileId' => ['description' => '文件ID。', 'type' => 'string', 'example' => '637725ff2f63db8470984e6c92c692b87d52****'],
'Creator' => ['description' => '文件的创建者。', 'type' => 'string', 'example' => 'demo_user01@cn-shanghai.148875033399****'],
'OpenTime' => ['description' => '最近一次打开文件的时间。', 'type' => 'string', 'example' => '2022-09-06T07:27:08Z'],
'ParentId' => ['description' => '父文件夹ID。', 'type' => 'string', 'example' => '3343213ff2f63db8470984e6c92c3213dfdw****'."\n"],
'Modifier' => ['description' => '修改者。', 'type' => 'string', 'example' => 'demo_user02@cn-shanghai.148875033399****'],
'Description' => ['description' => '文件描述。', 'type' => 'string', 'example' => 'test1'],
'Name' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'SampleFile.pdf'],
'DownloadUrl' => ['description' => '下载链接,默认有效时间是15分钟。', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'],
'Sha1' => ['description' => '数据文件的SHA1哈希值。', 'type' => 'string', 'example' => 'EA4942AA8761213890A5C386F88E6464D2C3****'],
'OpenTimeStamp' => ['description' => '最后一次打开文件的时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '168951245231'],
'RegionId' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'example' => 'cn-beijing'],
'FilePath' => ['description' => '文件路径。', 'type' => 'string', 'example' => 'isv/1019236948660053/temp/'],
'Size' => ['description' => '文件大小。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'example' => '102400'],
'Category' => ['description' => '文件类型分类。网盘会根据文件的后缀名和MIME Type对文件进行分了分类,主要分类有`doc`、`image`、`audio`、`video`。', 'type' => 'string', 'example' => 'image'],
'Md5' => ['description' => '文件MD5值。', 'type' => 'string', 'example' => '63c83ececb4e6926c51448fc5ecb****'],
'Thumbnail' => ['description' => '缩略图地址。', 'type' => 'string', 'example' => 'https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-09-06T07:27:08Z'],
'ModifiedTime' => ['description' => '最后一次修改文件的时间。', 'type' => 'string', 'example' => '2022-09-06T07:27:08Z'],
],
],
],
],
'description' => '',
],
],
],
'title' => '查询网盘文件及获取文件下载链接',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-05-16T10:59:10.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCdsFiles'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"aGN4YzAxQGNuLWhhbmd6aG91LjExNzU5NTMyNjgzMTQ1****\\\\n\\",\\n \\"RequestId\\": \\"40D86754-20FD-53DC-A9B8-25F7FECC****\\",\\n \\"Count\\": \\"2\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"FileModels\\": [\\n {\\n \\"ContentType\\": \\"application/json\\",\\n \\"FileType\\": \\"file\\",\\n \\"FileExtension\\": \\"pdf\\",\\n \\"FileId\\": \\"637725ff2f63db8470984e6c92c692b87d52****\\",\\n \\"Creator\\": \\"demo_user01@cn-shanghai.148875033399****\\",\\n \\"OpenTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ParentId\\": \\"3343213ff2f63db8470984e6c92c3213dfdw****\\\\n\\",\\n \\"Modifier\\": \\"demo_user02@cn-shanghai.148875033399****\\",\\n \\"Description\\": \\"test1\\",\\n \\"Name\\": \\"SampleFile.pdf\\",\\n \\"DownloadUrl\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"Sha1\\": \\"EA4942AA8761213890A5C386F88E6464D2C3****\\",\\n \\"OpenTimeStamp\\": 168951245231,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"FilePath\\": \\"isv/1019236948660053/temp/\\",\\n \\"Size\\": 102400,\\n \\"Category\\": \\"image\\",\\n \\"Md5\\": \\"63c83ececb4e6926c51448fc5ecb****\\",\\n \\"Thumbnail\\": \\"https://data.aliyunpds.com/hz22%2F5d5b986facbec311ef844c25954f96821497b383%2F5d5b986f955410dd991646bb87c6b4e899ef****?Expires=xxx&OSSAccessKeyId=xxx&Signature=xxx\\",\\n \\"CreateTime\\": \\"2022-09-06T07:27:08Z\\",\\n \\"ModifiedTime\\": \\"2022-09-06T07:27:08Z\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListDirectoryUsers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => '模糊查询字符串。包含该字符串的结果都将被匹配出来。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => 'AD目录ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'OUPath',
'in' => 'query',
'schema' => ['description' => '指定用户所属的AD域组织单元(OU)。可通过[ListUserAdOrganizationUnits](~~311259~~)接口获取。', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers'],
],
[
'name' => 'AssignedInfo',
'in' => 'query',
'schema' => ['description' => '> 该字段未开放使用。只能传入`1`或者不传入任何值。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => [
'description' => '排序方法。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['asc' => '已分配云电脑的用户排在后面', 'desc' => '已分配云电脑的用户排在前面'],
'example' => 'asc',
],
],
[
'name' => 'IncludeAssignedUser',
'in' => 'query',
'schema' => ['description' => '是否只返回分配云电脑的用户。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Users' => [
'description' => 'AD目录对应的用户名称组成的数组。如果AD目录对应的用户只有Administrator和Guest,而没有其他用户,将返回空的Users数组。',
'type' => 'array',
'items' => [
'description' => 'AD目录对应的用户名称对象。',
'type' => 'object',
'properties' => [
'EndUser' => ['description' => '用户名称。', 'type' => 'string', 'example' => 'Alice'],
'DisplayName' => ['description' => '显示名称。', 'type' => 'string', 'example' => 'Alice'],
'AssignedDesktopNumber' => ['description' => '分配的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Email' => ['description' => '邮箱。', 'type' => 'string', 'example' => 'user@example.com'],
'Phone' => ['description' => '手机号码。', 'type' => 'string', 'example' => '130********'],
'DisplayNameNew' => ['type' => 'string', 'description' => ''],
'UserPrincipalName' => ['type' => 'string', 'description' => ''],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"Alice\\",\\n \\"DisplayName\\": \\"Alice\\",\\n \\"AssignedDesktopNumber\\": 2,\\n \\"Email\\": \\"user@example.com\\",\\n \\"Phone\\": \\"130********\\",\\n \\"DisplayNameNew\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询AD目录对应的用户信息',
'summary' => '如果您使用AD目录来对接企业自有AD,调用该接口可以获取企业AD中的用户信息。',
'changeSet' => [
['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-09-06T14:19:41.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDirectoryUsers'],
],
],
'ramActions' => [],
],
'ListFilePermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-346063****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-c3acvkkbsfkte****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'FilePermissions' => [
'description' => '文件权限信息集合。',
'type' => 'array',
'items' => ['description' => '共享权限。', '$ref' => '#/components/schemas/FilePermissionMember'],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"FilePermissions\\": [\\n {\\n \\"RoleId\\": \\"SystemFileEditor\\",\\n \\"ExpireTime\\": 1633598866642,\\n \\"DisinheritSubGroup\\": true,\\n \\"CdsIdentity\\": {\\n \\"Id\\": \\"16435bdf934248b788b7b3771ee9****\\",\\n \\"Type\\": \\"IT_User\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询网盘共享文件夹',
'summary' => '查询网盘中的共享文件夹的权限信息。',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:33.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFilePermission'],
],
],
'ramActions' => [],
],
'ListInstalledApps' => [
'summary' => '查询云电脑内安装的应用',
'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' => '云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'ecd-39clsqyxr****'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。 '."\n"
.'默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时,当前页的页码。 '."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '94'],
'Apps' => [
'description' => '应用列表。',
'type' => 'array',
'items' => [
'description' => '应用详情。',
'type' => 'object',
'properties' => [
'AppName' => ['description' => '应用名称。', 'type' => 'string', 'example' => 'test_app'],
'AppVersion' => ['description' => '应用版本。', 'type' => 'string', 'example' => '2.0.1'],
],
],
],
],
],
],
],
'title' => '查询云电脑内安装应用',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'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"}]',
],
'ListOfficeSiteOverview' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ForceRefresh',
'in' => 'query',
'schema' => [
'description' => '是否刷新缓存。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '跳过缓存获取最新数据。', 'false' => '获取缓存中的数据,可以提升接口性能。'],
'example' => 'false',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时,每页最大行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'exclusiveMinimum' => true, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一次查询的令牌(Token)。第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '办公网络ID。可指定1~100个。',
'type' => 'array',
'items' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****'],
'required' => false,
'example' => 'cn-hangzhou+dir-363353****',
'maxItems' => 100,
],
],
[
'name' => 'QueryRange',
'in' => 'query',
'schema' => [
'description' => '查询范围。池化云电脑是指云电脑池(原桌面组)中的云电脑。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [1 => '查询办公网络内的非池化云电脑 [默认值]', '查询办公网络内的池化云电脑', '查询办公网络下所有云电脑'],
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'OfficeSiteOverviewResults' => [
'description' => '办公网络信息集合。',
'type' => 'array',
'items' => [
'description' => '办公网络信息。',
'type' => 'object',
'properties' => [
'OfficeSiteStatus' => [
'description' => '办公网络状态。',
'type' => 'string',
'enumValueTitles' => ['CONFIGUSERFAILED' => '配置用户失败', 'REGISTERING' => '注册中', 'REGISTERED' => '已注册', 'NEEDCONFIGTRUST' => '请配置信任关系', 'CONFIGUSERING' => '正在配置用户', 'CONFIGTRUSTFAILED' => '配置信任失败', 'ERROR' => '错误', 'CONFIGTRUSTING' => '正在配置信任关系', 'NEEDCONFIGUSER' => '请配置用户'],
'example' => 'REGISTERED',
],
'TotalEdsCount' => ['description' => '办公网络内云电脑的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalEdsCountForGroup' => ['description' => '云电脑池中的云电脑的总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'WillExpiredEdsCount' => ['description' => '办公网络内即将过期的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'WillExpiredEdsCountForGroup' => ['description' => '云电脑池中即将过期的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'],
'RunningEdsCount' => ['description' => '办公网络内正在运行中的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RunningEdsCountForGroup' => ['description' => '云电脑池中正在运行的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'OfficeSiteName' => ['description' => '办公网络名称。', 'type' => 'string', 'example' => 'test'],
'VpcType' => [
'description' => '办公网络VPC网络类型。',
'type' => 'string',
'enumValueTitles' => ['standard' => '标准型办公网络,独占VPC。 [默认值]', 'customized' => '定制型办公网络,用户侧VPC。', 'basic' => '基础型办公网络,共享VPC。'],
'example' => 'standard',
],
'HasExpiredEdsCount' => ['description' => '办公网络内已过期的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'HasExpiredEdsCountForGroup' => ['description' => '云电脑池中已过期的云电脑数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RegionId' => ['description' => '办公网络所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
],
'title' => '查询办公网络的概览信息',
'summary' => '查询办公网络(原工作区)的概览信息,包括状态、云电脑数量、VPC网络类型等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-04-13T07:45:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-12-09T02:01:26.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-11-05T08:49:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteOverview'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListOfficeSiteOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSiteOverviewResults\\": [\\n {\\n \\"OfficeSiteStatus\\": \\"REGISTERED\\",\\n \\"TotalEdsCount\\": 1,\\n \\"TotalEdsCountForGroup\\": 1,\\n \\"WillExpiredEdsCount\\": 0,\\n \\"WillExpiredEdsCountForGroup\\": 0,\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"RunningEdsCount\\": 1,\\n \\"RunningEdsCountForGroup\\": 1,\\n \\"OfficeSiteName\\": \\"test\\",\\n \\"VpcType\\": \\"standard\\",\\n \\"HasExpiredEdsCount\\": 0,\\n \\"HasExpiredEdsCountForGroup\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n EC330A26-1940-4A26-A4C8-E99AE907E25B\\n \\n cn-hangzhou+dir-363353****\\n 0\\n 1\\n 0\\n 1\\n test\\n cn-hangzhou\\n REGISTERED\\n \\n","errorExample":""}]',
],
'ListOfficeSiteUsers' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => '模糊查询字符串。', 'type' => 'string', 'required' => false, 'example' => '*jin*'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。仅支持基于企业AD账号的办公网络。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。 '."\n"
."\n"
.'- 最大值:100。 '."\n"
.'- 默认值:10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'OUPath',
'in' => 'query',
'schema' => ['description' => '指定的AD域组织单元。', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers'],
],
[
'name' => 'AssignedInfo',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'IncludeAssignedUser',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC21DB0'],
'Users' => [
'description' => 'AD账号用户名组成的数组。 '."\n"
.'如果企业AD中的用户只有Administrator和Guest,没有其他用户,则将返回空的Users数组。',
'type' => 'array',
'items' => [
'description' => 'AD账号的用户名。',
'type' => 'object',
'properties' => [
'EndUser' => ['description' => 'AD账号的用户名。', 'type' => 'string', 'example' => 'aduser'],
'DisplayName' => ['description' => 'AD账号的显示名称。', 'type' => 'string', 'example' => 'aduser'],
'AssignedDesktopNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'Email' => ['type' => 'string', 'description' => ''],
'Phone' => ['type' => 'string', 'description' => ''],
'UserPrincipalName' => ['type' => 'string', 'description' => ''],
'DisplayNameNew' => ['type' => 'string', 'description' => ''],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC21DB0\\",\\n \\"Users\\": [\\n {\\n \\"EndUser\\": \\"aduser\\",\\n \\"DisplayName\\": \\"aduser\\",\\n \\"AssignedDesktopNumber\\": 0,\\n \\"Email\\": \\"\\",\\n \\"Phone\\": \\"\\",\\n \\"UserPrincipalName\\": \\"\\",\\n \\"DisplayNameNew\\": \\"\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 269BDB16-2CD8-4865-84BD-11C40BC21DB0\\n \\n Alice\\n \\n","errorExample":""}]',
'title' => '查询AD账号信息',
'summary' => '查询AD办公网络(原工作区)对接AD域后获取的AD账号信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-09T06:40:10.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteUsers'],
],
],
'ramActions' => [],
],
'ListTagResources' => [
'summary' => '查询云电脑已添加标签的列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => '云电脑'],
'example' => 'ALIYUN::GWS::INSTANCE',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即云电脑ID列表。可包含1\\~50个。',
'type' => 'array',
'items' => ['description' => '资源ID,即云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
'required' => false,
'example' => 'ecd-ia2zw38bi6cm7****',
'maxItems' => 50,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。可包含1\\~20个。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'Value' => ['description' => '标签值。可包含1\\~20个。', 'type' => 'string', 'required' => false, 'example' => 'design'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5BA78C'],
'TagResources' => [
'description' => '资源及其标签信息集合。',
'type' => 'array',
'items' => [
'description' => '资源及其标签信息。',
'type' => 'object',
'properties' => [
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'design'],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => '云电脑'],
'example' => 'ALIYUN::GWS::INSTANCE',
],
'ResourceId' => ['description' => '资源ID,即云电脑ID。', 'type' => 'string', 'example' => 'ecd-ia2zw38bi6cm7****'],
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'department'],
],
],
],
],
],
],
],
'title' => '查询云电脑已添加标签的列表',
'description' => '请求中至少指定一个参数:`ResourceId.N`、`Tag.N.Key`或者`Tag.N.Value`,以确定查询对象。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\",\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5BA78C\\",\\n \\"TagResources\\": [\\n {\\n \\"TagValue\\": \\"design\\",\\n \\"ResourceType\\": \\"ALIYUN::GWS::INSTANCE\\",\\n \\"ResourceId\\": \\"ecd-ia2zw38bi6cm7****\\",\\n \\"TagKey\\": \\"department\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a4883\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n \\n ecd-ia2zw38bi6cm7****\\n TestKey\\n ALIYUN::GWS::INSTANCE\\n TestValue\\n \\n","errorExample":""}]',
],
'ListTransferFileDownloadUrl' => [
'summary' => '获取传输文件的下载地址',
'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' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'trt-hffhi4nmqoi4****'],
],
[
'name' => 'FileIds',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '需要查询的文件ID列表。',
'type' => 'array',
'items' => ['description' => '需要查询的文件ID。', 'type' => 'string', 'required' => false, 'example' => 'trf-i4pz8emx2k2fr****'],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F1F01499-8F3D-5657-91AD-48177EB****'],
'Urls' => [
'description' => '文件下载地址链接信息列表。',
'type' => 'array',
'items' => [
'description' => '文件下载地址链接信息列表。',
'type' => 'object',
'properties' => [
'FileId' => ['description' => '文件ID。', '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'],
],
],
],
],
],
],
],
'title' => '获取传输文件的下载地址',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListTransferFileDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F1F01499-8F3D-5657-91AD-48177EB****\\",\\n \\"Urls\\": [\\n {\\n \\"FileId\\": \\"trf-i4pz8emx2k2fr****\\",\\n \\"Url\\": \\"http://xxsy-transfer.oss-cn-beijing.aliyuncs.com/xxxx\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"FileName\\": \\"document.txt\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListTransferFiles' => [
'summary' => '查询传输任务的文件信息。',
'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' => '传输任务ID。', 'type' => 'string', 'required' => false, 'example' => 'trt-03tdwg4tcuwdzv****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始的Token,NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'NextToken' => ['description' => '下一个查询开始的Token,`NextToken`为空表示没有下一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a****'],
'MaxResults' => ['description' => '分页查询时每页行数。'."\n"
."\n"
.'最大值:100。'."\n"
."\n"
.'默认值:20。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Files' => [
'description' => '文件信息列表。',
'type' => 'array',
'items' => [
'description' => '文件信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '文件ID。', 'type' => 'string', 'example' => 'trf-a213msf****'],
'Name' => ['description' => '文件名称。', 'type' => 'string', 'example' => 'Test file'],
'IconUrl' => ['description' => '文件图标地址。 '."\n"
.'> '."\n"
.'> - 图片类型文件(png, jpg, jpeg, gif, webp, svg)会返回图片访问地址'."\n"
.'> - 其他类型文件会返回默认图片地址', 'type' => 'string', 'example' => 'https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****'],
'Type' => ['description' => '文件类型。', 'type' => 'string', 'example' => 'txt'],
'Size' => ['description' => '文件大小。', 'type' => 'string', 'example' => '10853079'],
'Status' => [
'description' => '文件状态。',
'type' => 'string',
'enumValueTitles' => ['DELETING' => '删除中', 'DELETED' => '已删除', 'UPLOADED' => '正常'],
'example' => 'DELETED',
],
'OssFilePath' => ['description' => '存储在OSS中的文件路径。'."\n"
.'> '."\n"
.'> - 仅在自定义bucket时返回。', 'type' => 'string', 'example' => 'transfer/1244234/****'],
'OssFileName' => ['description' => '存储在OSS中的文件名称。'."\n"
.'> '."\n"
.'> - 仅在自定义bucket时返回。', 'type' => 'string', 'example' => 'Test file_0982836423402342'],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"MaxResults\\": 20,\\n \\"Files\\": [\\n {\\n \\"Id\\": \\"trf-a213msf****\\",\\n \\"Name\\": \\"Test file\\",\\n \\"IconUrl\\": \\"https://app-center-icon-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/tenant****\\",\\n \\"Type\\": \\"txt\\",\\n \\"Size\\": \\"10853079\\",\\n \\"Status\\": \\"DELETED\\",\\n \\"OssFilePath\\": \\"transfer/1244234/****\\",\\n \\"OssFileName\\": \\"Test file_0982836423402342\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询传输文件信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListTransferFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListUserAdOrganizationUnits' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => 'AD办公网络的ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-485361****'],
],
[
'name' => 'Filter',
'in' => 'query',
'schema' => ['description' => '模糊搜索字符串。', 'type' => 'string', 'required' => false, 'example' => 'develop'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '是否拥有下一次查询的令牌(Token)。取值:第一次查询和没有下一次查询时,均无需填写。如果有下一次查询,取值为上一次API调用返回的NextToken值。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => '返回的最大数。取值范围:1~500。'."\n"
.'默认值:500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'example' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'OUNames' => [
'description' => 'AD域的组织单元OU信息。',
'type' => 'array',
'items' => [
'description' => 'AD域的组织单元OU对象。',
'type' => 'object',
'properties' => [
'OfficeSiteId' => ['description' => 'AD办公网络的ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-485361****'],
'OUName' => ['description' => '用户AD域控的组织单元(CanonicalName)。', 'type' => 'string', 'example' => 'example.com/wuying_computers'],
'DisplayOUName' => ['description' => '组织单元名称。', 'type' => 'string', 'example' => 'wuying_computers'],
],
],
],
'NextToken' => ['description' => '下一个查询开始的Token。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OUNames\\": [\\n {\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-485361****\\",\\n \\"OUName\\": \\"example.com/wuying_computers\\",\\n \\"DisplayOUName\\": \\"wuying_computers\\"\\n }\\n ],\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4883\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n example.com/Domain Controllers\\n cn-hangzhou+dir-485361****\\n \\n 28978806-3938-5774-B107-0DAEC97C5BD1\\n","errorExample":""}]',
'title' => '获取AD域的组织单元',
'summary' => '获取AD办公网络(原工作区)对接的AD域的组织单元OU信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-12-14T07:34:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-23T07:50:49.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUserAdOrganizationUnits'],
],
],
'ramActions' => [],
],
'LockVirtualMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => ['description' => '虚拟MFA设备的序列号,也是其唯一标识。您可以调用[DescribeVirtualMFADevices](~~DescribeVirtualMFADevices~~)查询AD账号绑定的虚拟MFA设备序列号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '锁定虚拟MFA设备',
'summary' => '锁定处于正常(NORMAL)状态的虚拟MFA设备。',
'description' => '锁定后,MFA设备的状态将变为锁定(LOCKED),对应的AD账号将因为无法认证MFA设备而无法登录无影终端。您可以调用[UnlockVirtualMFADevice](~~UnlockVirtualMFADevice~~)进行解锁。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LockVirtualMFADevice'],
],
],
'ramActions' => [],
],
'MigrateDesktops' => [
'summary' => '将云电脑从当前所属办公网络(原工作区)迁移到新的办公网络。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'TargetOfficeSiteId',
'in' => 'query',
'schema' => ['description' => '目标办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen+dir-388505****'],
],
[
'name' => 'TargetSubnetId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false],
],
[
'name' => 'TargetMemberIp',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-39clsqyxr****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E46DECEC-AC72-570E-958B-B52A4B****'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ChooseClusterError.ZoneId', 'errorMessage' => 'Cannot choose zone, please try other zone.', 'description' => '资源可用区属性不匹配,请确认目标办公网络是否支持资源所属可用区'],
],
],
'title' => '将云电脑迁移至其他办公网络',
'changeSet' => [
['createdAt' => '2024-11-20T09:52:49.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2024-06-19T06:02:54.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-01T13:41:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:MigrateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E46DECEC-AC72-570E-958B-B52A4B****\\"\\n}","type":"json"}]',
],
'MigrateImageProtocol' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'TargetProtocolType',
'in' => 'query',
'schema' => [
'description' => '目标镜像协议,当前仅支持填入ASP。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
],
[
'name' => 'ImageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '镜像ID。',
'type' => 'array',
'items' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-gqudcafrqcex9****'],
'required' => true,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4D4E5AF5-DF28-5FE7-85C7-9F98315B****'],
'FailedIds' => [
'description' => '失败的镜像ID列表。',
'type' => 'array',
'items' => ['description' => '失败的镜像ID。', 'type' => 'string', 'example' => '[\'m-5rsjelm66bs3j****\']'],
],
],
'description' => '',
],
],
],
'title' => '迁移镜像协议',
'summary' => '将镜像的协议升级为ASP协议。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateImageProtocol'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:MigrateImageProtocol',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D4E5AF5-DF28-5FE7-85C7-9F98315B****\\",\\n \\"FailedIds\\": [\\n \\"[\'m-5rsjelm66bs3j****\']\\"\\n ]\\n}","type":"json"}]',
],
'ModifyADConnectorDirectory' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '目录ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd**** '],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '域名称。长度为2~255个字符,格式为两段式域名,如:`example.com`。相同的域名只能注册一次。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'DomainUserName',
'in' => 'query',
'schema' => ['description' => '域管理员的用户名。最长支持64个英文字符。', 'type' => 'string', 'required' => false, 'example' => 'sAMAccountName'],
],
[
'name' => 'DomainPassword',
'in' => 'query',
'schema' => ['description' => '域管理员的用户密码。最长支持64个英文字符。', 'type' => 'string', 'required' => false, 'example' => 'testPassword'],
],
[
'name' => 'DirectoryName',
'in' => 'query',
'schema' => ['description' => '目录名称。', 'type' => 'string', 'required' => false, 'example' => 'testDirectoryName '],
],
[
'name' => 'SubDomainName',
'in' => 'query',
'schema' => ['description' => '企业已有AD子域的域名称。', 'type' => 'string', 'required' => false, 'example' => 'child.example.com '],
],
[
'name' => 'MfaEnabled',
'in' => 'query',
'schema' => [
'description' => '是否启用MFA认证。开启后,该目录下的所有AD用户登录云电脑时,输入正确密码后,还需输入虚拟MFA设备生成的动态验证码。'."\n"
."\n"
.'> 首次登录时,需绑定MFA设备。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '启用MFA认证', 'false' => '不启用MFA认证 [默认值]'],
'example' => 'false',
],
],
[
'name' => 'DnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业AD对应DNS的IP地址。目前仅支持设置一个。请确保该IP地址在所选的交换机网络下可以访问。',
'type' => 'array',
'items' => ['description' => '企业AD对应DNS的IP地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => false,
'example' => '127.0.**.** ',
'maxItems' => 1,
],
],
[
'name' => 'SubDomainDnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业已有AD子域的DNS地址。 '."\n"
.'如果设置了`SubDomainName`,而未设置此参数,则认为子域DNS和父域一致。',
'type' => 'array',
'items' => ['description' => '企业已有AD子域的DNS地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => false,
'example' => '127.0.**.** ',
'maxItems' => 1,
],
],
[
'name' => 'AdHostname',
'in' => 'query',
'schema' => ['description' => '域控主机名。'."\n"
.'必须符合Windows主机命名规范。', 'type' => 'string', 'required' => false, 'example' => 'cnshsv21hmcdc01'],
],
[
'name' => 'OUName',
'in' => 'query',
'schema' => ['description' => 'AD域的组织单元OU。您可以调用[ListUserAdOrganizationUnits](~~311259~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]',
'title' => '修改AD目录',
'summary' => '修改AD目录。',
'description' => '仅支持状态为错误(ERROR)或者注册中(REGISTERING)的AD目录修改域名和DNS相关参数,包括`DomainName`、`SubDomainName`、`DnsAddress.N`、`SubDomainDnsAddress`。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorDirectory'],
],
],
'ramActions' => [],
],
'ModifyADConnectorOfficeSite' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '企业AD的域名。相同的域名只能注册一次。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'DomainUserName',
'in' => 'query',
'schema' => ['description' => '域管理员的用户名。最长支持64个英文字符。'."\n"
."\n"
.'> 用户名请使用sAMAccountName,不能使用userPrincipalName。', 'type' => 'string', 'required' => false, 'example' => 'Administrator'],
],
[
'name' => 'DomainPassword',
'in' => 'query',
'schema' => ['description' => '域管理员的用户密码。最长支持64个英文字符。', 'type' => 'string', 'required' => false, 'example' => 'testPassword'],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(_)或者连字符(-)。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'SubDomainName',
'in' => 'query',
'schema' => ['description' => '企业AD子域的域名。', 'type' => 'string', 'required' => false, 'example' => 'child.example.com'],
],
[
'name' => 'MfaEnabled',
'in' => 'query',
'schema' => [
'description' => '是否开启多因素认证MFA。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '开启MFA', 'false' => '不开启MFA [默认值]'],
'example' => 'false',
],
],
[
'name' => 'DnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业AD对应DNS的IP地址。目前仅支持设置一个。',
'type' => 'array',
'items' => ['description' => '企业AD对应DNS的IP地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => false,
'example' => '127.0.*.*',
'maxItems' => 1,
],
],
[
'name' => 'SubDomainDnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '企业AD子域的DNS地址。目前仅支持设置一个。如果设置了`SubDomainName`,而未设置此参数,则默认为子域DNS和父域的一致。',
'type' => 'array',
'items' => ['description' => '企业AD子域的DNS地址。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
'required' => false,
'example' => '127.0.*.*',
'maxItems' => 1,
],
],
[
'name' => 'AdHostname',
'in' => 'query',
'schema' => ['description' => '域控主机名。'."\n"
.'必须符合Windows主机命名规范。', 'type' => 'string', 'required' => false, 'example' => 'beijing-ad01'],
],
[
'name' => 'OUName',
'in' => 'query',
'schema' => ['description' => 'AD域的组织单元OU。您可以调用[ListUserAdOrganizationUnits](~~311259~~)获取。', 'type' => 'string', 'required' => false, 'example' => 'example.com/Domain Controllers'],
],
[
'name' => 'BackupDns',
'in' => 'query',
'schema' => ['description' => '备用域控DNS地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.2.100'],
],
[
'name' => 'BackupDCHostname',
'in' => 'query',
'schema' => ['description' => '备用域控主机名。', 'type' => 'string', 'required' => false, 'example' => 'dc002'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3FE99D5E-93A1-493F-B1CB-0ABD4D05BEFF\\r\\n","errorExample":""}]',
'title' => '修改AD办公网络',
'summary' => '修改AD办公网络(原工作区)的基本属性,例如办公网络名称、企业AD子域的域名等。',
'description' => '仅状态为错误`ERROR`或者注册中`REGISTERING`的AD办公网络支持修改域名和DNS相关参数,包括`DomainName`、`SubDomainName`、`DnsAddress.N`、`SubDomainDnsAddress.N`。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-06-26T07:31:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorOfficeSite'],
],
],
'ramActions' => [],
],
'ModifyAclEntries' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => [
'description' => '公网访问控制策略对应的粒度。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['desktop' => '云电脑粒度', 'vpc' => '办公网络粒度'],
'example' => 'desktop',
],
],
[
'name' => 'SourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '公网访问控制对应的实例ID列表,即办公网络ID列表或云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '公网访问控制对应的实例ID,即办公网络ID或云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-afhjuiwhfia***'],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => [
'description' => '公网访问控制策略。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['allow' => '允许访问公网', 'deny' => '禁止访问公网'],
'example' => 'allow',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '062B1439-709A-580E-85DF-CE97A1560565'],
],
],
],
],
'title' => '修改公网访问控制策略',
'summary' => '修改办公网络或云电脑粒度上的公网访问控制策略。',
'description' => '您可以在不同的粒度上设置不同的公网访问控制策略来实现复合策略的效果。例如,您可以在办公网络粒度上设置为禁止访问公网,同时在指定的云电脑粒度上设置为允许访问公网,则实现的效果为,该办公网络下除了上述指定云电脑之外的云电脑都禁止访问公网。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAclEntries'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyAclEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"062B1439-709A-580E-85DF-CE97A1560565\\"\\n}","type":"json"}]',
],
'ModifyAutoSnapshotPolicy' => [
'summary' => '修改自动快照策略的配置项,包括策略名称、快照保留时间等。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyId',
'in' => 'query',
'schema' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => true, 'example' => 'sp-itcmrhqt01tdo****'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => '自动快照策略的名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。默认值:空。', 'type' => 'string', 'required' => false, 'example' => '系统自动快照', 'maxLength' => 64, 'minLength' => 2],
],
[
'name' => 'RetentionDays',
'in' => 'query',
'schema' => ['description' => '自动快照的保留时间,单位为天。取值范围:1\\~180。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'CronExpression',
'in' => 'query',
'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => false, 'example' => '0 20 16 ? * 1,2,3,4,5,6,7'],
],
[
'name' => 'DiskType',
'in' => 'query',
'schema' => [
'description' => '自动快照策略要创建的快照的磁盘类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM' => '系统盘', 'ALL' => '所有磁盘', 'DATA' => '数据盘'],
'example' => 'ALL',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\"\\n}","type":"json"}]',
'title' => '修改自动快照策略',
'changeSet' => [
['createdAt' => '2025-09-22T03:48:31.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-08T08:35:15.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-03-02T02:41:20.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'],
],
],
'ramActions' => [],
],
'ModifyBundle' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'BundleId',
'in' => 'query',
'schema' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b-2g65ljy4291vl****'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '新的镜像ID。新镜像需满足以下条件:'."\n"
."\n"
.'- 新镜像的状态必须为可用(Available)。'."\n"
."\n"
.'- 新镜像的操作系统必须与原镜像相同。'."\n"
."\n"
.'- 新镜像对应所需的磁盘大小不能大于原镜像。'."\n"
."\n"
.'- 新镜像的GPU类型必须与原镜像相同。', 'type' => 'string', 'required' => false, 'example' => 'm-aea3oaww001np****'],
],
[
'name' => 'BundleName',
'in' => 'query',
'schema' => ['description' => '新的云电脑模板名称。', 'type' => 'string', 'required' => false, 'example' => 'newName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '新的云电脑模板描述。', 'type' => 'string', 'required' => false, 'example' => 'newDescription'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '操作系统语言。目前只支持系统镜像。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en-US' => '英文', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日文'],
'example' => 'zh-CN',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改自定义云电脑模板',
'summary' => '修改自定义云电脑模板。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-23T10:38:59.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-05T06:32:15.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBundle'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n4636DBE0-BBB4-4076-8B8E-94D21A9A****\\r\\n","errorExample":""}]',
],
'ModifyCdsFile' => [
'summary' => '修改网盘文件或文件夹的属性,例如文件名。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'example' => 'user01'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-643267****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****'],
],
[
'name' => 'FileName',
'in' => 'query',
'schema' => ['description' => '文件名。', 'type' => 'string', 'required' => true, 'example' => 'NewFileName.txt'."\n", 'maxLength' => 1024, 'minLength' => 1],
],
[
'name' => 'ConflictPolicy',
'in' => 'query',
'schema' => [
'description' => '出现同名文件时的处理策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['refuse' => '当云端存在同名文件时,拒绝创建新文件,返回客户端已存在同名文件的详细信息', 'auto_rename' => '当发现同名文件时,自动重命名。默认为在原文件名末尾追加当前时间点,例如:xxx20240102_150405', 'ignore' => '允许文件同名', 'over_write' => '覆盖同名文件'],
'example' => 'ignore',
'default' => 'refuse',
'enum' => ['refuse', 'auto_rename', 'ignore'],
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Data' => [
'description' => '数据是否返回成功。',
'type' => 'string',
'enumValueTitles' => [' false' => '返回失败', 'true' => '返程成功'],
'example' => 'true',
],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', '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' => '修改网盘文件属性',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFile'],
],
],
'ramActions' => [],
],
'ModifyCdsFileShareLink' => [
'summary' => '修改文件分享的设置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai+cds-135515****'],
],
[
'name' => 'ShareId',
'in' => 'query',
'schema' => ['description' => '分享ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7JQX1Fs****'],
],
[
'name' => 'SharePwd',
'in' => 'query',
'schema' => ['description' => '提取码长度范围:0\\~64字节。不设置或者设置为空,表示无提取码,在获取分享令牌的时候也不用设置提取码参数。 要求使用ASCII可见字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12345678', 'maxLength' => 8, 'minLength' => 6],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '分享状态。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['disabled' => '已取消', 'enabled' => '有效'],
'example' => 'enabled',
'enum' => ['disabled', 'enabled'],
],
],
[
'name' => 'Expiration',
'in' => 'query',
'schema' => ['description' => '失效时间点。 RFC3339格式。 当取值为空时,表示永久有效。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2022-07-20T06:30:22.365Z'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '分享描述。 长度范围为0\\~1024个字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'testDescription', 'maxLength' => 1024, 'minLength' => 0],
],
[
'name' => 'ShareName',
'in' => 'query',
'schema' => ['description' => '分享名。 如果未设置,默认使用`file_id_list`中的第一个ID对应的文件名。 长度范围为0\\~128个字符。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'File sharing', 'maxLength' => 128, 'minLength' => 0],
],
[
'name' => 'DisablePreview',
'in' => 'query',
'schema' => [
'description' => '是否禁止预览分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '禁止', 'false' => '允许'],
'example' => 'false',
],
],
[
'name' => 'DisableSave',
'in' => 'query',
'schema' => [
'description' => '是否禁止转存分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [' false' => '允许', 'true' => '禁止'],
'example' => 'false',
],
],
[
'name' => 'DisableDownload',
'in' => 'query',
'schema' => [
'description' => '是否禁止下载分享中的文件。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [' false' => '允许', 'true' => '禁止'],
'example' => 'false',
],
],
[
'name' => 'PreviewLimit',
'in' => 'query',
'schema' => ['description' => '分享预览次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100'],
],
[
'name' => 'SaveLimit',
'in' => 'query',
'schema' => ['description' => '分享转存次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100'],
],
[
'name' => 'DownloadLimit',
'in' => 'query',
'schema' => ['description' => '分享下载次数限制。取值范围为整数,取值为0时表示不限制。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'PreviewCount',
'in' => 'query',
'schema' => ['description' => '预览次数。取值范围为整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'SaveCount',
'in' => 'query',
'schema' => ['description' => '转存次数。取值范围为整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'DownloadCount',
'in' => 'query',
'schema' => ['description' => '下载次数。取值范围为整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'ReportCount',
'in' => 'query',
'schema' => ['description' => '举报次数。取值范围为整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
[
'name' => 'VideoPreviewCount',
'in' => 'query',
'schema' => ['description' => '视频预览次数。取值范围为整数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'Data' => ['description' => '数据信息。', '$ref' => '#/components/schemas/CdsFileShareLinkModel'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'],
'Success' => [
'description' => '操作是否成功。',
'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\\": 100,\\n \\"DownloadCount\\": 100,\\n \\"Creator\\": \\"user01\\",\\n \\"SaveCount\\": 100,\\n \\"DisableSave\\": false,\\n \\"SharePwd\\": \\"12345678\\",\\n \\"DisablePreview\\": false,\\n \\"AccessCount\\": 10000,\\n \\"ShareId\\": \\"7JQX1Fs****\\",\\n \\"DownloadLimit\\": 100,\\n \\"Status\\": \\"disabled\\",\\n \\"DriveId\\": \\"dri-g0877jp3hu1ox****\\",\\n \\"ModifiyTime\\": \\"2021-09-04T04:30:36Z\\",\\n \\"DisableDownload\\": false,\\n \\"Expiration\\": \\"2020-06-28T11:33:00.000+08:00\\",\\n \\"Expired\\": true,\\n \\"PreviewCount\\": 0,\\n \\"PreviewLimit\\": 100,\\n \\"VideoPreviewCount\\": 0,\\n \\"ReportCount\\": 0,\\n \\"FileIds\\": \\"[\\\\\\\\\\\\\\"63886f1fe2014d9a5a3348768dcc27dfc57ee103\\\\\\\\\\\\\\"]\\",\\n \\"ShareName\\": \\"view.txt\\",\\n \\"CreateTime\\": \\"2021-09-04T03:30:36Z\\",\\n \\"ShareLink\\": \\"https://stg109960.apps.aliyunpds.com/disk/s/7uLJanz****\\"\\n },\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改文件分享',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFileShareLink'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ModifyCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyCenterPolicy' => [
'summary' => '修改一条无地域策略的配置。',
'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' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['cn-shanghai' => '华东2(上海)'],
'example' => 'cn-shanghai',
],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-53iyi2aar0nd6****'],
],
[
'name' => 'BusinessType',
'in' => 'query',
'schema' => [
'description' => '业务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => false,
'enumValueTitles' => [1 => '公共云', 8 => '商业版'],
'example' => '1',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'Clipboard',
'in' => 'query',
'schema' => [
'description' => '剪贴板权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地', 'readwrite' => '双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地', 'write' => '单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑', 'off' => '双向禁止。云电脑和本地之间无法进行复制操作 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'LocalDrive',
'in' => 'query',
'schema' => [
'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['read' => '只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件', 'readwrite' => '读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件', 'off' => '关闭。云电脑上没有本地磁盘的映射 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'UsbRedirect',
'in' => 'query',
'schema' => [
'description' => 'USB重定向。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'PrinterRedirect',
'in' => 'query',
'schema' => [
'description' => '打印机重定向策略。当DeviceRedirects中没有打印机重定向策略时生效。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向[默认值]', 'usbRedirect' => 'usb重定向', 'off' => '关闭'],
'example' => 'off',
],
],
[
'name' => 'VisualQuality',
'in' => 'query',
'schema' => [
'description' => '图像显示质量策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['high' => '高清', 'low' => '流畅', 'lossless' => '无损', 'medium' => '自适应 [默认值]'],
'example' => 'low',
],
],
[
'name' => 'GpuAcceleration',
'in' => 'query',
'schema' => [
'description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'Html5FileTransfer',
'in' => 'query',
'schema' => [
'description' => 'Web客户端文件传输策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'Watermark',
'in' => 'query',
'schema' => [
'description' => '水印。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['blind' => '开启盲水印', 'off' => '关闭水印 [默认值]', 'on' => '开启明水印'],
'example' => 'off',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [],
'example' => 'testPolicyGroupName',
],
],
[
'name' => 'WatermarkType',
'in' => 'query',
'schema' => [
'description' => '水印类型。最多可以选择3个类型,用半角逗号隔开。'."\n"
."\n"
.'> 若传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['EndUserId' => '用户名', 'Custom' => '自定义文本', 'DesktopIp' => '云电脑IP地址', 'ClientIp' => '客户端IP地址', 'HostName' => '云电脑ID的后15位', 'ClientTime' => '云电脑当前时间'],
'example' => 'EndUserId',
],
],
[
'name' => 'WatermarkCustomText',
'in' => 'query',
'schema' => ['description' => '若参数`WatermarkType`传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'WatermarkTransparencyValue',
'in' => 'query',
'schema' => ['description' => '水印不透明度,值越大,透明度越小。 取值范围: 10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkSecurity',
'in' => 'query',
'schema' => [
'description' => '盲水印安全优先规则。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'CameraRedirect',
'in' => 'query',
'schema' => [
'description' => '本地摄像头重定向。当DeviceRedirects中没有本地摄像头重定向策略时生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'off' => '关闭'],
'example' => 'on',
],
],
[
'name' => 'NetRedirect',
'in' => 'query',
'schema' => [
'description' => '是否开启网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['all' => '开启全局模式', 'off' => '关闭 [默认值]', 'on' => '开启白名单模式'],
'example' => 'on',
],
],
[
'name' => 'AppContentProtection',
'in' => 'query',
'schema' => [
'description' => '是否开启防截屏功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'RemoteCoordinate',
'in' => 'query',
'schema' => [
'description' => '远程协助键鼠控制权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['optionalControl' => '默认关闭(可以申请打开)', 'fullControl' => '完全控制', 'disableControl' => '不控制'],
'example' => 'fullControl',
],
],
[
'name' => 'InternetCommunicationProtocol',
'in' => 'query',
'schema' => [
'description' => '网络通信协议。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['tcp' => 'TCP模式适用于UDP/AST被限制场景', 'rtc' => 'AST模式适用于音视频高频使用场景', 'auto' => 'UTO模式将依据桌面内容,自动在AST和UDP模式间切换', 'both' => 'UDP模式适用于办公和高清图形设计场景'],
'example' => 'both',
],
],
[
'name' => 'VideoRedirect',
'in' => 'query',
'schema' => [
'description' => '多媒体重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'WatermarkColor',
'in' => 'query',
'schema' => ['description' => '水印字体颜色。 取值范围:0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'WatermarkDegree',
'in' => 'query',
'schema' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10'],
],
[
'name' => 'WatermarkFontSize',
'in' => 'query',
'schema' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkFontStyle',
'in' => 'query',
'schema' => [
'description' => '水印字体样式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['plain' => '普通', 'bold' => '加粗'],
'example' => 'plain',
],
],
[
'name' => 'WatermarkRowAmount',
'in' => 'query',
'schema' => ['description' => '水印行数。取值范围:3~10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'CpuProtectedMode',
'in' => 'query',
'schema' => [
'description' => 'CPU保护模式开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'CpuRateLimit',
'in' => 'query',
'schema' => ['description' => 'CPU整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
'name' => 'CpuSampleDuration',
'in' => 'query',
'schema' => ['description' => 'CPU整体采样时长,取值范围: 10\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'CpuSingleRateLimit',
'in' => 'query',
'schema' => ['description' => 'CPU单核使用率百分比,取值范围: 70\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
],
[
'name' => 'CpuDownGradeDuration',
'in' => 'query',
'schema' => ['description' => 'CPU降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
],
[
'name' => 'MemoryProtectedMode',
'in' => 'query',
'schema' => [
'description' => '内存保护模式开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MemoryRateLimit',
'in' => 'query',
'schema' => ['description' => '内存整体使用率百分比,取值范围: 70\\~90。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70'],
],
[
'name' => 'MemorySampleDuration',
'in' => 'query',
'schema' => ['description' => '内存整体采样时长,取值范围: 30\\~60。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'MemorySingleRateLimit',
'in' => 'query',
'schema' => ['description' => '单个进程内存使用率百分比,取值范围: 30\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'MemoryDownGradeDuration',
'in' => 'query',
'schema' => ['description' => '单个进程内存降频时长,取值范围: 30\\~120。单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '40'],
],
[
'name' => 'EndUserApplyAdminCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户请求管理员协助。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'EndUserGroupCoordinate',
'in' => 'query',
'schema' => [
'description' => '同一个办公网络下用户共享云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IP' => '指定IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
],
[
'name' => 'Recording',
'in' => 'query',
'schema' => [
'description' => '是否开启录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['period' => '间隔录屏', 'session' => '会话录屏', 'off' => '关闭', 'alltime' => '全程录屏'],
'example' => 'off',
],
],
[
'name' => 'RecordingAudio',
'in' => 'query',
'schema' => [
'description' => '录制云电脑声音选项。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '录制画面', 'on' => '录制系统及外设声音'],
'example' => 'on',
],
],
[
'name' => 'RecordingStartTime',
'in' => 'query',
'schema' => ['description' => '录屏开始时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:00:00'],
],
[
'name' => 'RecordingEndTime',
'in' => 'query',
'schema' => ['description' => '录屏结束时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:59:00'],
],
[
'name' => 'RecordingFps',
'in' => 'query',
'schema' => ['description' => '录屏帧率。单位:FPS(帧/秒)。', 'type' => 'string', 'required' => false, 'example' => '5'],
],
[
'name' => 'RecordingDuration',
'in' => 'query',
'schema' => ['description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。取值范围:10~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'RecordingExpires',
'in' => 'query',
'schema' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '15'],
],
[
'name' => 'RecordingUserNotify',
'in' => 'query',
'schema' => [
'description' => '提示终端客户已开启录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off'."\n",
],
],
[
'name' => 'RecordingUserNotifyMessage',
'in' => 'query',
'schema' => ['description' => '提示终端客户开启录屏的信息。', 'type' => 'string', 'required' => false, 'example' => 'Screen recording is enabled.'],
],
[
'name' => 'AdminAccess',
'in' => 'query',
'schema' => [
'description' => '用户登录云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '强制允许', 'deny' => '强制拒绝', 'inherited' => '继承用户维度的管理员权限控制'],
'example' => 'deny',
],
],
[
'name' => 'EnableSessionRateLimiting',
'in' => 'query',
'schema' => [
'description' => '会话带宽限速。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'SessionMaxRateKbps',
'in' => 'query',
'schema' => ['description' => '会话带宽限速最大值。单位:Kbps。取值范围:2000~100000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'DisplayMode',
'in' => 'query',
'schema' => [
'description' => '显示模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['clientCustom' => '用户自主配置', 'adminOffice' => '日常办公场景', 'adminDesign' => '设计及3D应用', 'adminCustom' => '自定义'],
'example' => 'clientCustom',
],
],
[
'name' => 'StreamingMode',
'in' => 'query',
'schema' => [
'description' => '流模式适配场景。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['intelligent' => '智能模式', 'smooth' => '流畅优先'],
'example' => 'smooth',
],
],
[
'name' => 'ColorEnhancement',
'in' => 'query',
'schema' => [
'description' => '设计及3D应用场景选择是否开启色彩增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'SmoothEnhancement',
'in' => 'query',
'schema' => [
'description' => '日常办公场景选择,是否开启平滑度增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'QualityEnhancement',
'in' => 'query',
'schema' => [
'description' => '设计及3D应用场景选择是否开启画质增强。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'VideoEncPolicy',
'in' => 'query',
'schema' => [
'description' => '视频编码策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['qualityFirst' => '质量优先', 'bandwidthFirst' => '带宽优先'],
'example' => 'qualityFirst',
],
],
[
'name' => 'TargetFps',
'in' => 'query',
'schema' => ['description' => '目标帧率,取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncMinQP',
'in' => 'query',
'schema' => ['description' => '视频编码最小QP,最高质量。取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncMaxQP',
'in' => 'query',
'schema' => ['description' => '视频编码最大QP,画面最低质量,取值范围:0\\~51。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'VideoEncAvgKbps',
'in' => 'query',
'schema' => ['description' => '视频编码平均码率。单位:Kbps。取值范围:1000\\~50000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'VideoEncPeakKbps',
'in' => 'query',
'schema' => ['description' => '视频编码峰值码率。单位:Kbps。取值范围:1000~50000。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2000'],
],
[
'name' => 'MaxReconnectTime',
'in' => 'query',
'schema' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'WyAssistant',
'in' => 'query',
'schema' => [
'description' => '通过桌面端(包括Windows客户端和macOS客户端)连接云电脑时,是否在云电脑悬浮球内提供无影AI助手功能入口。'."\n"
."\n"
.'> 仅适用于V7.7或更高版本的桌面端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '打开'],
'example' => 'on',
],
],
[
'name' => 'WatermarkAntiCam',
'in' => 'query',
'schema' => [
'description' => '盲水印防拍照功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '打开'],
'example' => 'off',
],
],
[
'name' => 'WatermarkPower',
'in' => 'query',
'schema' => [
'description' => '盲水印增强功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['high' => '高', 'low' => '低', 'medium' => '中'],
'example' => 'medium',
],
],
[
'name' => 'CpuProcessors',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'required' => false, 'example' => 'chrome.exe'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'MemoryProcessors',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '进程名。',
'type' => 'array',
'items' => ['description' => '进程名。', 'type' => 'string', 'required' => false, 'example' => 'notepad.exe'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'DomainResolveRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名解析策略。',
'type' => 'array',
'items' => [
'description' => '域名解析策略。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'],
'Policy' => [
'description' => '解析策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'required' => false, 'example' => 'Policy description.'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'NetRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'array',
'items' => [
'description' => '网络重定向策略详情。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。'."\n"
.'>',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'."\n"],
'RuleType' => [
'description' => '规则类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['prc' => '进程', 'domain' => '域名'],
'example' => 'domain',
],
'Policy' => ['description' => '重定向策略。', 'type' => 'string', 'required' => false, 'example' => 'Allow'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ScopeValue',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '`Scope`取值为`IP`的时候填写。当`Scope`为`IP`时生效,否则不生效。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block范围。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24'],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '登录方式管控规则列表。用于控制可通过哪些客户端访问云电脑。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不允许', 'on' => '允许'],
'example' => 'off',
],
'ClientType' => [
'description' => '登录方式管控,设置客户端类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'ios' => 'iOS客户端', 'windows' => 'Windows客户端', 'macos' => 'macOS客户端'],
'example' => 'android',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'UsbSupplyRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '04**'],
'UsbRuleType' => [
'description' => 'USB重定向规则类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [1 => '设备厂商'],
'example' => '1',
],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'required' => false, 'example' => 'Test rule'],
'UsbRedirectType' => [
'description' => 'USB重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [1 => '允许', '拒绝'],
'example' => '1',
],
'ProductId' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '08**'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthorizeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '新增安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则列表。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'inflow',
],
'Policy' => [
'description' => '安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求 [默认值]'],
'example' => 'accept',
],
'PortRange' => ['description' => '安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:端口为-1/-1。'."\n"
.'- GRE协议:端口为-1/-1。'."\n"
.'- IpProtocol取值为all:端口为-1/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => 'TCP协议', 'UDP' => 'UDP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'TCP',
],
'Priority' => ['description' => '安全组管控规则的优先级。数字越小,代表优先级越高。取值范围:1\\~60。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'RevokeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待删除安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '待删除安全组管控规则列表。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '待删除安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'outflow',
],
'Policy' => [
'description' => '待删除安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求 [默认值]'],
'example' => 'accept',
],
'PortRange' => ['description' => '待删除安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:端口为-1/-1。'."\n"
.'- GRE协议:端口为-1/-1。'."\n"
.'- IpProtocol取值为all:端口为-1/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '待删除安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '待删除安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => 'TCP协议', 'UDP' => 'UDP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'TCP',
],
'Priority' => ['description' => '待删除安全组管控规则的优先级。数字越小,代表优先级越高。取值范围:1\\~60。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '待删除安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'AuthorizeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '新增客户端IP白名单列表。',
'type' => 'array',
'items' => [
'description' => '客户端IP白名单列表。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'RevokeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待删除客户端IP白名单列表。',
'type' => 'array',
'items' => [
'description' => '待删除客户端IP白名单列表。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '待删除客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'CidrIp' => ['description' => '待删除客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 400,
],
],
[
'name' => 'DeviceRedirects',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备重定向规则列表。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则列表。',
'type' => 'object',
'properties' => [
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭'],
'example' => 'deviceRedirect',
],
'DeviceType' => [
'description' => '外设类型。',
'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' => '自定义外设规则列表。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则列表。',
'type' => 'object',
'properties' => [
'DeviceName' => ['description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'sandisk'],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '禁止'],
'example' => 'usbRedirect',
],
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['usbKey' => 'UKey', 'other' => '其他', 'graphicsTablet' => '手绘板', 'cardReader' => '读卡器', 'printer' => '打印机', 'scanner' => '扫描仪', 'storage' => '存储设备', 'camera' => '摄像头', 'networkInterfaceCard' => '网卡设备'],
'example' => 'storage',
],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'required' => false, 'example' => '2:0'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '0x55b1'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '0x0781'],
'Platforms' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'WatermarkColumnAmount',
'in' => 'query',
'schema' => ['description' => '水印列数。取值范围:3~10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'DomainResolveRuleType',
'in' => 'query',
'schema' => [
'description' => '域名解析策略类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'ClipboardScope',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['global', 'grained'],
'description' => '',
],
],
[
'name' => 'ClipboardGraineds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GrainedType' => [
'type' => 'string',
'required' => false,
'enum' => ['text', 'richtext', 'file', 'picture'],
'description' => '',
],
'ClipboardType' => [
'type' => 'string',
'required' => false,
'enum' => ['read', 'write', 'off', 'readwrite'],
'description' => '',
],
'ClipboardSize' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'ClipboardSizeUnit' => ['type' => 'string', 'required' => false, 'description' => ''],
'InClipboardSize' => ['type' => 'integer', 'format' => 'int32'],
'InClipboardSizeUnit' => ['type' => 'string'],
'OutClipboardSize' => ['type' => 'integer', 'format' => 'int32'],
'OutClipboardSizeUnit' => ['type' => 'string'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 4,
'description' => '',
],
],
[
'name' => 'StatusMonitor',
'in' => 'query',
'schema' => [
'description' => '是否在云电脑悬浮球内提供状态监控功能入口。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MobileRestart',
'in' => 'query',
'schema' => [
'description' => '通过移动端(Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供重启按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'MobileShutdown',
'in' => 'query',
'schema' => [
'description' => '通过移动端(Android客户端和iOS客户端)连接云电脑时,是否在云电脑悬浮球内提供关机按钮。'."\n"
."\n"
.'> 仅适用于V7.4或更高版本的移动端。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'ResolutionModel',
'in' => 'query',
'schema' => [
'description' => '分辨率类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['adaptive' => '自适应分辨率', 'customer' => '固定分辨率'],
'example' => 'adaptive',
],
],
[
'name' => 'ResolutionWidth',
'in' => 'query',
'schema' => ['description' => '分辨率的宽度。单位:像素。云应用取值范围:500~50000, 云电脑取值范围:480~4096。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '720'],
],
[
'name' => 'ResolutionHeight',
'in' => 'query',
'schema' => ['description' => '分辨率的高度。单位:像素。云应用取值范围:500~50000, 云电脑取值范围:480~4096。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1280'],
],
[
'name' => 'Taskbar',
'in' => 'query',
'schema' => [
'description' => '应用任务栏。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'NoOperationDisconnect',
'in' => 'query',
'schema' => [
'description' => '无操作断连。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'NoOperationDisconnectTime',
'in' => 'query',
'schema' => ['description' => '无操作断连时长。取值范围:120-7200。单位:秒。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'DisconnectKeepSession',
'in' => 'query',
'schema' => [
'description' => '会话断连保留。'."\n"
.'> 仅适用于云应用策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['customTime' => '固定时间', 'persistent' => '不断连'],
'example' => 'customTime',
],
],
[
'name' => 'DisconnectKeepSessionTime',
'in' => 'query',
'schema' => ['description' => '会话断连保留时长。取值范围:30~7200。单位:秒。'."\n"
.'> 仅适用于云应用策略。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'RecordEvents',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏事件列表。',
'type' => 'array',
'items' => [
'description' => '录屏事件列表。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['transferWithLocal' => '剪切板及文件传输操作', 'userInput' => '用户输入', 'usbRedirect' => 'USB外设插拔'],
'example' => 'transferWithLocal',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RecordEventFilePaths',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏审计中的文件监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的文件监控绝对路径。', 'type' => 'string', 'required' => false, 'example' => 'C://test.txt'],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'RecordEventRegisters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '录屏审计中的注册表监控绝对路径。',
'type' => 'array',
'items' => ['description' => '录屏审计中的注册表监控绝对路径。', 'type' => 'string', 'required' => false, 'example' => '计算机\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR'],
'required' => false,
'maxItems' => 10,
'example' => 'Computer\\HKEY_LOCAL_MACHINE\\SYSTEM\\CurrentControlSet\\Services\\USBSTOR',
],
],
[
'name' => 'RecordEventDuration',
'in' => 'query',
'schema' => ['description' => '录屏审计中检测到事件发生后录屏的时长。单位:分钟。取值范围:10\\~60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'ResetDesktop',
'in' => 'query',
'schema' => [
'description' => '重置云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'DeviceConnectHint',
'in' => 'query',
'schema' => [
'description' => '外设连接提示控制。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'FileMigrate',
'in' => 'query',
'schema' => [
'description' => '文件迁移。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'WuyingKeeper',
'in' => 'query',
'schema' => [
'description' => '无影管家开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'InternetPrinter',
'in' => 'query',
'schema' => ['description' => '移动端无影管家开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'SafeMenu',
'in' => 'query',
'schema' => ['description' => '移动端Windows系统的安全按钮开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'ScreenDisplayMode',
'in' => 'query',
'schema' => ['description' => '移动端小颖开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'ClientControlMenu',
'in' => 'query',
'schema' => ['description' => '录屏事件的等级', 'type' => 'string', 'required' => false],
],
[
'name' => 'FileTransferSpeedLocation',
'in' => 'query',
'schema' => ['description' => '录屏事件后缀', 'type' => 'string', 'required' => false],
],
[
'name' => 'FileTransferSpeed',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'FileTransferAddress',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'CpdDriveClipboard',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'UseTime',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AutoReconnect',
'in' => 'query',
'schema' => ['title' => '断连后自动重连', 'description' => '断连后自动重连', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileWuyingKeeper',
'in' => 'query',
'schema' => ['title' => '移动端无影管家开关', 'description' => '移动端无影管家开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileSafeMenu',
'in' => 'query',
'schema' => ['title' => '移动端Windows系统的安全按钮开关', 'description' => '移动端Windows系统的安全按钮开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'MobileWyAssistant',
'in' => 'query',
'schema' => ['title' => '移动端小颖开关', 'description' => '移动端小颖开关', 'type' => 'string', 'required' => false, 'example' => 'off'],
],
[
'name' => 'RecordEventLevels',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '录屏事件的等级',
'description' => '录屏事件的等级',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EventType' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'required' => false, 'example' => 'StartApplication'],
'EventLevel' => ['title' => '事件等级', 'description' => '事件等级', 'type' => 'string', 'required' => false, 'example' => 'HIGH'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'RecordEventFileExts',
'in' => 'query',
'style' => 'flat',
'schema' => [
'title' => '录屏事件后缀',
'description' => '录屏事件后缀',
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'example' => 'txt', 'description' => ''],
'required' => false,
'maxItems' => 6,
],
],
[
'name' => 'ExternalDrive',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'WatermarkShadow',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientCreateSnapshot',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'AcademicProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ModelLibrary',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'PortProxy',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'BusinessChannel',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'MemoryOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'CpuOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'DiskOverload',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'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'],
],
[
'name' => 'AdminKeyboardOnWindows',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'AdminKeyboardOnFullScreen',
'in' => 'query',
'schema' => ['type' => 'string'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '响应结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5CED7F18-43B1-5035-BBB6-2538B***'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CED7F18-43B1-5035-BBB6-2538B***\\"\\n}","type":"json"}]',
'title' => '修改无地域策略',
'changeSet' => [
['createdAt' => '2025-12-10T02:25:36.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-12-08T03:20:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-11-24T08:35:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-10-27T02:26:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-23T13:39:02.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-09-15T03:51:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-06-25T08:48:29.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyCloudDriveGroups' => [
'summary' => '修改团队共享盘的基本属性,例如共享盘的状态、存储峰值等。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+cds-135515****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '团队共享盘的状态。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['disabled' => '禁用', 'enabled' => '启用 [默认值]'],
'example' => 'disabled',
],
],
[
'name' => 'TotalSize',
'in' => 'query',
'schema' => ['description' => '团队共享盘的存储峰值。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1073741824'],
],
[
'name' => 'GroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '团队空间ID列表。',
'type' => 'array',
'items' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-i1ruuudp92qpj****'],
'required' => false,
'docRequired' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Data' => ['description' => '数据信息。', 'type' => 'string', 'example' => '[]'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
],
'description' => '',
],
],
],
'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' => '修改团队共享盘属性',
'changeSet' => [
['createdAt' => '2023-03-31T10:37:36.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveGroups'],
],
],
'ramActions' => [],
],
'ModifyCloudDrivePermission' => [
'summary' => '企业网盘的默认策略是所有用户均可从本地设备上传文件至企业网盘,但不可从企业网盘下载文件至本地设备。调用本接口可添加具备例外权限的用户。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '已创建的企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-60911*****'],
],
[
'name' => 'DownloadEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '仅具备下载权限的终端用户ID列表。这些用户仅可从企业网盘下载文件至本地设备,不可从本地设备上传文件至企业网盘。',
'type' => 'array',
'items' => ['description' => '仅具备下载权限的终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DownloadUploadEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '具备上传和下载权限的终端用户ID列表。这些用户既可以从企业网盘下载文件至本地设备,也可以从本地设备上传文件至企业网盘。',
'type' => 'array',
'items' => ['description' => '具备上传和下载权限的终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'tom'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'NoDownloadNoUploadEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '不可上传也不可下载的终端用户ID列表。这些用户既无法从企业网盘下载文件至本地设备,也不能从本地设备上传文件至企业网盘。',
'type' => 'array',
'items' => ['description' => '不可上传也不可下载的终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'leon'],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', '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' => '修改用户在企业网盘与本地设备之间的文件传输权限',
'description' => '在云电脑内访问网盘时,由于二者都处于安全的环境,它们之间的文件上传、下载始终都是被允许的。但如果已开启网盘在无影终端上的可见性,终端用户可以通过无影终端界面直接访问网盘。'."\n"
."\n"
.'为防止终端用户将云电脑内的敏感数据通过网盘传输至本地设备,默认策略允许用户从本地设置上传文件至企业网盘,禁止从企业网盘下载文件至本地设备,且该默认策略对该网盘的所有用户生效,您无需设置该策略的生效范围。'."\n"
."\n"
.'如有需要,您可以调用本接口来控制用户在网盘与本地设备之间的文件传输权限,这里添加的用户将不受默认策略控制。',
'changeSet' => [
['createdAt' => '2024-11-04T09:17:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-17T01:59:29.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDrivePermission'],
],
],
'ramActions' => [],
],
'ModifyCloudDriveUsers' => [
'summary' => '修改用户个人盘的基本属性,例如个人盘的状态、存储峰值等。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-596198****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '用户个人盘的状态。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['disabled' => '已禁用', 'enabled' => '已启用'],
'example' => 'enabled',
],
],
[
'name' => 'UserMaxSize',
'in' => 'query',
'schema' => ['description' => '用户个人盘的存储峰值。该值不可大于企业网盘中可分配的剩余容量。单位:Byte(字节)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1024'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '终端用户ID列表。',
'type' => 'array',
'items' => ['description' => '终端用户ID。', 'type' => 'string', 'required' => false, 'example' => 'abc'],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D2E005C4-8CA3-5F1D-9917-E75BE3BF****'],
],
],
],
],
'title' => '修改用户个人盘属性',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveUsers'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2E005C4-8CA3-5F1D-9917-E75BE3BF****\\"\\n}","type":"json"}]',
],
'ModifyConfigGroup' => [
'summary' => '修改配置组的基本信息,包括名称和描述。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '配置组ID。', 'type' => 'string', 'required' => true, 'example' => 'cg-i1ruuudp92qpj****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '配置组名称。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '配置组描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task', 'maxLength' => 500],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'GroupId' => ['description' => '配置组ID。', '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' => '修改配置组基本信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:ModifyConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyCustomizedListHeaders' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', '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' => 'Headers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '表头列表。',
'type' => 'array',
'items' => [
'description' => '表头。',
'type' => 'object',
'properties' => [
'HeaderKey' => [
'description' => '表头键值。'."\n"
."\n"
.'>所有的HeaderKey都必须传入。>',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'desktop_id_name' => '云电脑ID/云电脑名称', 'system_data_disk' => '系统盘/数据盘', 'office_site_type' => '办公网络类型', 'create_time' => '创建时间', 'ip' => 'IP', 'spec_system_protocol' => '规格/系统/协议', 'monitor' => '监控', 'assigned_users' => '当前分配用户数', 'encryption' => '是否加密', 'office_site_id_name' => '办公网络ID/办公网络名称',
'pay_type' => '付费类型', 'tag' => '标签', 'host_name' => '主机名', 'status' => '状态', 'current_user' => '当前使用用户',
],
'example' => 'pay_type',
],
'DisplayType' => [
'description' => '表头的显示类型。'."\n"
."\n"
.'>`desktop_id_name`和`office_site_id_name`的值必须设为`required`,其他HeaderKey的值可按需设为`display`或`hide`。>',
'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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改云电脑列表页表头的显示类型',
'summary' => '修改云电脑列表页表头的显示类型(包括必选、显示和隐藏)。',
'changeSet' => [
['createdAt' => '2022-09-09T06:33:35.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCustomizedListHeaders'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyDesktopChargeType' => [
'summary' => '将云电脑的付费类型转为包年包月或按量付费。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'description' => '要转换的目标计费方式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PostPaid' => '由包年包月转换为按量付费', 'PrePaid' => '由按量付费转换为包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '转换成包年包月计费方式时,云电脑的购买时长。单位由`PeriodUnit`指定。当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。'."\n"
."\n"
.'- 如果`PeriodUnit`为`Week`,该参数的取值范围为1。'."\n"
.'- 如果`PeriodUnit`为`Month`,该参数的取值范围为1、2、3、6。'."\n"
.'- 如果`PeriodUnit`为`Year`,该参数的取值范围为1、2、3、4、5。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '转换成包年包月计费方式时,包年包月计费的时长单位。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年', 'Week' => '周'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '转换成包年包月计费方式时,是否自动支付订单费用。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单。 [默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。'],
'example' => 'false',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。可设置1~20个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => '["ecd-gx2x1dhsmucyy****"]'],
'required' => true,
'example' => 'ecd-gx2x1dhsmucyy****',
'maxItems' => 100,
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003836003****'],
],
[
'name' => 'UseDuration',
'in' => 'query',
'schema' => ['description' => '> 处于定向邀测中,暂不对外开放。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'sample'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '123456789'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'DesktopId' => [
'description' => '云电脑ID列表。如果一次调用创建了多个云电脑,将返回多个云电脑ID。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => '["ecd-gx2x1dhsmucyy****"]'],
],
'TaskId' => ['type' => 'string', 'description' => ''],
],
],
],
],
'title' => '修改云电脑付费类型',
'description' => '- 调用该接口前,请确保您已充分了解云电脑的计费方式。更多信息,请参见[计费概述](~~188395~~)。'."\n"
.'- 调用该接口时,请确保目标云电脑的状态为运行中或者已关机,且当前没有产生欠费。'."\n"
.'- 订单支付完成后系统将开始转换云电脑的计费方式,转换期间云电脑处于变配状态,此时,云电脑不支持进行其他操作,例如开机、关机、变更配置等。'."\n"
."\n"
.'由包年包月转换为按量付费时,存在退款额度限制,请参见[包年包月转为按量付费](~~439964~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-07-22T12:10:24.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-07-19T09:17:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-09-27T02:07:11.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2021-09-27T02:07:11.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopChargeType'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopChargeType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"DesktopId\\": [\\n \\"[\\\\\\"ecd-gx2x1dhsmucyy****\\\\\\"]\\"\\n ],\\n \\"TaskId\\": \\"\\"\\n}","type":"json"}]',
],
'ModifyDesktopGroup' => [
'summary' => '修改共享型云电脑。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'OwnBundleId',
'in' => 'query',
'schema' => ['description' => '云电脑模板ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'b-7t275tpgjueeu****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'pg-53iyi2aar0nd6****'],
],
[
'name' => 'DesktopGroupName',
'in' => 'query',
'schema' => ['description' => '共享型云电脑名称。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'desktopGroupName1'],
],
[
'name' => 'ScaleStrategyId',
'in' => 'query',
'schema' => ['description' => '伸缩策略组ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 's-kakowkdl****'],
],
[
'name' => 'KeepDuration',
'in' => 'query',
'schema' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '180000'],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'comment'],
],
[
'name' => 'MinDesktopsCount',
'in' => 'query',
'schema' => ['description' => '包年包月共享型云电脑内自动创建云电脑的上限。即当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。默认值为1,取值范围为0~`MaxDesktopsCount`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'MaxDesktopsCount',
'in' => 'query',
'schema' => ['description' => '按量付费共享型云电脑内能容纳的云电脑最大数量。取值范围:0~500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '10'],
],
[
'name' => 'AllowAutoSetup',
'in' => 'query',
'schema' => [
'description' => '是否允许包年包月共享型云电脑自动创建云电脑。即当参数`ChargeType`取值为`PrePaid`时才生效,且为必选值。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '1',
'minimum' => '0',
'enumValueTitles' => ['不允许', '允许'],
'example' => '1',
],
],
[
'name' => 'AllowBufferCount',
'in' => 'query',
'schema' => ['description' => '按量付费共享型云电脑内允许预留的云电脑数量。当参数`ChargeType`取值为`PostPaid`时才生效,且为必选值。取值范围: '."\n"
.'- 0:不预留'."\n"
.'- N:预留N台(1≤N≤100)'."\n"
."\n"
.'> 如果不预留可用云电脑,当终端用户发起连接请求时,系统需要先创建并启动云电脑,然后分配给用户,所需时间相对较长。建议您根据需要预留一定数量的云电脑,保证终端用户的使用体验。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '0', 'example' => '1'],
],
[
'name' => 'ResetType',
'in' => 'query',
'schema' => [
'description' => '云电脑重置类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['不重置', '只重置系统盘', '只重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '0',
],
],
[
'name' => 'LoadPolicy',
'in' => 'query',
'schema' => [
'description' => '多会话多台共享型云电脑的负载均衡策略。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '0',
],
],
[
'name' => 'BindAmount',
'in' => 'query',
'schema' => ['description' => '多会话多台共享型云电脑中每台云电脑允许的并发会话数。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'desktopimage-windows-server-2016-64-ch'],
],
[
'name' => 'Classify',
'in' => 'query',
'schema' => [
'description' => '共享型云电脑的类型。'."\n"
."\n"
.'> 该参数暂未开放使用。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['teacher' => '教师共享型云电脑', 'student' => '学生共享型云电脑'],
'example' => 'teacher',
],
],
[
'name' => 'RatioThreshold',
'in' => 'query',
'schema' => ['description' => '会话占用率阈值,用作多会话多台共享型云电脑的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.85'],
],
[
'name' => 'ConnectDuration',
'in' => 'query',
'schema' => ['description' => '会话处于连接状态的最大时长。会话连接时长达到此值时将自动断开连接。单位:毫秒。取值范围:900000(15分钟)~345600000(4天)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '900000'],
],
[
'name' => 'IdleDisconnectDuration',
'in' => 'query',
'schema' => ['description' => '用户会话建立连接后,如果在该最大时长内,始终没有任何键盘或鼠标操作,则该会话断开连接。单位:毫秒。取值范围为360000(6分钟)~3600000(60分钟)。'."\n"
."\n"
.'在达到该时长的30秒前,会话中的终端用户将收到保存文档数据的提示消息,此时终端用户需及时保存文档数据,避免丢失。'."\n"
."\n"
.'> 仅适用于镜像版本号不低于1.0.2的云电脑。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '360000'],
],
[
'name' => 'DisableSessionConfig',
'in' => 'query',
'schema' => ['description' => '是否禁用会话管理。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'StopDuration',
'in' => 'query',
'schema' => ['description' => '空闲关机时间。当云电脑空闲时长达到该值时,自动关机。关机后如果有用户连接,会自动开机。单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300000'],
],
[
'name' => 'ProfileFollowSwitch',
'in' => 'query',
'schema' => ['description' => '是否开启用户数据漫游。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'schema' => ['description' => '用户数据漫游功能使用的NAS文件系统ID。'."\n"
."\n"
.'> 该参数暂未开放使用。', 'type' => 'string', 'required' => false, 'example' => '04f314****'],
],
[
'name' => 'PolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '策略组ID列表。',
'type' => 'array',
'items' => ['description' => '策略组ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'BuyDesktopsCount',
'in' => 'query',
'schema' => ['description' => '- 对于包年包月共享型云电脑:购买云电脑数量。取值范围:0~200。'."\n"
.'- 对于按量付费共享型云电脑:池内云电脑最小创建数量。默认值为1,取值范围为0~`MaxDesktopsCount`。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
'name' => 'DeleteDuration',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改共享型云电脑',
'description' => '创建共享型云电脑后,系统将根据设置的共享型云电脑伸缩策略以及终端用户连接云电脑的情况,在共享型云电脑中自动创建对应数量的云电脑,这些云电脑将统一使用同一云电脑模板和安全策略。在不同场景下,您可以根据需要修改共享型云电脑配置,包括共享型云电脑名称、云电脑模板、关联的策略等。',
'changeSet' => [
['createdAt' => '2025-07-11T07:40:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-05T12:56:01.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-19T03:28:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-11T07:29:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-11T02:32:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-12T07:02:59.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2021-11-04T10:02:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\n","errorExample":""}]',
],
'ModifyDesktopHostName' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NewHostName',
'in' => 'query',
'schema' => ['description' => '修改后的云电脑主机名称。主机名称的命名规则如下:'."\n"
."\n"
.'- 长度为2\\~15个字符。'."\n"
.'- 支持大小写字母、数字或者短划线(-)。不能以短划线开头或者结尾,不能连续使用短划线,不能只使用数字。', 'type' => 'string', 'required' => true, 'example' => 'NewName'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改AD办公网络下Windows云电脑的主机名称',
'summary' => '修改AD办公网络下的Windows云电脑的主机名称。',
'description' => '仅支持修改AD办公网络下的Windows云电脑主机名称。修改主机名称后,云电脑将进行重建。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopHostName'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopHostName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyDesktopName' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NewDesktopName',
'in' => 'query',
'schema' => ['description' => '修改后的云电脑名称。格式要求如下:'."\n"
."\n"
.'- 不超过64个字符。'."\n"
.'- 必须以大小字母或中文开头,不能以`http://`和`https://`开头。'."\n"
.'- 可以包含中文、英文、数字、半角冒号(:)、下划线(_)、点号(.)或者短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'DemoComputer01'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy**** '],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 500,
],
],
[
'name' => 'UserAssignMode',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改云电脑名称',
'summary' => '将指定云电脑的名称修改为新名称。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopName'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\r\\n","errorExample":""}]',
],
'ModifyDesktopSpec' => [
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ecd-4543qyik164a4****'],
],
[
'name' => 'DesktopType',
'in' => 'query',
'schema' => ['description' => '目标规格。您可以调用[DescribeDesktopTypes](~~DescribeDesktopTypes~~)查询云电脑支持的规格。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'eds.general.2c4g'],
],
[
'name' => 'RootDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '目标系统盘容量,单位为GiB。取值范围:80\\~500 GiB,且必须为10的倍数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '32768', 'minimum' => '0', 'example' => '80'],
],
[
'name' => 'UserDiskSizeGib',
'in' => 'query',
'schema' => ['description' => '目标数据盘容量,单位为GiB。'."\n"
."\n"
.'- 对于非图形型规格,取值范围为20\\~1020 GiB,且必须为10的倍数。'."\n"
.'- 对于图形型规格,取值范围为40\\~1020 GiB,且必须为10的倍数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '65536', 'minimum' => '0', 'example' => '40'],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账号余额充足,否则会产生异常订单 [默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付'],
'example' => 'false',
],
],
[
'name' => 'UserDiskPerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '数据盘性能等级。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0 [默认值]', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL0',
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003308011****'],
],
[
'name' => 'ResourceSpecs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源规格模板列表。',
'type' => 'array',
'items' => [
'description' => '资源规格模板。',
'type' => 'object',
'properties' => [
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-4543qyik164a4****'],
'RootDiskSizeGib' => ['description' => '目标系统盘容量,单位为GiB。取值范围:80\\~500 GiB,且必须为10的倍数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '80'],
'UserDiskSizeGib' => ['description' => '目标数据盘容量,单位为GiB。取值范围:20\\~2040 GiB,且必须为10的倍数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。'."\n"
."\n"
.'> 非按月购买云电脑可不填。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['DesktopMonthPackage' => '按月购买云电脑'],
'example' => 'DesktopMonthPackage',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '123456789'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'OrderIds' => [
'description' => '订单ID列表。',
'type' => 'array',
'items' => ['description' => '订单ID信息。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789'],
],
],
],
],
],
'title' => '变更云电脑配置',
'summary' => '变更云电脑的规格和扩容磁盘。',
'description' => '变更云电脑配置包括修改规格和扩容磁盘。'."\n"
."\n"
.'- 变更前,请先了解云电脑支持哪些规格和磁盘大小。详细信息,请参见[云电脑规格](~~188609~~)。您可以调用[DescribeDesktopTypes](~~DescribeDesktopTypes~~)查询云电脑支持的规格。'."\n"
.'- 变更时,您至少要更改云电脑规格、系统盘大小和数据盘大小中的一项配置,即至少要传入`DesktopType`、`RootDiskSizeGib`和`UserDiskSizeGib`中的一个参数。相关注意事项如下:'."\n"
."\n"
.' - 云电脑规格包含vCPU、内存和GPU的配置,仅支持从一个规格变更到另一个规格,不能单独修改其中一个配置。'."\n"
.' - 变更规格时,通用办公型规格和非通用办公型规格之间不支持互相变更,图形型规格和非图形型规格之间不支持互相变更。'."\n"
.' - 系统盘和数据盘均支持扩容,但不支持缩容。'."\n"
.' - 如果云电脑的购买方式为按月购买,系统将根据变更前后的差异计算费用差价,您需要补差价或者接收差价退款。'."\n"
.' - 对于同一台云电脑,建议将两次操作变更配置的间隔保持在5分钟以上。'."\n"
.' - 云电脑的状态必须为已关机(Stopped)。'."\n"
.'- 变更后,不会影响云电脑上存储的个人数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-12-02T07:40:47.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-17T13:19:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-12-12T02:43:55.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopSpec'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopSpec',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"123456789\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OrderIds\\": [\\n 123456789\\n ]\\n}","type":"json"}]',
],
'ModifyDesktopTimer' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-asuk39x45qnjp****'],
'required' => true,
'maxItems' => 101,
],
],
[
'name' => 'DesktopTimers',
'in' => 'query',
'allowEmptyValue' => true,
'style' => 'repeatList',
'schema' => [
'description' => '云电脑定时任务详情。',
'type' => 'array',
'items' => [
'description' => '云电脑定时任务。',
'type' => 'object',
'properties' => [
'TimerType' => [
'description' => '定时任务类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['NoOperationDisconnect' => '无操作断连', 'LogoutShutdown' => '退登关机', 'NoConnect' => '断连任务(需指定OperationType)', 'TimerBoot' => '定时开机', 'TimerReset' => '定时重置', 'LoginAutoConnect' => '登录自动连接', 'NoOperationShutdown' => '无操作关机', 'TimerShutdown' => '定时关机', 'NoOperationReboot' => '无操作重启', 'TimerReboot' => '定时重启'],
'example' => 'TimerBoot',
],
'CronExpression' => ['description' => '定时任务Cron表达式。'."\n"
."\n"
.'>需要传入UTC标准时间,即北京时间每天0点应该传入0 0 16 ? * 1,2,3,4,5,6,7>', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'],
'Interval' => ['description' => '时间间隔,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
'Enforce' => [
'description' => '是否强制执行。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '忽略云电脑及连接状态检测,强制执行定时任务。', 'false' => '不强制执行。'],
'example' => 'true',
],
'ResetType' => [
'description' => '云电脑重置类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '重置系统盘', 'RESET_TYPE_BOTH' => '重置数据和用户磁盘'],
'example' => 'RESET_TYPE_SYSTEM',
],
'AllowClientSetting' => ['description' => '是否允许终端用户自行配置定时任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'OperationType' => [
'description' => '定时任务操作类型,目前仅断连定时任务支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hibernate' => '休眠', 'Shutdown' => '关机'],
'example' => 'Shutdown',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'UseDesktopTimers',
'in' => 'query',
'schema' => ['description' => '是否使用`DesktopTimers`,**需要传入`true`**。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DesktopIds' => [
'description' => '设置成功的云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '云电脑ID列表。', 'type' => 'string', 'example' => '[\'ecd-c6u0eis7rnqfw****\']'],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4638719F-3CAB-5704-BD54-55617BFF****'],
],
'description' => '',
],
],
],
'title' => '创建或修改云电脑定时任务',
'summary' => '创建或修改云电脑定时任务,例如定时开机、关机、重启、重置等。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopTimer'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopTimer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DesktopIds\\": [\\n \\"[\'ecd-c6u0eis7rnqfw****\']\\"\\n ],\\n \\"RequestId\\": \\"4638719F-3CAB-5704-BD54-55617BFF****\\"\\n}","type":"json"}]',
],
'ModifyDesktopsPolicyGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '需要绑定的云电脑策略ID。'."\n"
."\n"
.'> 如果传入参数`PolicyGroupIds`,则此参数将被忽略。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置一个或者多个,格式为JSON数组。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
'required' => true,
'example' => 'ecd-ia2zw38bi6cm7****',
'maxItems' => 100,
],
],
[
'name' => 'PolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定的云电脑策略ID列表。'."\n"
."\n"
.'> 最多可以填写1条全局生效的云电脑策略和4条针对指定IP生效的云电脑策略。如果填写的全局生效的云电脑策略超过1条,则仅第1条生效。',
'type' => 'array',
'items' => ['description' => '需要绑定的云电脑策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
'required' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'ModifyResults' => [
'description' => '修改结果的集合。',
'type' => 'array',
'items' => [
'description' => '修改结果。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '修改结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-7w78ozhjcwa3u****'],
],
],
],
],
],
],
],
'title' => '为云电脑更换绑定的云电脑策略',
'summary' => '为云电脑更换绑定的云电脑策略。',
'description' => '云电脑的状态必须为运行中(Running)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-11-24T08:39:49.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2022-11-22T01:54:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:44.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopsPolicyGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"The specified param DesktopId ecd-ia2zw38bi6cm7**** is not found.\\",\\n \\"DesktopId\\": \\"ecd-7w78ozhjcwa3u****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n D3A17B8E-066B-421F-87DC-0B6451D89751\\n \\n ecd-7w78ozhjcwa3u****\\n success\\n \\n","errorExample":""}]',
],
'ModifyDiskSpec' => [
'summary' => '修改云电脑系统盘或数据盘的磁盘性能等级。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-2yjhqxo1monbf****'],
],
[
'name' => 'RootDiskPerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '系统盘的性能等级。当云电脑规格为企业图形型或者高主频时,支持设置磁盘性能等级。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL1',
],
],
[
'name' => 'UserDiskPerformanceLevel',
'in' => 'query',
'schema' => [
'description' => '数据盘的性能等级。当云电脑规格为企业图形型或者高主频时,支持设置磁盘性能等级。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PL1' => 'PL1', 'PL0' => 'PL0', 'PL3' => 'PL3', 'PL2' => 'PL2'],
'example' => 'PL1',
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID,可以通过询价接口获取命中的活动ID列表。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'youhuiquan_promotion_option_id_for_blank'],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。'."\n"
."\n"
.'- 若传入`true`,请确保账户余额充足,否则会产生异常订单。'."\n"
.'- 若传入`false`,您可以登录控制台,在**费用与成本**页面根据返回的订单号进行支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付 [默认值]', 'false' => '只产生订单但不支付'],
'example' => 'false',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。您可以在[费用与成本 > 我的订单](https://billing-cost.console.aliyun.com/order/list)中获取。'."\n"
.'[费用与成本 > 订单管理](https://usercenter2-intl.aliyun.com/order/list)中获取。', 'type' => 'string', 'example' => '219861020660568'],
'RequestId' => ['description' => '本次请求的ID。', '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' => '修改磁盘性能等级',
'description' => '创建云电脑时您可以通过创建自定义模板选择规格,其中企业图形型或高主频办公型默认采用ESSD云盘,支持设置磁盘容量和性能级别,您可以根据需要变更系统盘或数据盘的性能级别。'."\n"
."\n"
.'> 仅企业图形型和高主频办公型云电脑支持变更磁盘性能等级。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDiskSpec'],
],
],
'ramActions' => [],
],
'ModifyEntitlement' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ecd-7w78ozhjcwa3u****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户名列表。该列表中的用户将成为指定云电脑的授权用户,该云电脑此前已有的授权用户将被移除。可设置1~100个用户名。',
'type' => 'array',
'items' => ['description' => '用户名。'."\n"
."\n"
.'- 如果是便捷用户,则取值为便捷用户的用户名。'."\n"
.'- 如果是AD用户,则取值为AD用户的sAMAccountName。'."\n"
."\n"
.'>若不配置该参数,则表示移除指定云电脑当前所有的授权用户,使云电脑变为未被分配的状态。>', 'type' => 'string', 'required' => false, 'example' => 'ModifyEntitlement'],
'required' => false,
'example' => 'alice',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为云电脑重新选择授权用户',
'summary' => '将云电脑分配给指定用户,同时移除该云电脑此前已有的所有授权用户。',
'description' => '- 云电脑的状态必须为运行中(Running)。'."\n"
.'- 本接口立刻返回结果,如需查询分配是否成功,请调用[DescribeDesktops](~~436815~~),并根据其返回参数`ManagementFlags`判断是否分配完成:`ASSIGNING`表示正在分配中,其他表示分配完成。'."\n"
.'- 建议每2\\~5秒检查一次是否分配完成,最多累计检查50秒。一般情况下,1~5秒可完成分配。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyEntitlement'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8F851208-C0EA-4CDD-9074-DBE70CB430DA\\n","errorExample":""}]',
],
'ModifyImageAttribute' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-2g65ljy3ynrdq****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '镜像名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '镜像的描述信息。长度为2\\~256个英文或中文字符,不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改镜像属性',
'summary' => '修改镜像的属性,包括镜像的名称和描述。',
'description' => '仅支持修改状态为可用(Available)的自定义镜像。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageAttribute'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyImageAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\r\\n","errorExample":""}]',
],
'ModifyImagePermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '待共享的镜像ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'm-gx2x1dhsmusr2****'],
],
[
'name' => 'AddAccount',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '接受镜像共享的阿里云账号ID。可共享给1~50个阿里云账号。',
'type' => 'array',
'items' => ['description' => '接受镜像共享的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '118272523431****'],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'RemoveAccount',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '取消镜像共享的阿里云账号ID。可取消共享给1~50个阿里云账号。',
'type' => 'array',
'items' => ['description' => '取消镜像共享的阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '114984212876****'],
'required' => false,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '共享或取消共享镜像',
'summary' => '将镜像共享给无影的其他用户或者取消已经共享的镜像。',
'description' => '### 关于共享镜像的安全性'."\n"
."\n"
.'无影云电脑无法保证共享镜像的完整性和安全性,使用共享镜像时,需要用户自行确认镜像来自可信任的共享者或共享账号,且自行承担风险。'."\n"
."\n"
.'### 关于额度和计费'."\n"
."\n"
.'- 共享镜像不会占用被共享者的镜像额度。'."\n"
.'- 被共享者使用共享镜像创建云电脑后,不会向共享者收取费用。'."\n"
.'- 无影云电脑对共享镜像不进行额外计费。'."\n"
."\n"
.'### 支持的共享行为'."\n"
."\n"
.'- 用户共享自己的自定义镜像。'."\n"
.'- 中国站和国际站账号之间共享镜像。'."\n"
."\n"
.'### 不支持的共享行为'."\n"
."\n"
.'- 再次共享其他用户共享的镜像。'."\n"
.'- 共享加密镜像。'."\n"
.'- 跨地域共享镜像。如需跨地域共享镜像,需要先复制镜像到目标地域后再共享,参见[CopyImage](~~436978~~)。',
'changeSet' => [
['createdAt' => '2022-05-26T07:13:09.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImagePermission'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyNASDefaultMountTarget' => [
'summary' => '修改NAS文件系统的挂载点。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '04f314****'],
],
[
'name' => 'MountTargetDomain',
'in' => 'query',
'schema' => ['description' => '挂载点域名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0bf744****-xo***.cn-hangzhou.nas.aliyuncs.com'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改NAS文件系统的挂载点',
'description' => '创建NAS文件系统时,系统将自动生成一个挂载点。默认情况下,该挂载点无需修改,如果该挂载点被误操作删除,您需要重新为该办公网络的NAS文件系统指定一个新的挂载点。您可以调用[CreateMountTarget](~~62621~~)来创建挂载点。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNASDefaultMountTarget'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyNASDefaultMountTarget',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyNetworkPackageBandwidth' => [
'summary' => '修改公网精品带宽的带宽大小。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'np-cxj99qb8d34vo****'],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'schema' => ['description' => '公网精品带宽的带宽大小。单位:Mbps。 '."\n"
."\n"
.'- 如果是包年包月精品带宽,则取值范围是2\\~1000。'."\n"
.'- 如果是按量付费精品带宽,且类型是按使用流量计费(PayByTraffic),则取值范围是2\\~200;'."\n"
.'- 如果是按量付费精品带宽,且类型是按固定带宽计费(PayByBandwidth),则取值范围是2\\~1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20000', 'minimum' => '2', 'example' => '10'],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单。[默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。'],
'example' => 'true',
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠ID。', 'type' => 'string', 'required' => false, 'example' => '500033080110596'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '214552063030752'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改公网精品带宽的带宽大小',
'changeSet' => [
['createdAt' => '2025-09-16T10:00:29.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-14T07:58:28.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-17T08:28:37.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2021-11-17T08:28:37.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageBandwidth'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214552063030752\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyNetworkPackageEnabled' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'schema' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => true, 'example' => 'np-cfedn7r2pe48g****'],
],
[
'name' => 'Enabled',
'in' => 'query',
'schema' => [
'description' => '恢复或停用公网精品带宽。',
'type' => 'boolean',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['true' => '恢复', 'false' => '停用'],
'example' => 'true',
'default' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '恢复或停用公网精品带宽',
'summary' => '恢复或停用公网精品带宽。',
'description' => '在开通互联网访问的情况下,如果想要暂时关闭云电脑的上网能力,您可以停用公网精品带宽,然后在需要时重新恢复。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageEnabled'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyNetworkPackageEnabled',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyOfficeSiteAccelerator' => [
'summary' => '修改全球加速配置',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'AccelerateRegion',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要加速的地域信息。',
'type' => 'array',
'items' => [
'description' => '要加速的地域信息。',
'type' => 'object',
'properties' => [
'AccelerateRegionId' => ['description' => '要加速的地域ID。'."\n"
."\n"
.'可添加地域的数量受带宽总额和全球加速实例规格限制。关于各实例规格支持的接入地域数量,请参见[全球加速实例概述](~~153127~~)。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
'IpVersion' => ['description' => '接入全球加速服务的IP地址协议,取值:'."\n"
."\n"
.'- **IPv4**(默认值):IPv4地址协议。'."\n"
."\n"
.'- **IPv6**:IPv6地址协议。'."\n"
."\n"
.'- **DUAL_STACK**:IPv4和IPv6地址协议。'."\n"
."\n"
.'> - DUAL_STACK类型仅标准型按量计费的全球加速实例支持。', 'type' => 'string', 'required' => false, 'example' => 'IPv4'],
'Bandwidth' => ['description' => '公网带宽峰值。单位:Mbps。'."\n"
."\n"
.'> 按固定带宽计费时,取值范围为10\\~1000。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '2', 'example' => '50'],
'IspType' => ['description' => '加速地域公网线路类型。取值:'."\n"
."\n"
.'- **BGP**:BGP(多线)线路。'."\n"
.'- **BGP\\_PRO**:BGP(多线)_精品线路。'."\n"
."\n"
.'> - 带宽计费方式为**按流量**的全球加速实例需要配置该项。'."\n"
.'> - 加速地域不同,支持的加速地域公网线路类型不同。', 'type' => 'string', 'required' => true, 'example' => 'BGP'],
],
'required' => false,
],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'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' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '修改全球加速配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyOfficeSiteAttribute' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-882398****'],
],
[
'name' => 'DesktopAccessType',
'in' => 'query',
'schema' => [
'description' => '连接云电脑时允许使用的接入方式。'."\n"
."\n"
.'> VPC连接方式依赖于阿里云私网连接PrivateLink服务,该服务不收取费用。该参数设置为`VPC`或者`Any`时,系统将自动为您开通私网连接服务。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['INTERNET' => '只允许客户端通过公网连接云电脑。[默认值]', 'VPC' => '只允许处于VPC网络内的客户端连接云电脑。', 'Any' => '不限制方式。使用客户端连接云电脑时可以自行选择连接方式。'],
'example' => 'INTERNET',
],
],
[
'name' => 'OfficeSiteName',
'in' => 'query',
'schema' => ['description' => '办公网络名称。长度为2~255个英文或中文字符。必须以大小字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。 '."\n"
.'默认值:空。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'NeedVerifyLoginRisk',
'in' => 'query',
'schema' => ['description' => '仅适用于便捷账号办公网络,表示登录时是否需要二次验证。如果开启了登录二次验证,则便捷用户登录客户端时,系统将检测登录账号是否有安全风险。如果有风险,系统将发送验证码到该账号关联的邮箱,便捷用户使用验证码验证通过后才能登录客户端。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'NeedVerifyZeroDevice',
'in' => 'query',
'schema' => ['description' => '仅适用于便捷账号办公网络,表示是否开启设备校验。对于AD办公网络,该参数值为空。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'EnableAdminAccess',
'in' => 'query',
'schema' => [
'description' => '是否为使用云电脑的用户赋予本地管理员权限。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '赋予本地管理员权限 [默认值]', 'false' => '不赋予本地管理员权限'],
'example' => 'false',
],
],
[
'name' => 'AuthorityHost',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'TenantId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'ClientSecret',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '修改办公网络属性',
'summary' => '修改办公网络(原工作区)的基本属性,例如办公网络名称、是否为使用云电脑的用户赋予本地管理员权限等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-10-24T06:34:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-11-15T09:35:30.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2023-03-07T08:13:52.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-10-28T11:55:04.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2021-10-28T11:55:04.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteAttribute'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\nDE6C3EE0-0061-499F-A30C-6E43BB3EF931\\r\\n","errorExample":""}]',
],
'ModifyOfficeSiteCrossDesktopAccess' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-068266****'],
],
[
'name' => 'EnableCrossDesktopAccess',
'in' => 'query',
'schema' => ['description' => '是否开启办公网络内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '设置办公网络内云电脑的互通性',
'summary' => '开启或关闭办公网络(原工作区)内云电脑互通。开启后,同一个办公网络内的云电脑之间可以实现相互访问彼此的网络。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:43.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteCrossDesktopAccess'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyOfficeSiteDnsInfo' => [
'summary' => '修改办公网络DNS信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '实例所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-778418****'],
],
[
'name' => 'DnsAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '自定义DNS的IP地址。目前支持最多设置两个。',
'type' => 'array',
'items' => ['description' => '自定义DNS的IP地址。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.47'],
'required' => false,
'docRequired' => false,
'maxItems' => 2,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F7E4322D-D679-5ACB-A909-490D2F0E****'],
],
'description' => '',
],
],
],
'title' => '修改办公网络DNS地址',
'changeSet' => [
['createdAt' => '2025-02-18T08:37:26.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteDnsInfo'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7E4322D-D679-5ACB-A909-490D2F0E****\\"\\n}","type":"json"}]',
],
'ModifyOfficeSiteMfaEnabled' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'MfaEnabled',
'in' => 'query',
'schema' => [
'description' => '开启或者关闭多因素认证MFA。',
'type' => 'boolean',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['true' => '开启MFA', 'false' => '关闭MFA'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '设置AD办公网络的多因素认证',
'summary' => '为AD办公网络(原工作区)开启或者关闭多因素认证MFA。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteMfaEnabled'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteMfaEnabled',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyPolicyGroup' => [
'summary' => '修改云电脑策略。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'PolicyGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑策略ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '云电脑策略名称。', 'type' => 'string', 'required' => false, 'example' => 'testPolicyGroupName'],
],
[
'name' => 'Clipboard',
'in' => 'query',
'schema' => [
'description' => '剪贴板权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['read' => '单向允许。可以将本地内容复制到云电脑,不能将云电脑内容复制到本地', 'readwrite' => '双向允许。可以将本地内容复制到云电脑,也可以将云电脑内容复制到本地', 'write' => '单向允许。可以将云电脑内容复制到本地,不能将本地内容复制到云电脑', 'off' => '双向禁止。云电脑和本地之间无法进行复制操作 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'LocalDrive',
'in' => 'query',
'schema' => [
'description' => '本地磁盘映射权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['read' => '只读。云电脑上有本地磁盘的映射,但是只能读取(复制)本地文件,不能修改本地文件', 'readwrite' => '读写。云电脑上有本地磁盘的映射,可以读取(复制)本地文件,也可以修改本地文件', 'off' => '关闭。云电脑上没有本地磁盘的映射 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'UsbRedirect',
'in' => 'query',
'schema' => [
'description' => 'USB重定向。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'VisualQuality',
'in' => 'query',
'schema' => [
'description' => '图像显示质量策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['high' => '高清', 'low' => '流畅', 'lossless' => '无损', 'medium' => '自适应 [默认值]'],
'example' => 'low',
],
],
[
'name' => 'Html5Access',
'in' => 'query',
'schema' => [
'description' => 'Web客户端访问策略。'."\n"
."\n"
.'> 推荐您使用`ClientType`相关参数统一管控登录方式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['off' => '禁止', 'on' => '允许'],
'example' => 'off',
],
],
[
'name' => 'Html5FileTransfer',
'in' => 'query',
'schema' => [
'description' => 'Web客户端文件传输策略。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['all' => '允许上传下载', 'download' => '允许下载', 'upload' => '允许上传', 'off' => '关闭 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'Watermark',
'in' => 'query',
'schema' => [
'description' => '水印。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['blind' => '开启盲水印', 'off' => '关闭水印', 'on' => '开启明水印'],
'example' => 'off',
],
],
[
'name' => 'WatermarkType',
'in' => 'query',
'schema' => [
'description' => '水印类型。最多可以选择3个类型,用半角逗号隔开。'."\n"
."\n"
.'> 若传入`custom`,则必须同时通过参数`WatermarkCustomText`传入自定义文本的内容。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['EndUserId' => '用户名', 'Custom' => '自定义文本', 'DesktopIp' => '云电脑IP地址', 'ClientIp' => '客户端IP地址', 'HostName' => '云电脑ID的后15位', 'ClientTime' => '云电脑当前时间'],
'example' => 'EndUserId',
],
],
[
'name' => 'WatermarkTransparency',
'in' => 'query',
'schema' => [
'description' => '水印显示的深浅程度。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['LIGHT' => '较浅 [默认值]', 'DARK' => '较深', 'MIDDLE' => '普通'],
'example' => 'LIGHT',
],
],
[
'name' => 'PreemptLogin',
'in' => 'query',
'schema' => [
'description' => '云电脑抢占策略。'."\n"
."\n"
.'> 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占,即该配置默认为`off`,且不可修改。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不允许多个用户之间互相抢占 [默认值]'],
'example' => 'off',
],
],
[
'name' => 'DomainList',
'in' => 'query',
'schema' => [
'description' => '管控访问域名权限,域名支持*通配符,多个域名之间以英文逗号隔开。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'PrinterRedirection',
'in' => 'query',
'schema' => [
'description' => '打印机重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'PreemptLoginUser',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '可抢占云电脑的一组用户的用户名,最多可以设置5个。'."\n"
."\n"
.'> 为保证正在使用云电脑的终端用户的操作体验和数据安全,暂不允许多个用户之间互相抢占。',
'type' => 'array',
'items' => ['description' => '可抢占云电脑的用户的用户名。', 'type' => 'string', 'required' => false, 'example' => 'Alice'],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'AuthorizeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '安全组管控规则。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'inflow',
],
'Policy' => [
'description' => '安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '拒绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求'],
'example' => 'accept',
],
'PortRange' => ['description' => '安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:端口为-1/-1。'."\n"
.'- GRE协议:端口为-1/-1。'."\n"
.'- IpProtocol取值为all:端口为-1/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['UDP' => 'UDP协议', 'TCP' => 'TCP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'TCP',
],
'Priority' => ['description' => '安全组管控规则的优先级。数字越小,代表优先级越高。取值范围:1\\~60。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '10.0.XX.XX/8'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'RevokeSecurityPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待删除安全组管控规则列表。',
'type' => 'array',
'items' => [
'description' => '待删除安全组管控规则。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '待删除安全组管控规则的规则方向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['outflow' => '出方向', 'inflow' => '入方向'],
'example' => 'outflow',
],
'Policy' => [
'description' => '待删除安全组管控规则的授权策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '绝策略,拒绝所有访问请求。不返回拒绝信息,表现为发起端请求超时或者无法建立连接', 'accept' => '允许策略,接收所有访问请求 [默认值]'],
'example' => 'accept',
],
'PortRange' => ['description' => '待删除安全组管控规则的端口范围。由协议(IpProtocol)的取值确定端口的取值范围:'."\n"
."\n"
.'- TCP协议或者UDP协议:端口取值范围为1~65535。使用斜线(/)隔开起始端口和终止端口。例如:1/200。'."\n"
.'- ICMP协议:端口为-1/-1。'."\n"
.'- GRE协议:端口为-1/-1。'."\n"
.'- IpProtocol取值为all:端口为-1/-1。'."\n"
."\n"
.'典型应用的常用端口请参见[常用端口](~~40724~~)。', 'type' => 'string', 'required' => false, 'example' => '22/22'],
'Description' => ['description' => '待删除安全组管控规则的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'IpProtocol' => [
'description' => '待删除安全组管控规则的协议类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => 'TCP协议', 'UDP' => 'UDP协议', 'ALL' => '支持所有协议', 'GRE' => 'GRE协议', 'ICMP' => 'ICMP(IPv4)协议'],
'example' => 'tcp',
],
'Priority' => ['description' => '待删除安全组管控规则的优先级。数字越小,代表优先级越高。取值范围:1\\~60。默认值:1。', 'type' => 'string', 'required' => false, 'example' => '1'],
'CidrIp' => ['description' => '待删除安全组管控规则的对象,CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 200,
],
],
[
'name' => 'AuthorizeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '客户端IP白名单列表。',
'type' => 'array',
'items' => [
'description' => '客户端IP白名单对象。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'CidrIp' => ['description' => '客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => true, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RevokeAccessPolicyRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待删除客户端IP白名单列表。',
'type' => 'array',
'items' => [
'description' => '待删除客户端IP白名单。',
'type' => 'object',
'properties' => [
'Description' => ['description' => '待删除客户端IP白名单的描述信息。', 'type' => 'string', 'required' => false, 'example' => 'test'],
'CidrIp' => ['description' => '待删除客户端访问IP地址段。格式为CIDR格式的IPv4地址段。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/16'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ClientType',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '登录方式管控规则列表。',
'type' => 'array',
'items' => [
'description' => '登录方式管控规则。',
'type' => 'object',
'properties' => [
'ClientType' => [
'description' => '登录方式管控,设置客户端类型。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'windows' => 'Windows客户端', 'ios' => 'iOS客户端', 'macos' => 'macOS客户端'],
'example' => 'windows',
],
'Status' => [
'description' => '登录方式管控,设置是否允许使用某一类型的客户端登录云电脑。'."\n"
."\n"
.'> 如果不设置`ClientType`相关参数,则默认允许所有类型的客户端登录云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不允许', 'on' => '允许'],
'example' => 'ON',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'GpuAcceleration',
'in' => 'query',
'schema' => [
'description' => '是否为图形型规格云电脑开启画质策略。对云电脑性能和使用体验要求较高时,例如专业设计场景下,建议开启该策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'UsbSupplyRedirectRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'USB重定向规则。',
'type' => 'array',
'items' => [
'description' => 'USB重定向规则。',
'type' => 'object',
'properties' => [
'VendorId' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '04**'],
'ProductId' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '08**'],
'Description' => ['description' => '规则描述。', 'type' => 'string', 'required' => false, 'example' => 'Test rule'],
'UsbRedirectType' => [
'description' => 'USB重定向类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '允许', '拒绝'],
'example' => '1',
],
'DeviceClass' => ['description' => '设备类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'required' => false, 'example' => '0Eh'],
'DeviceSubclass' => ['description' => '设备子类别,当`usbRuleType`为1的时候需要填写。参见[Defined Class Codes](https://www.usb.org/defined-class-codes)。', 'type' => 'string', 'required' => false, 'example' => 'xxh'],
'UsbRuleType' => [
'description' => 'USB重定向规则类型。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [1 => '设备类别', '设备厂商'],
'example' => '1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DomainResolveRuleType',
'in' => 'query',
'schema' => [
'description' => '域名解析策略类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['OFF' => '关闭', 'ON' => '开启'],
'example' => 'OFF',
],
],
[
'name' => 'DomainResolveRule',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名解析策略详情。',
'type' => 'array',
'items' => [
'description' => '域名解析策略详情。',
'type' => 'object',
'properties' => [
'Domain' => ['description' => '域名。', 'type' => 'string', 'required' => false, 'example' => '*.example.com'],
'Policy' => [
'description' => '解析策略。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['allow' => '允许', 'block' => '拒绝'],
'example' => 'allow',
],
'Description' => ['description' => '策略描述。', 'type' => 'string', 'required' => false, 'example' => 'Policy description.'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'Recording',
'in' => 'query',
'schema' => [
'description' => '是否开启录屏。',
'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' => '录屏开始时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:00:00'],
],
[
'name' => 'RecordingEndTime',
'in' => 'query',
'schema' => ['description' => '录屏结束时间,取值:HH:MM:SS。只有`Recording`取值是`PERIOD`时,该返回值有实际意义。', 'type' => 'string', 'required' => false, 'example' => '08:59:00'],
],
[
'name' => 'RecordingFps',
'in' => 'query',
'schema' => [
'description' => '录屏帧率。单位:FPS(帧/秒)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [2 => '2', 5 => '5', 10 => '10', 15 => '15'],
'example' => '5',
],
],
[
'name' => 'RecordingExpires',
'in' => 'query',
'schema' => ['description' => '录屏文件的保留时间。取值范围为1\\~180天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15'],
],
[
'name' => 'NetRedirect',
'in' => 'query',
'schema' => [
'description' => '网络重定向。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'CameraRedirect',
'in' => 'query',
'schema' => [
'description' => '是否开启本地摄像头重定向。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启 [默认值]'],
'example' => 'on',
],
],
[
'name' => 'AppContentProtection',
'in' => 'query',
'schema' => [
'description' => '是否开启防截屏功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'RecordContent',
'in' => 'query',
'schema' => [
'description' => '是否开启自定义录屏。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭 [默认值]', 'on' => '开启'],
'example' => 'OFF',
],
],
[
'name' => 'RecordContentExpires',
'in' => 'query',
'schema' => ['description' => '自定义录屏的文件过期时间,默认30天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'],
],
[
'name' => 'RemoteCoordinate',
'in' => 'query',
'schema' => [
'description' => '远程协助键鼠控制权限。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['optionalControl' => '默认关闭,可以申请打开', 'fullControl' => '完全控制', 'disableControl' => '不控制'],
'example' => 'fullControl',
],
],
[
'name' => 'RecordingDuration',
'in' => 'query',
'schema' => [
'description' => '录屏文件阅览时长,单位为分钟。录制文件会根据您设置的时长自动切分并上传至存储空间,文件达到300MB时优先滚动更新。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => [10 => '10', 20 => '20', 30 => '30', 60 => '60'],
'example' => '10',
],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => [
'description' => '策略的生效范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['IP' => '根据IP生效', 'GLOBAL' => '全局生效'],
'example' => 'GLOBAL',
],
],
[
'name' => 'ScopeValue',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '`Scope`取值为`IP`的时候填写。当`Scope`为`IP`时生效,否则不生效。',
'type' => 'array',
'items' => ['description' => '生效的CIDR Block。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX/24'],
'required' => false,
'maxItems' => 3,
],
],
[
'name' => 'RecordingAudio',
'in' => 'query',
'schema' => [
'description' => '录制云电脑声音选项。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '仅录制画面不录制声音', 'on' => '音画同期录制'],
'example' => 'on',
],
],
[
'name' => 'InternetCommunicationProtocol',
'in' => 'query',
'schema' => [
'description' => '网络通信协议。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['TCP' => '只允许使用TCP [默认值]', 'BOTH' => '允许自动在TCP和UDP之间切换'],
'example' => 'BOTH',
],
],
[
'name' => 'VideoRedirect',
'in' => 'query',
'schema' => ['description' => '多媒体重定向。', 'type' => 'string', 'required' => false, 'example' => 'on'],
],
[
'name' => 'WatermarkTransparencyValue',
'in' => 'query',
'schema' => ['description' => '水印透明度,值越大,透明度越小。 取值范围:10\\~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkColor',
'in' => 'query',
'schema' => ['description' => '水印字体颜色。 取值范围:0\\~16777215。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'WatermarkDegree',
'in' => 'query',
'schema' => ['description' => '水印倾斜度。取值范围:-10\\~-30 。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '-10'],
],
[
'name' => 'WatermarkFontSize',
'in' => 'query',
'schema' => ['description' => '水印字体大小。 取值范围:10\\~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'WatermarkFontStyle',
'in' => 'query',
'schema' => [
'description' => '水印字体样式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['plain' => '普通', 'bold' => '加粗'],
'example' => 'plain',
],
],
[
'name' => 'WatermarkRowAmount',
'in' => 'query',
'schema' => ['description' => '水印行数。'."\n"
."\n"
.'> 此参数暂未开放使用。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'EndUserApplyAdminCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户申请管理员协助开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'EndUserGroupCoordinate',
'in' => 'query',
'schema' => [
'description' => '用户之间流协同开关。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'on',
],
],
[
'name' => 'WatermarkSecurity',
'in' => 'query',
'schema' => [
'description' => '盲水印安全优先规则。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'AdminAccess',
'in' => 'query',
'schema' => ['description' => '用户登录云电脑后是否具有管理员权限。'."\n"
."\n"
.'> 该功能处于定向邀测中,暂不对外开放。', 'type' => 'string', 'required' => false, 'example' => 'deny'],
],
[
'name' => 'WatermarkAntiCam',
'in' => 'query',
'schema' => [
'description' => '盲水印防拍照功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'WatermarkPower',
'in' => 'query',
'schema' => [
'description' => '盲水印增强功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['high' => '高', 'low' => '低', 'medium' => '中'],
'example' => 'medium',
],
],
[
'name' => 'RecordingUserNotify',
'in' => 'query',
'schema' => [
'description' => '录屏客户端消息通知功能。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '关闭', 'on' => '开启'],
'example' => 'off',
],
],
[
'name' => 'RecordingUserNotifyMessage',
'in' => 'query',
'schema' => ['description' => '录屏客户端通知内容。默认无需填写。', 'type' => 'string', 'required' => false, 'example' => 'Your cloud desktop is being recorded.'],
],
[
'name' => 'MaxReconnectTime',
'in' => 'query',
'schema' => ['description' => '云电脑由于客观原因造成断开连接的最大连接重试时间。取值范围:30\\~7200,单位:秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
],
[
'name' => 'DeviceRedirects',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '设备重定向规则列表。',
'type' => 'array',
'items' => [
'description' => '设备重定向规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['printer' => '打印机', 'scanner' => '扫描仪', 'camera' => '摄像头', 'adb' => 'Android设备'],
'example' => 'camera',
],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭重定向'],
'example' => 'usbRedirect',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DeviceRules',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => '自定义外设规则列表。',
'type' => 'array',
'items' => [
'description' => '自定义外设规则。',
'type' => 'object',
'properties' => [
'DeviceType' => [
'description' => '外设类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['usbKey' => 'UKey', 'other' => '其他', 'graphicsTablet' => '手绘板', 'printer' => '打印机', 'cardReader' => '读卡器', 'scanner' => '扫描仪', 'storage' => '存储设备', 'camera' => '摄像头', 'adb' => 'Android设备', 'networkInterfaceCard' => '网卡设备'],
'example' => 'storage',
],
'DeviceName' => ['description' => '设备名称。', 'type' => 'string', 'required' => false, 'example' => 'sandisk'],
'DevicePid' => ['description' => '产品ID。', 'type' => 'string', 'required' => false, 'example' => '0x0781'],
'DeviceVid' => ['description' => '生产厂商ID。参见[Valid USB Vendor IDs (VIDs)](https://www.usb.org/sites/default/files/vendor_ids032322.pdf_1.pdf)。', 'type' => 'string', 'required' => false, 'example' => '0x55b1'],
'RedirectType' => [
'description' => '重定向类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['deviceRedirect' => '设备重定向', 'usbRedirect' => 'USB重定向', 'off' => '关闭'],
'example' => 'usbRedirect',
],
'OptCommand' => ['description' => '链接优化指令。', 'type' => 'string', 'required' => false, 'example' => '2:0'],
'Platforms' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'WyAssistant',
'in' => 'query',
'schema' => [
'description' => '是否在云电脑悬浮球内提供无影AI助手功能入口。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['off' => '不提供无影AI助手功能入口', 'on' => '提供无影AI助手功能入口'],
'example' => 'on',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '修改云电脑策略',
'changeSet' => [
['createdAt' => '2025-04-25T02:16:49.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-14T04:04:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-15T02:54:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-05T08:33:58.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-19T01:52:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-01T02:35:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-26T09:19:38.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-01-05T03:28:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-09-20T03:02:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-07-31T09:50:13.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-22T01:55:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-11-04T13:38:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-10-08T02:09:35.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-05T11:17:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-07-19T03:46:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-30T06:09:40.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-07T06:02:15.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-01-11T06:20:52.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-30T06:31:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-04-19T11:05:50.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPolicyGroup'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyPolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyQosEntries' => [
'summary' => '修改限速规则资源绑定关系。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'QosRuleId',
'in' => 'query',
'schema' => ['description' => '公网限速规则ID。', 'type' => 'string', 'required' => true, 'example' => 'qos-5605u0gelk200****'],
],
[
'name' => 'AuthDesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '绑定云电脑 ID 列表。',
'type' => 'array',
'items' => ['description' => '云电脑 ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RevokeDesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '解绑云电脑 ID 列表。',
'type' => 'array',
'items' => ['description' => '云电脑 ID 。', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthAndroidId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '绑定云手机 ID 列表。',
'type' => 'array',
'items' => ['description' => '云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RevokeAndroidId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '解绑云手机 ID 列表。',
'type' => 'array',
'items' => ['description' => '云手机ID。', 'type' => 'string', 'required' => false, 'example' => 'cpn-asdsdfsdffsd*****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AuthDesktopGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 100,
],
],
[
'name' => 'RevokeDesktopGroupId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
'description' => '',
],
],
],
'title' => '修改限速规则资源绑定关系',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyQosEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyQosRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'QosRuleId',
'in' => 'query',
'schema' => ['description' => '限速规则ID。', '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' => '上行带宽峰值。单位为Mbps。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Download',
'in' => 'query',
'schema' => ['description' => '下行带宽峰值。单位为Mbps。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
'description' => '',
],
],
],
'title' => '修改限速规则。',
'summary' => '修改限速规则。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyQosRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyResourceCenterPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'desktop' => '云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'ResourceIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表。'."\n"
.'可设置0\\~100个。',
'type' => 'array',
'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-00001'],
'required' => true,
'docRequired' => false,
'maxItems' => 100,
],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
'schema' => ['description' => '资源所在地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => [
'description' => '产品类型。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['app' => '云应用', 'resourceGroup' => '资源组', 'desktop' => '云电脑', 'desktopGroup' => '共享型云电脑'],
'example' => 'desktop',
],
],
[
'name' => 'PolicyGroupType',
'in' => 'query',
'schema' => [
'description' => '策略类型。',
'type' => 'string',
'required' => true,
'docRequired' => false,
'enumValueTitles' => ['general' => '通用策略'],
'example' => 'general',
],
],
[
'name' => 'PolicyGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要绑定的云电脑策略ID列表。'."\n"
."\n"
.'> 最多可以填写1条全局生效的云电脑策略和4条针对指定IP生效的云电脑策略。如果填写的全局生效的云电脑策略超过1条,则仅第1条生效。',
'type' => 'array',
'items' => ['description' => '策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
'required' => true,
'docRequired' => false,
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****'],
'ModifyResults' => [
'description' => '修改结果。',
'type' => 'array',
'items' => [
'description' => '修改结果。',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'ecd-e254cpyt9bb*****'],
'CheckResult' => ['description' => '校验结果。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'description' => '',
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '修改资源关联的无地域策略',
'summary' => '修改与云资源绑定的无地域策略。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ModifyResourceCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"ModifyResults\\": [\\n {\\n \\"ResourceId\\": \\"ecd-e254cpyt9bb*****\\",\\n \\"CheckResult\\": true\\n }\\n ]\\n}","type":"json"}]',
],
'ModifyTemplate' => [
'summary' => '修改自定义云电脑模板的全部参数。',
'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' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => 'b-0caoeogs88y*****'],
],
[
'name' => 'TemplateName',
'in' => 'formData',
'schema' => ['title' => '模板名称', 'description' => '模板的名称。必须符合以下要求:'."\n"
."\n"
.'- 长度2~126个英文或中文字符。'."\n"
.'- 必须以大小写字母或中文开头,不能以`http://`和`https://`开头。'."\n"
.'- 可以包含字母、数字、汉字、半角冒号(:)、下划线(_)或短划线(-),不支持点号(.)。', 'type' => 'string', 'required' => false, 'example' => 'My cloud desktop template 001', 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '模板的描述。必须符合以下要求:'."\n"
."\n"
.'- 长度2~256个字符,不能以`http://`和`https://`开头。'."\n"
.'- 支持中文、英文、数字、空格和特殊符号,使用回车换行。', 'type' => 'string', 'required' => false, 'example' => 'testDescription', 'maxLength' => 256, 'minLength' => 2],
],
[
'name' => 'SystemDiskSize',
'in' => 'formData',
'schema' => ['title' => '系统盘大小/GB', 'description' => '系统盘大小。单位:GiB。取值范围: 40~500,每10GiB为一个步长。'."\n"
."\n"
.'> 系统盘大小不能小于配置的镜像大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2040', 'minimum' => '40', 'example' => '80'],
],
[
'name' => 'SystemDiskPerformanceLevel',
'in' => 'formData',
'schema' => [
'title' => '系统盘性能等级',
'description' => '系统盘类型。'."\n"
."\n"
.'> 只有高主频和图形型的云电脑规格支持ESSD类型的磁盘。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'ESSD极速云盘PL1等级', 'PL0' => 'ESSD极速云盘PL0等级', 'AutoPL' => 'SSD极速云盘'],
'example' => 'AutoPL',
],
],
[
'name' => 'DataDiskList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Size' => ['description' => '数据盘大小。单位:GiB。输入值范围: 40~2040GiB,每10GiB为一个步长。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2040', 'minimum' => '0', 'example' => '40'],
'PerformanceLevel' => [
'description' => '数据盘性能等级,默认为`AutoPL`。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['PL1' => 'ESSD极速云盘PL1等级', 'PL0' => 'ESSD极速云盘PL0等级', 'AutoPL' => 'SSD极速云盘'],
],
],
'required' => false,
'description' => '',
],
'required' => false,
'description' => '',
],
],
[
'name' => 'ImageId',
'in' => 'formData',
'schema' => ['title' => '镜像id', 'description' => '云电脑镜像ID,可以从镜像管理页面查询,支持系统镜像、自定义镜像等类型。', 'type' => 'string', 'required' => false, 'example' => 'm-gx2x1dhsmusr2****'],
],
[
'name' => 'PolicyGroupId',
'in' => 'formData',
'schema' => ['title' => '策略ID', 'description' => '全局类型的策略ID。', 'type' => 'string', 'required' => false, 'example' => 'pg-gx2x1dhsmthe9****'],
],
[
'name' => 'DefaultLanguage',
'in' => 'formData',
'schema' => [
'title' => '默认语言',
'description' => '云电脑启动时设置的默认语言,仅在使用系统镜像创建云电脑的场景下生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['en-US' => '英语', 'zh-HK' => '繁体中文(香港)', 'zh-CN' => '简体中文', 'ja-JP' => '日语'],
'example' => 'zh-CN',
],
],
[
'name' => 'TimerGroupId',
'in' => 'formData',
'schema' => ['title' => '中心定时任务组ID', 'description' => '配置组ID。', 'type' => 'string', 'required' => false, 'example' => 'bcc-dweha*****'],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-a5fqjjqaejt***'],
],
[
'name' => 'ResourceTagList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '云电脑标签。Key-Value格式。最多可传入20个标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'Value' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'design'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'RegionConfigList',
'in' => 'formData',
'style' => 'flat',
'schema' => [
'description' => '地域化的模板信息配置, 支持配置多个。 使用时会根据具体的地域匹配。'."\n"
."\n"
.'> 最多支持20个地域的配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
'SnapshotPolicyId' => ['description' => '自动快照策略ID。', 'type' => 'string', 'required' => false, 'example' => 'sp-35fvn8m2*****'],
'ResourceInstanceType' => ['description' => '云电脑规格ID。', 'type' => 'string', 'required' => false, 'example' => 'eds.enterprise_office.8c16g'],
'VolumeEncryptionEnable' => [
'description' => '是否开启磁盘加密功能。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['false' => '不开启 [默认值]', 'true' => '开启'],
'example' => 'false',
],
'VolumeEncryptionKey' => ['description' => '开启磁盘加密的情况下使用的KMS的密钥ID。', 'type' => 'string', 'required' => false, 'example' => 'a7b3c0c8-b3a2-4876-b1cc-116dddc9****'],
'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-709****'],
'SubnetId' => ['description' => '子网ID。', '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, 'description' => ''],
'AppRuleId' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
'description' => '',
],
'required' => false,
'description' => '',
],
],
[
'name' => 'ChargeType',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['PostPaid', 'PrePaid'],
'description' => '',
],
],
[
'name' => 'Period',
'in' => 'formData',
'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '6', 'minimum' => '1', 'description' => ''],
],
[
'name' => 'PeriodUnit',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => false,
'enum' => ['Month', 'Year', 'Week'],
'description' => '',
],
],
[
'name' => 'AutoPay',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
[
'name' => 'UserDuration',
'in' => 'formData',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enum' => ['120', '250', '360'],
'description' => '',
],
],
[
'name' => 'PostPaidAfterUsedUp',
'in' => 'formData',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
'Success' => ['description' => '操作是否成功。取值:true:成功。false:失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', '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' => '修改自定义云电脑模板全部参数',
'description' => '>为了兼容模板中参数的不设置与默认升级逻辑,该接口采用全量参数更新逻辑,换言之,不设置的参数均视为设置为空。>',
'changeSet' => [
['createdAt' => '2025-12-25T06:33:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-08-05T10:16:20.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-04T06:22:42.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyTemplateBaseInfo' => [
'summary' => '修改自定义云电脑模板的基本信息,包括模板名称和模板描述。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'formData',
'schema' => ['title' => '模板ID', 'description' => '模板ID。', 'type' => 'string', 'required' => true, 'example' => 'b-0caoeogs88y*****'],
],
[
'name' => 'TemplateName',
'in' => 'formData',
'schema' => ['title' => '模板名称', 'description' => '模板名称。', 'type' => 'string', 'required' => false, 'example' => 'Shanghai template1', 'maxLength' => 126, 'minLength' => 2, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '模板描述', 'description' => '模板描述。', 'type' => 'string', 'required' => false, 'example' => 'This is description.', 'maxLength' => 256, 'minLength' => 2],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'True'],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'RequestId' => ['description' => '请求ID。', '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' => '修改自定义云电脑模板基本信息',
'description' => '本接口仅用于修改自定义云电脑模板的名称和描述,如需修改自定义云电脑模板的参数,请使用[ModifyTemplate](~~2925841~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyTemplateBaseInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyTimerGroup' => [
'summary' => '修改配置组的具体设置,例如定时任务的配置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'list', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '配置组ID。', 'type' => 'string', 'required' => true, 'example' => 'cg-i1ruuudp92qpj****'],
],
[
'name' => 'ConfigTimers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '定时任务的配置信息。',
'type' => 'array',
'items' => [
'description' => '定时任务的配置信息。',
'type' => 'object',
'properties' => [
'TimerType' => [
'description' => '定时任务类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['NoOperationDisconnect' => '无操作断连', 'NoConnect' => '断连任务(需指定OperationType)', 'TimerBoot' => '定时开机', 'TimerReset' => '定时重置', 'NoOperationShutdown' => '无操作关机', 'NoOperationHibernate' => '无操作休眠', 'TimerShutdown' => '定时关机', 'NoOperationReboot' => '无操作重启', 'TimerReboot' => '定时重启'],
'example' => 'TimerBoot',
],
'CronExpression' => ['description' => '定时任务Cron表达式。'."\n"
."\n"
.'> 需要传入UTC标准时间,即北京时间每天0点应该传入0 0 16 ? * 1,2,3,4,5,6,7。', 'type' => 'string', 'required' => false, 'example' => '0 0 16 ? * 1,2,3,4,5,6,7'."\n"],
'Interval' => ['description' => '时间间隔,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
'Enforce' => ['description' => '是否强制执行。为true表示忽略桌面及连接状态检测,强制执行定时任务。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'ResetType' => [
'description' => '重置类型,决定是否重置,以及要重置的磁盘范围。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '重置系统盘', 'RESET_TYPE_USER_DISK' => '重置数据盘', 'RESET_TYPE_BOTH' => '重置系统盘和数据盘'],
'example' => 'RESET_TYPE_SYSTEM',
],
'AllowClientSetting' => ['description' => '是否允许终端用户自行配置定时任务。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'OperationType' => [
'description' => '定时任务操作类型,目前仅断连定时任务支持。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Hibernate' => '休眠', 'Shutdown' => '关机'],
'example' => 'Shutdown',
],
'TriggerType' => [
'description' => '无操作定时任务触发配置类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Advanced' => '智能判断', 'Standard' => '标准判断'],
'example' => 'Standard',
],
'ProcessWhitelist' => [
'description' => '无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。',
'type' => 'array',
'items' => ['description' => '进程名称。', 'type' => 'string', 'required' => false, 'example' => 'chrome'],
'required' => false,
'maxItems' => 30,
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'SegmentTimers' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperationType' => ['type' => 'string', 'required' => false, 'description' => ''],
'StartCronExpression' => ['type' => 'string', 'required' => false, 'description' => ''],
'EndCronExpression' => ['type' => 'string', 'required' => false, 'description' => ''],
'Interval' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'TriggerType' => ['type' => 'string', 'required' => false, 'description' => ''],
'ProcessWhitelist' => [
'type' => 'array',
'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
'maxItems' => 30,
'description' => '',
],
'NotificationTime' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'TimerOrder' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'description' => ''],
'Timezone' => ['type' => 'string', 'required' => false, 'description' => ''],
'Enforce' => ['type' => 'boolean', 'required' => false, 'description' => ''],
'ResetType' => ['type' => 'string', 'required' => false, 'description' => ''],
'ImageId' => ['title' => '变更镜像定时任务使用,指定需要变更的镜像ID', 'type' => 'string', 'required' => false, 'example' => 'm-5b0vjqbiqu010XXXXXX', 'description' => '变更镜像定时任务使用,指定需要变更的镜像ID'],
'LockScreenTime' => ['title' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1800', 'description' => '无操作锁屏功能使用,指定锁屏时间点,非AD桌面不能使用'],
'AppointmentTimer' => ['title' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1764660600967', 'description' => '定点执行定时任务使用,指定后可以按照指定时间点执行定时任务'],
'VerificationTime' => ['type' => 'integer', 'format' => 'int32'],
'VerificationNotificationTime' => ['type' => 'integer', 'format' => 'int32'],
'IpSegments' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 10,
],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 10,
'description' => '',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '配置组名称。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '配置组描述信息。', 'type' => 'string', 'required' => false, 'example' => 'Scheduled task'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'GroupId' => ['description' => '配置组ID。', 'type' => 'string', 'example' => 'cg-i1ruuudp92qpj****'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationTooFrequent', 'errorMessage' => 'The operation is too frequent, please try again later.', 'description' => '操作过于频繁,请稍后再试'],
],
],
'title' => '修改配置组设置',
'changeSet' => [
['createdAt' => '2025-12-23T14:10:41.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-08-22T12:24:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-07-11T10:01:34.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2025-05-26T02:20:24.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-27T02:07:53.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"GroupId\\": \\"cg-i1ruuudp92qpj****\\"\\n}","type":"json"}]',
],
'ModifyUserEntitlement' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户ID(即用户名)列表。',
'type' => 'array',
'items' => ['description' => '用户ID(即用户名)。', 'type' => 'string', 'required' => false, 'example' => 'Alice'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'AuthorizeDesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要新增授权用户的云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '要新增授权用户的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'RevokeDesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要删除授权用户的云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '要删除授权用户的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-j45qtb0eh91yg****'],
'required' => false,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为便捷用户新增或删除云电脑授权',
'summary' => '为一个或多个用户新增或删除指定的一台或多台云电脑的授权。',
'description' => '只有状态为运行中(Running)的云电脑支持修改授权用户。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserEntitlement'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyUserEntitlement',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ModifyUserToDesktopGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '要替换授权用户的共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'OldEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需移除的授权用户ID列表。可配置1~500个。',
'type' => 'array',
'items' => ['description' => '需移除的授权用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => true,
'maxItems' => 10000,
],
],
[
'name' => 'NewEndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需添加的授权用户ID列表。可配置1~500个。',
'type' => 'array',
'items' => ['description' => '需添加的授权用户ID。', 'type' => 'string', 'required' => false, 'example' => 'jack'],
'required' => true,
'maxItems' => 10000,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为共享型云电脑替换授权用户',
'summary' => '将共享型云电脑的指定授权用户替换为其他指定授权用户。',
'changeSet' => [
['createdAt' => '2022-03-23T11:44:45.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2022-03-23T11:44:45.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserToDesktopGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CFC74699-6F9C-5437-861A-D186E3347B7E\\n","errorExample":""}]',
],
'MoveCdsFile' => [
'summary' => '将网盘中的文件或文件夹移动至新的位置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+cds-346063****'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63f3257b68b018170b194d87b875512d108f****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '使用网盘的用户ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'user01'],
],
[
'name' => 'ParentFolderId',
'in' => 'query',
'schema' => ['description' => '复制目的地位置的父文件夹ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。当移动至根目录时,填`root`。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '6409848a6da91d6240604e7ba7337d85ba8a1****'],
],
[
'name' => 'ConflictPolicy',
'in' => 'query',
'schema' => [
'description' => '同名文件处理模式。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['refuse' => '当云端存在同名文件时,拒绝创建新文件,返回客户端已存在同名文件的详细信息', 'auto_rename' => '当发现同名文件时,自动重命名。默认为在原文件名末尾追加当前时间点,例如:xxx20240102_150405', 'ignore' => '允许文件同名', 'over_write' => '覆盖同名文件'],
'example' => 'ignore',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-hvyou5jbob3b0****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'Success' => [
'description' => '操作是否成功。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '成功', 'false' => '失败'],
'example' => 'true',
],
'Code' => ['description' => '执行结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'success'],
'Message' => ['description' => '错误信息。当Code为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'success'],
'MoveCdsFileModel' => [
'description' => '移动文件的操作结果。',
'type' => 'object',
'properties' => [
'AsyncTaskId' => ['description' => '异步任务ID。当复制文件时,不返回该字段;当复制文件夹时,因为是后台异步复制,所以会返回该字段,调用[GetAsyncTask](~~2357404~~)并传入该异步任务ID即可获取任务详细信息。', 'type' => 'string', 'example' => 'fe307518-825a-4c8b-a69c-958f0e8a****'],
'Exist' => [
'description' => '文件是否已存在。',
'type' => 'boolean',
'enumValueTitles' => ['true' => '已存在', 'false' => '不存在'],
'example' => 'false',
],
'FileId' => ['description' => '文件ID。', 'type' => 'string', 'example' => '63636837e47e5a24a8a940218bef395c210e****'],
],
],
],
'description' => '',
],
],
],
'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' => '移动网盘文件',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MoveCdsFile'],
],
],
'ramActions' => [],
],
'QueryHistoryActiveUserCount' => [
'summary' => '用于查询指定日期的历史日活跃用户数和月活跃用户数。',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'DataDate',
'in' => 'query',
'schema' => ['description' => '统计日期。格式“YYYY-MM-DD”默认值T-1。'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-01'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '1234567890abcdefg'],
'ActiveUserCount' => [
'description' => '活跃用户数量指标统计',
'type' => 'object',
'properties' => [
'DailyActiveUserCount' => ['description' => '日活用户数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'MonthlyActiveUserCount' => ['description' => '月活用户数'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询历史日活月活用户数',
'description' => '## 请求说明'."\n"
.'- `AliUid` 参数将从AK/SK中自动解析获得,无需手动提供。'."\n"
.'- `BusinessChannel` 默认为企业版,但也可以选择其他业务渠道。'."\n"
.'- `DataDate` 支持自定义统计日期,默认为前一天(T-1)。请确保输入格式符合"YYYY-MM-DD"。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890abcdefg\\",\\n \\"ActiveUserCount\\": {\\n \\"DailyActiveUserCount\\": 20,\\n \\"MonthlyActiveUserCount\\": 300\\n }\\n}","type":"json"}]',
],
'QueryHistoryAvgMetricList' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'MetricName',
'in' => 'query',
'schema' => [
'description' => '监控指标类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['LOAD_SCORE' => '健康分', 'GPU_USAGE' => 'GPU使用率', 'CPU_TOTAL_USAGE' => 'CPU使用率', 'MEMORY_USAGE' => '内存使用率', 'ROUND_TRIP_TIME' => '端到端延迟', 'TOTAL_DISK_USAGE' => '硬盘使用率'],
'example' => 'LOAD_SCORE',
],
],
[
'name' => 'DataDate',
'in' => 'query',
'schema' => ['description' => '统计起始日期。格式“YYYY-MM-DD”,默认值T-1。'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-04-01'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '桌面ID列表,最多支持100个'."\n",
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-2h7u3ymhm33qy****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
'schema' => ['description' => '桌面Region'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Range',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '自定义数值区间列表',
'type' => 'object',
'properties' => [
'Label' => ['description' => '区间标签(用于返回值)'."\n", 'type' => 'string', 'required' => false, 'example' => 'label-02\''],
'Min' => ['description' => '最小值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0'],
'IncludeMin' => ['description' => '是否包含最小值,默认 true'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Max' => ['description' => '最大值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'],
'IncludeMax' => ['description' => '是否包含最大值,默认 false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
],
[
'name' => 'SortType',
'in' => 'query',
'schema' => [
'description' => '排序方式'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ASC' => '升序', 'DESC' => '降序'],
'example' => 'ASC',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => ['description' => '页码,默认值1,>0'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页大小,默认值20,1-200'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '100'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '269BDB16-2CD8-4865-84BD-11C40BC2****'],
'AvgMetricList' => [
'description' => '监控指标平均值列表',
'type' => 'array',
'items' => [
'description' => '监控指标平均值数据',
'type' => 'object',
'properties' => [
'DesktopId' => ['description' => '**桌面ID**'."\n", 'type' => 'string', 'example' => 'ecd-bx9i0nsjd3zmibnzq'],
'DesktopName' => ['description' => '**桌面名称**'."\n", 'type' => 'string', 'example' => 'C-051'],
'DesktopGroupId' => ['description' => '云电脑池ID。', 'type' => 'string', 'example' => 'dg-bogo95eob5avnis9k'],
'MultiResource' => ['description' => '是否为多台共享类型的共享型云电脑。', 'type' => 'boolean', 'example' => 'true'],
'DesktopStatus' => ['description' => '云桌面状态。可能值:'."\n"
.'- Stopped(已关机)'."\n"
.'- Starting(启动中)'."\n"
.'- Rebuilding(重建中)'."\n"
.'- Running(运行中)'."\n"
.'- Stopping(停止中)'."\n"
.'- Expired(已过期)'."\n"
.'- Deleted(已删除)'."\n"
.'- Pending(等待中)', 'type' => 'string', 'example' => 'Running'],
'ManagementFlag' => ['description' => '管理标识。', 'type' => 'string', 'example' => '0'],
'ChargeType' => ['description' => '云桌面的计费方式。取值范围:'."\n"
."\n"
.'- PostPaid:按量付费'."\n"
.'- PrePaid:包年包月'."\n"
."\n"
.'默认值:PostPaid。', 'type' => 'string', 'example' => 'PrePaid'],
'DesktopType' => ['description' => '桌面规格'."\n", 'type' => 'string', 'example' => 'eds.enterprise_office.8c16g'],
'Platform' => ['description' => '系统镜像类型'."\n", 'type' => 'string', 'example' => 'Winserver2025'],
'SubPayType' => ['description' => '付费类型'."\n", 'type' => 'string', 'example' => 'monthPackage'],
'AvgValue' => ['description' => '指标聚合值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Cpu' => ['description' => 'vCPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'GpuSpec' => ['description' => 'GPU显存大小。', 'type' => 'string', 'example' => '0'],
'Memory' => ['description' => '内存大小', 'type' => 'integer', 'format' => 'int64', 'example' => '2048'],
'EndUserIds' => [
'description' => '授权用户列表',
'type' => 'array',
'items' => ['description' => '授权的最终用户ID', 'type' => 'string', 'example' => 'testUser'],
],
'Sessions' => [
'description' => '会话信息列表。',
'type' => 'array',
'items' => [
'description' => '会话信息',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '最终用户ID', 'type' => 'string', 'example' => 'testUser'],
'NickName' => ['description' => '用户的昵称。', 'type' => 'string', 'example' => 'sz-sygc-07-03'],
'ExternalUserName' => ['description' => '拓展用户名', 'type' => 'string', 'example' => 'testUserName'],
'EstablishmentTime' => ['description' => '会话创建时间。', 'type' => 'string', 'example' => '2026-04-17T14:51:53Z'],
],
],
],
'RegionId' => ['description' => '地域', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
'TotalCount' => ['description' => '满足条件的记录总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '历史平均监控指标查询',
'summary' => '查询指定日期范围内桌面资源的历史平均监控指标。',
'description' => '## 请求说明'."\n"
.'- 本接口用于获取特定时间段内,根据给定的条件筛选出的桌面资源的历史平均监控指标。'."\n"
.'- `DataDate` 和 `EndDate` 参数定义了查询的时间范围,默认为前一天。'."\n"
.'- 支持通过桌面ID、名称等进行过滤,并且可以自定义数值区间来进一步细化查询结果。'."\n"
.'- 返回结果包括每个符合条件的桌面资源的详细信息及其对应的平均值。'."\n"
.'- 分页参数`PageNum`和`PageSize`允许用户控制返回的数据量,以适应不同的展示需求。'."\n"
.'- 注意:当使用`Ranges`参数时,请确保提供的区间合理,否则可能影响查询性能或导致无效的结果。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"269BDB16-2CD8-4865-84BD-11C40BC2****\\",\\n \\"AvgMetricList\\": [\\n {\\n \\"DesktopId\\": \\"ecd-bx9i0nsjd3zmibnzq\\",\\n \\"DesktopName\\": \\"C-051\\",\\n \\"DesktopGroupId\\": \\"dg-bogo95eob5avnis9k\\",\\n \\"MultiResource\\": true,\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"ManagementFlag\\": \\"0\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"DesktopType\\": \\"eds.enterprise_office.8c16g\\",\\n \\"Platform\\": \\"Winserver2025\\",\\n \\"SubPayType\\": \\"monthPackage\\",\\n \\"AvgValue\\": 20,\\n \\"Cpu\\": 4,\\n \\"GpuSpec\\": \\"0\\",\\n \\"Memory\\": 2048,\\n \\"EndUserIds\\": [\\n \\"testUser\\"\\n ],\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"testUser\\",\\n \\"NickName\\": \\"sz-sygc-07-03\\",\\n \\"ExternalUserName\\": \\"testUserName\\",\\n \\"EstablishmentTime\\": \\"2026-04-17T14:51:53Z\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"TotalCount\\": 20\\n}","type":"json"}]',
],
'QueryHistoryMetricDistribution' => [
'summary' => '查询指定时间段内特定指标的历史分布情况。',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '统计起始日期。格式“YYYY-MM-DD”默认值T-1。'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-04-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '统计结束日期。格式“YYYY-MM-DD”默认值T-1。'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-04-01'],
],
[
'name' => 'MetricName',
'in' => 'query',
'schema' => [
'description' => '监控指标类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SYSTEM_DISK_USAGE' => '系统盘使用率', 'LOAD_SCORE' => '健康分', 'GPU_USAGE' => 'GPU使用率', 'CPU_TOTAL_USAGE' => 'CPU使用率', 'MEMORY_USAGE' => '内存使用率', 'ROUND_TRIP_TIME' => '端到端延迟', 'TOTAL_DISK_USAGE' => '全部硬盘使用率', 'DATA_DISK_USAGE' => '数据盘使用率'],
'example' => 'LOAD_SCORE',
],
],
[
'name' => 'Ranges',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '自定义数值区间'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Label' => ['description' => '区间标签(用于返回值)'."\n", 'type' => 'string', 'required' => false, 'example' => 'label-02\''],
'Min' => ['description' => '最小值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0'],
'IncludeMin' => ['description' => '是否包含最小值,默认 true'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'Max' => ['description' => '最大值'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'],
'IncludeMax' => ['description' => '是否包含最大值,默认 false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回值对象'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID'."\n", 'type' => 'string', 'example' => '2F2BF549-CBD9-1FED-9ABB-086B62D7B293'],
'DistributionList' => [
'description' => '资源监控对应的分布列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Label' => ['description' => '区间标签'."\n", 'type' => 'string', 'example' => '2F2BF549-CBD9-1FED-9ABB-086B62D7B293'],
'Min' => ['description' => '最小值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0'],
'Max' => ['description' => '最大值'."\n", 'type' => 'number', 'format' => 'float', 'example' => '20'],
'Count' => ['description' => '数量', 'type' => 'integer', 'format' => 'int32', 'example' => '40'],
],
'description' => '',
],
],
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '94'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '历史指标分布查询',
'description' => '## 请求说明'."\n"
.'该API用于查询给定日期范围内,特定监控指标(如CPU使用率、内存使用量等)的数值分布情况。用户可以通过自定义数值区间来获取更详细的统计数据。支持企业版和商业版两种业务渠道,默认为T-1日的数据统计。'."\n"
."\n"
.'- **BusinessChannel**:默认为企业版,可选商业版。'."\n"
.'- **StartDate & EndDate**:默认值为T-1,即昨天的日期。格式必须为“YYYY-MM-DD”。'."\n"
.'- **MetricName**:需要查询的具体指标名称,请参照文档中提供的有效指标列表。'."\n"
.'- **Ranges**:允许用户自定义多个数值区间以进行更细致的数据分析。每个区间可以设置最小值、最大值以及是否包含边界值。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2F2BF549-CBD9-1FED-9ABB-086B62D7B293\\",\\n \\"DistributionList\\": [\\n {\\n \\"Label\\": \\"2F2BF549-CBD9-1FED-9ABB-086B62D7B293\\",\\n \\"Min\\": 0,\\n \\"Max\\": 20,\\n \\"Count\\": 40\\n }\\n ],\\n \\"TotalCount\\": 94\\n}","type":"json"}]',
],
'QueryHistoryUsageDurationRank' => [
'summary' => '按用户或桌面维度查询并排序历史使用时长。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '查询开始日期。格式:YYYY-MM-DD。最多支持查询 90 天数据'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2026-05-07'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '查询结束日期。格式:YYYY-MM-DD。最多支持查询 90 天数据'."\n", 'type' => 'string', 'required' => false, 'example' => '2026-04-19'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询结果数量。默认值为 5,最大为 200'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下次分页查询的 Token,从上一次返回结果中获取'."\n", 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => ['description' => '业务类型。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求 ID'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'TotalCount' => ['description' => '查询结果总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '94'],
'NextToken' => ['description' => '下次分页查询的 Token'."\n", 'type' => 'string', 'example' => 'AAAAAWvmfbFWy0uSlxZ6pIAKAnuwt1ezsRqxI6hPibm27fMH'],
'UsageDurationList' => [
'description' => '用户使用时长指标列表',
'type' => 'array',
'items' => [
'description' => '用户使用时长指标对象',
'type' => 'object',
'properties' => [
'EndUserId' => ['description' => '**终端用户 ID**', 'type' => 'string', 'example' => 'endUserId'],
'DesktopId' => ['description' => '**云电脑 ID**', 'type' => 'string', 'example' => 'ecd-8cndajrdrd424sb99'],
'DesktopName' => ['description' => '**云电脑名称**', 'type' => 'string', 'example' => 'TestName'],
'ChargeType' => ['description' => '**付费类型**。枚举值:`POST_PAID`(后付费)、`PRE_PAID`(预付费)、`MONTH_PACKAGE`(按月付费)、`DURATION`(时长包)', 'type' => 'string', 'example' => 'PrePaid'],
'UsageDuration' => ['description' => '**使用时长**,单位:秒。注意该值为 `Long` 类型,前端需注意精度转换', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shanghai'],
],
],
],
],
'description' => '',
],
],
],
'title' => '桌面历史使用时长排行榜查询',
'description' => '## 请求说明'."\n"
.'- **日期范围**:支持查询最多90天内的数据。'."\n"
.'- **分页查询**:通过`NextToken`参数实现分页,从上一次返回结果中获取。'."\n"
.'- **默认与最大限制**:默认返回5条记录,最大支持200条。'."\n"
.'- **鉴权方式**:使用AccessKey进行身份验证。'."\n"
.'- **调用方账号信息**:无需手动传入AliUid,系统将自动解析。'."\n"
.'- **计费情况**:此API调用免费。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TotalCount\\": 94,\\n \\"NextToken\\": \\"AAAAAWvmfbFWy0uSlxZ6pIAKAnuwt1ezsRqxI6hPibm27fMH\\",\\n \\"UsageDurationList\\": [\\n {\\n \\"EndUserId\\": \\"endUserId\\",\\n \\"DesktopId\\": \\"ecd-8cndajrdrd424sb99\\",\\n \\"DesktopName\\": \\"TestName\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"UsageDuration\\": 20000,\\n \\"RegionId\\": \\"cn-shanghai\\"\\n }\\n ]\\n}","type":"json"}]',
],
'RebootDesktops' => [
'summary' => '重启一台或者多台云电脑。',
'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' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => true,
'example' => 'ecd-gx2x1dhsmucyy****',
'maxItems' => 100,
],
],
[
'name' => 'OsUpdate',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'title' => '是否安装系统补丁', 'description' => '是否安装系统补丁'],
],
[
'name' => 'PatchId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '补丁ID', 'type' => 'string', 'example' => 'KB5082063'],
],
[
'name' => 'CreateSnapshot',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '是否创建快照', 'type' => 'boolean', 'default' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '重启一台或多台云电脑',
'description' => '云电脑的状态必须为运行中(Running)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:RebootDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 8F851208-C0EA-4CDD-9074-DBE70CB430DA\\r\\n","errorExample":""}]',
],
'RebuildDesktops' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1\\~20个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'],
'required' => true,
'example' => 'ecd-gx2x1dhsmucyy****',
'maxItems' => 100,
],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '变更后要使用的新镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'm-84mztzatmlnys****'],
],
[
'name' => 'OperateType',
'in' => 'query',
'schema' => [
'description' => '操作数据盘类型。'."\n"
."\n"
.'> 不论云电脑是否有数据盘,调用此接口默认都是不传入任何字段值。'."\n"
."\n"
.'- 若云电脑无数据盘: '."\n"
.' 传入任何字段都不会进行数据盘操作。'."\n"
.'- 若云电脑包含数据盘:'."\n"
.' 1. 当云电脑操作系统和目标镜像操作系统相同时:'."\n"
.' - 传入字段为`replace`时,替换云电脑的数据盘。'."\n"
.' - 不传入任何字段时,保留云电脑原来的数据盘。'."\n"
.' 2. 当云电脑操作系统和目标镜像操作系统不同时:'."\n"
.' - 传入字段为`replace`时,替换云电脑的数据盘。'."\n"
.' - 不传入任何字段时,清空云电脑数据盘。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'replace',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'description' => '操作系统语言。目前只支持系统镜像,并且Linux电脑仅支持选择英文。',
'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, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
'RebuildResults' => [
'description' => '重建结果的集合。',
'type' => 'array',
'items' => [
'description' => '重建结果。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '重建结果。返回`success`表示成功,否则将返回错误信息。', 'type' => 'string', 'example' => 'IncorrectDesktopStatus'],
'Message' => ['description' => '错误信息。当`Code`为`success`时,不返回该参数。', 'type' => 'string', 'example' => 'The current status of the desktop does not support this operation.'],
'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'],
],
],
],
],
],
],
],
'title' => '为云电脑变更镜像',
'summary' => '为一台或多台云电脑变更镜像。',
'description' => '变更镜像操作有以下限制:'."\n"
."\n"
.'- 中国香港和海外地域的云电脑不支持变更为另一种操作系统的镜像(例如从Windows镜像变更为Linux镜像)。'."\n"
.'- GPU镜像和非GPU镜像之间不支持互相变更,即图形型云电脑只能使用GPU镜像,非图形型云电脑只能使用非GPU镜像。'."\n"
."\n"
.'变更镜像后,系统将使用新的镜像来初始化云电脑的系统盘,相关影响如下:'."\n"
."\n"
.'- 原云电脑系统盘中的数据将被清除。基于原云电脑系统盘创建的快照将无法使用,系统将自动删除相关快照。'."\n"
.'- 如果变更了镜像的操作系统,则原云电脑数据盘中的数据将被清除,基于原云电脑数据盘创建的快照将无法使用,系统将自动删除相关快照;如果没有变更镜像的操作系统,则保留原云电脑数据盘中的数据,且相关快照仍可使用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => '- 若返回的状态码为`200`,`RebuildResults`中是各台云电脑是否开始重建,`Code`为`Success`的代表云电脑开始重建,否则代表云电脑重建失败的错误码。'."\n"
.'- 若返回的状态码为`4xx`,代表参数不符合预期,所有云电脑都没有开始重建。',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-09T09:54:57.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-17T13:00:04.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-02-05T08:09:24.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-04-25T03:53:45.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:42.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebuildDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:RebuildDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"RebuildResults\\": [\\n {\\n \\"Code\\": \\"IncorrectDesktopStatus\\",\\n \\"Message\\": \\"The current status of the desktop does not support this operation.\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n The current status of the desktop does not support this operation.\\n ecd-gx2x1dhsmucyy****\\n IncorrectDesktopStatus\\n \\n 484256DA-D816-44D2-9D86-B6EE4D5BA78C\\n","errorExample":""}]',
],
'RemoveFilePermission' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'FileId',
'in' => 'query',
'schema' => ['description' => '文件的ID。您可以调用[ListCdsFiles](~~2247622~~)接口查询对应文件的ID。', 'type' => 'string', 'required' => true, 'example' => '6333e553a133ce21e6f747cf948bb9ef95d7****'],
],
[
'name' => 'CdsId',
'in' => 'query',
'schema' => ['description' => '企业网盘ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+cds-066224****'],
],
[
'name' => 'MemberList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '授权用户列表。',
'type' => 'array',
'items' => [
'description' => '授权用户。',
'type' => 'object',
'properties' => [
'RoleId' => [
'description' => '目前支持两种方式设置权限,一种是通过指定角色设置权限,另一种是自定义设置操作权限,该字段用于指定角色设置权限,与`ActionList`互斥,当两个字段同时设置时,以该字段为准。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [
'SystemFileEditorWithoutShareLink' => '无分享编辑者。', 'SystemFileUploaderAndDownloaderWithShareLink' => '上传/下载/分享者。', 'SystemFileDownloader' => '下载者。', 'SystemFileEditorWithoutDelete' => '无删除编辑者。', 'SystemFileOwner' => '文件协同。', 'SystemFileDownloaderWithShareLink' => '下载/分享者。', 'SystemFileUploaderAndViewer' => '预览/上传者。', 'SystemFileViewer' => '预览者。', 'SystemFileEditor' => '编辑者。', 'SystemFileUploaderWithShareLink' => '上传/分享者。',
'SystemFileUploader' => '上传者。', 'SystemFileUploaderAndDownloader' => '上传/下载者。', 'SystemFileMetaViewer' => '可见列表。',
],
'example' => 'SystemFileUploaderAndDownloader',
],
'CdsIdentity' => [
'description' => '权限信息。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '用户ID或者群组ID。', 'type' => 'string', 'required' => true, 'example' => '249dsfseee643h33g3dv****'],
'Type' => [
'description' => '对象类型。',
'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' => '团队空间ID。', 'type' => 'string', 'required' => false, 'example' => 'cg-1fbmvrc7ug5m7****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\"\\n}","type":"json"}]',
'title' => '取消网盘文件夹共享',
'summary' => '将网盘内的文件夹取消共享。',
'changeSet' => [
['createdAt' => '2023-08-29T02:55:34.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveFilePermission'],
],
],
'ramActions' => [],
],
'RemoveUserFromDesktopGroup' => [
'summary' => '将共享型云电脑的指定授权用户移除出去。被移除的用户将无法再连接共享型云电脑内的云电脑。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '需移除授权用户的共享型云电脑ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'EndUserIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需移除的授权用户列表。',
'type' => 'array',
'items' => ['description' => '需移除的授权用户。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
'required' => false,
'maxItems' => 10000,
],
],
[
'name' => 'DesktopGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑ID列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'UserOuPath',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'UserGroupName',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'SimpleUserGroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'OrgId',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为共享型云电脑移除授权用户',
'changeSet' => [
['createdAt' => '2025-06-30T03:58:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-05-26T01:58:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-24T03:51:42.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-03-23T09:06:51.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveUserFromDesktopGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CFC74699-6F9C-5437-861A-D186E3347B7E\\n","errorExample":""}]',
],
'RenewDesktopGroup' => [
'summary' => '为包年包月共享型云电脑续费。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-7724r1jitbjzc****'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '续费时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1~5。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '续费时长的单位,即参数`Period`的单位。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单 [默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付'],
'example' => 'true',
],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => [
'description' => '是否自动续费。',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => '自动续费', 'false' => '不自动续费'],
'example' => 'false',
],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E55E6732-2028-52FA-AB06-EA29C36B****'],
'OrderId' => [
'description' => '订单ID列表。',
'type' => 'array',
'items' => ['description' => '订单ID。', 'type' => 'string', 'example' => '21455206303****'],
],
],
'description' => '',
],
],
],
'title' => '续费包年包月共享型云电脑',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktopGroup'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:RenewDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E55E6732-2028-52FA-AB06-EA29C36B****\\",\\n \\"OrderId\\": [\\n \\"21455206303****\\"\\n ]\\n}","type":"json"}]',
],
'RenewDesktops' => [
'summary' => '续费一台或者多台按月购买云电脑。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'none', 'riskType' => 'high', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '续费时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1~5。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '续费时长的单位,即参数`Period`的单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账号余额充足,否则会产生异常订单 [默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付'],
'example' => 'true',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。仅支持续费按月购买云电脑。',
'type' => 'array',
'items' => ['description' => '云电脑ID。仅支持续费按月购买云电脑。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
'required' => true,
'example' => 'ecd-ia2zw38bi6cm7****',
'maxItems' => 100,
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠活动ID。', 'type' => 'string', 'required' => false, 'example' => '50003098015****'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '> 此字段暂不对外开放使用。', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => ['description' => '是否自动续费。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '20844399755****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '续费按月购买云电脑',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-07-09T03:34:16.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-17T13:19:55.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-06-01T11:48:26.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-04-29T13:57:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktops'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20844399755****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB\\n 20844399755****\\n","errorExample":""}]',
],
'RenewNetworkPackages' => [
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '续费时长。取值范围由参数`PeriodUnit`的值决定。'."\n"
."\n"
.'- `PeriodUnit`为`Week`时,取值范围为:1。'."\n"
.'- `PeriodUnit`为`Month`时,取值范围为:1、2、3、6。'."\n"
.'- `PeriodUnit`为`Year`时,取值范围为:1、2、3。'."\n"
."\n"
.'默认值:1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'PeriodUnit',
'in' => 'query',
'schema' => [
'description' => '续费时长单位。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Month' => '月 [默认值]', 'Year' => '年', 'Week' => '周'],
'example' => 'Month',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否自动支付。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['true' => '自动支付。请确保账户余额充足,否则会产生异常订单。[默认值]', 'false' => '只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。'],
'example' => 'true',
],
],
[
'name' => 'NetworkPackageId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '公网精品带宽ID列表。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '公网精品带宽ID。', 'type' => 'string', 'required' => false, 'example' => 'np-jc31jdxfdydr1****'],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'PromotionId',
'in' => 'query',
'schema' => ['description' => '优惠ID。', 'type' => 'string', 'required' => false, 'example' => '500038360030606'],
],
[
'name' => 'ResellerOwnerUid',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
[
'name' => 'AutoRenew',
'in' => 'query',
'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '214726268900640'],
'RequestId' => ['description' => '请求ID。', '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.', 'description' => '您选择的资源存在未支付订单,请支付或作废后再下单!'],
['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '用户无权对指定资源进行操作'],
],
500 => [
['errorCode' => 'InternalError', 'errorMessage' => 'The request processing has failed due to some unknown error, exception or failure.', 'description' => '服务内部异常,请稍候重试。'],
],
],
'title' => '续费包年包月公网精品带宽',
'summary' => '为包年包月公网精品带宽续费。',
'changeSet' => [
['createdAt' => '2025-04-28T03:45:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-03-03T16:09:48.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2025-02-14T06:20:11.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-11-26T04:03:12.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-11-26T04:03:12.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewNetworkPackages'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"OrderId\\": \\"214726268900640\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ResetDesktops' => [
'summary' => '重置共享型云电脑内的云电脑。',
'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' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。'."\n"
."\n"
.'- 如果传入了`DesktopId`,则忽略该`DesktopGroupId`。'."\n"
.'- 如果`DesktopId`为空,则会根据`DesktopGroupId`去获取该共享型云电脑内所有云电脑的`DesktopId`。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dg-07if7qsxoxkb6****'],
],
[
'name' => 'PayType',
'in' => 'query',
'schema' => [
'description' => '付费类型。'."\n"
.'> 仅对重置共享型云电脑有效,为空则重置共享型云电脑下所有付费类型的云电脑。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'],
'example' => 'PrePaid',
],
],
[
'name' => 'ResetType',
'in' => 'query',
'schema' => [
'description' => '重置类型,决定是否重置,以及要重置的磁盘范围。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['不重置', '仅重置系统盘', '仅重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '1',
],
],
[
'name' => 'ImageId',
'in' => 'query',
'schema' => ['description' => '镜像ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'm-4zfb6zj728hhr****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑 ID 列表。可设置 1~100 个。',
'type' => 'array',
'items' => ['description' => '云电脑 ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-07if7qsxoxkb3****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DesktopGroupIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '共享型云电脑 ID 列表。',
'type' => 'array',
'items' => ['description' => '共享型云电脑 ID。', 'type' => 'string', 'required' => false, 'example' => 'dg-kadkdfaf****'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'ResetScope',
'in' => 'query',
'schema' => [
'description' => '重置范围,可以通过配置参数来设置是重置镜像还是重置云电脑。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['ALL' => '重置镜像及云电脑 [默认值]', 'IMAGE' => '仅重置镜像'],
'example' => 'ALL',
],
],
[
'name' => 'LastRetryTime',
'in' => 'query',
'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '重置共享型云电脑',
'description' => '> 本接口仅适用于重置共享型云电脑(即共享型云电脑内的云电脑),不支持重置普通云电脑。',
'changeSet' => [
['createdAt' => '2024-03-13T02:47:25.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-05-26T11:37:50.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDesktops'],
],
],
'ramActions' => [],
],
'ResetNASDefaultMountTarget' => [
'summary' => '重置NAS文件系统的挂载点。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'FileSystemId',
'in' => 'query',
'schema' => ['description' => 'NAS文件系统ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3a6ef4****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '重置NAS文件系统的挂载点',
'description' => '创建NAS文件系统时,系统将自动生成一个挂载点。默认情况下,该挂载点无需修改,如果该挂载点处于未激活状态,您需要重置NAS文件系统的挂载点。',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetNASDefaultMountTarget'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ResetNASDefaultMountTarget',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'ResetSnapshot' => [
'summary' => '恢复快照对应的磁盘数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '地域。', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hzngahou'],
],
[
'name' => 'SnapshotId',
'in' => 'query',
'schema' => ['title' => '快照ID。', 'description' => '用来恢复磁盘数据的快照ID。', 'type' => 'string', 'required' => true, 'example' => 's-2zeipxmnhej803x7****'],
],
[
'name' => 'StopDesktop',
'in' => 'query',
'schema' => ['title' => '是否关机并恢复快照。', 'description' => '是否关机并恢复快照。', 'type' => 'boolean', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '恢复快照对应的磁盘数据',
'description' => '调用该接口时,请您确保:'."\n"
."\n"
.'- 磁盘中需要保存的数据已备份。'."\n"
.' > 恢复数据是不可逆操作。调用该接口后,磁盘将恢复到快照创建时间点对应的状态,从快照创建时间到当前时间之间的数据将会丢失,请务必做好重要数据的备份。'."\n"
."\n"
.'- 磁盘所属的云电脑已关机。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-09-09T06:00:55.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSnapshot'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ResetSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'RevokeCoordinatePrivilege' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => '设备的UUID(设备唯一标识)。', 'type' => 'string', 'required' => false, 'example' => 'C78CA9E99315687575DD2844C1F3****'],
],
[
'name' => 'EndUserId',
'in' => 'query',
'schema' => ['description' => '终端用户的用户名。', 'type' => 'string', 'required' => false, 'example' => 'zhangsan'],
],
[
'name' => 'CoId',
'in' => 'query',
'schema' => ['description' => '协同流ID。来自接口[ApplyCoordinationForMonitoring](~~ApplyCoordinationForMonitoring~~)返回的`Coid`。', 'type' => 'string', 'required' => true, 'example' => 'co-fqsm6e8ee75w61fp9'],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => [
'description' => '协同用户类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['TENANT_ADMIN' => '租户管理员'],
'example' => 'TENANT_ADMIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
'title' => '取消流协同操作权限',
'summary' => '取消流协同操作权限。',
'changeSet' => [
['createdAt' => '2022-09-16T02:33:57.000Z', 'description' => 'OpenAPI 下线'],
['createdAt' => '2022-09-16T02:33:57.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeCoordinatePrivilege'],
],
],
'ramActions' => [],
],
'RunCommand' => [
'summary' => '在一台或多台Windows操作系统的云电脑中执行一段PowerShell或者Bat类型的脚本。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '运维脚本的语言类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['RunPowerShellScript' => '运行PowerShell脚本', 'RunBatScript' => '运行Bat脚本'],
'example' => 'RunPowerShellScript',
],
],
[
'name' => 'CommandContent',
'in' => 'query',
'schema' => ['description' => '脚本的明文内容或者Base64编码后的内容。 '."\n"
.'脚本内容Base64编码后不能超过16 KB。'."\n"
."\n"
.'> 若为Base64编码后的脚本内容,则参数ContentEncoding必须配置为Base64。', 'type' => 'string', 'required' => true, 'example' => 'ipconfig'],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => ['description' => '执行脚本的超时时间,单位为秒。默认值:300。 '."\n"
.'当因为进程原因、缺失模块、缺失云助手客户端等原因无法运行脚本时,会出现超时现象。超时后,会强制终止脚本进程。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3600'],
],
[
'name' => 'ContentEncoding',
'in' => 'query',
'schema' => [
'description' => '脚本内容的编码方式。'."\n"
."\n"
.'> 若传入的值不在枚举值范围内,则一律作为传入`PlainText`处理。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Base64' => 'Base64编码', 'PlainText' => '不编码,采用明文传输 [默认值]'],
'example' => 'Base64',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID列表。N的取值范围:1\\~50。 '."\n"
.'如果指定了多台云电脑,只要有一台云电脑可以成功执行脚本,该API就能调用成功。当指定的多台云电脑均无法执行脚本时,您需要重新设置该参数。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'],
'required' => true,
'maxItems' => 300,
],
],
[
'name' => 'EndUserId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '终端用户的ID,若此参数不为空,则会以终端用户的权限执行命令。'."\n"
."\n"
.'> 该用户需要在云电脑上存在会话记录(云电脑开机后有过登录及连接行为,且连接时未被其他用户抢占)。Linux云电脑不支持该参数。', 'type' => 'string', 'required' => false, 'example' => 'alice'],
],
[
'name' => 'CommandRole',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'InvokeId' => ['description' => '脚本执行ID。可以调用[DescribeInvocations](~~DescribeInvocations~~)并传入该值来查询脚本执行状态。', 'type' => 'string', 'example' => 't-hz01qgsqj2n****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '在云电脑中执行脚本',
'changeSet' => [
['createdAt' => '2025-07-01T03:13:43.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-08-13T06:29:27.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-09-29T06:07:14.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:41.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:RunCommand',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeId\\": \\"t-hz01qgsqj2n****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'SendVerifyCode' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'VerifyCodeAction',
'in' => 'query',
'schema' => [
'description' => '验证码对应的动作。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['eds_cenID_securityverification' => '用于验证云企业网CEN'],
'example' => 'eds_cenID_securityverification',
],
],
[
'name' => 'ExtraInfo',
'in' => 'query',
'schema' => ['description' => '发送验证码所需的相关信息,为JSON格式。验证云企业网CEN时,需提供云企业实例ID及其所属的阿里云账号ID。'."\n"
.'- CenId:云企业网实例ID。 '."\n"
.'- CenOwnerId:云企业网实例所属的阿里云账号ID。 '."\n"
."\n"
.'> 如果配置的CenId属于本阿里云账号,该参数无需配置。 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"cenOwnerId": 1234567890******,"cenId": "cen-3weq30r6t0s7t4****"}'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '获取加入其他账号云企业网实例的验证码',
'summary' => '将高级办公网络加入其他阿里云账号下的云企业网实例时,需要调用此接口获取验证码。',
'description' => '将高级办公网络加入到其他阿里云账号下的云企业网实例中时,需要先调用本接口获取验证码。调用成功后,系统将发送验证码到该阿里云账号关联的手机。'."\n"
."\n"
.'将高级办公网络加入到其他阿里云账号下的云企业网实例中时,需要先调用本接口获取验证码。调用成功后,系统将发送验证码到该阿里云账号关联的邮箱。',
'changeSet' => [
['createdAt' => '2021-10-28T07:27:59.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SendVerifyCode'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:SendVerifyCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'SetDesktopGroupScaleTimer' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '云电脑池ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-2i8qxpv6t1a03****'],
],
[
'name' => 'ScaleTimerInfos',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '自动扩缩的定时任务信息列表。',
'type' => 'array',
'items' => [
'description' => '自动扩缩的定时任务信息。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '策略类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['drop' => '下降策略', 'normal' => '正常策略', 'peak' => '高峰策略', 'rise' => '上升策略'],
'example' => 'rise',
],
'RatioThreshold' => ['description' => '会话占用率阈值,用作多会话云电脑池的自动伸缩触发条件。会话占用率的计算公式为:'."\n"
."\n"
.'```会话占用率 = 已绑定会话数 / (云电脑资源总数 × 每台云电脑支持的最大会话数) × 100%```'."\n"
."\n"
.'当会话占用率达到该阈值时,则会新建云电脑;未达到该阈值时,则删除多余的云电脑。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.85'],
'KeepDuration' => ['description' => '会话断开连接后继续保留的时间。单位为毫秒,取值范围为180000(3分钟)~345600000(4天)。取值为0时,表示始终保留。'."\n"
."\n"
.'当会话因为用户主动断开或因为其他因素意外断开时,从断开的时刻开始计算,若在该保留时长内用户始终未重新建立与该会话的连接,则该会话注销,未保存的数据都将销毁;若在该保留时长内,用户重新建立连接成功,则仍可进入原来的会话,仍可访问对话断开之前的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '180000'],
'BuyResAmount' => ['description' => '伸缩策略参数之一:购买云电脑数。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
'MinResAmount' => ['description' => '伸缩策略参数之一:云电脑最小数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
'MaxResAmount' => ['description' => '伸缩策略参数之一:云电脑最大数量。取值范围:0~200。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
'Cron' => ['description' => '触发时间的Cron表达式。', 'type' => 'string', 'required' => false, 'example' => '0 0 12 ? * 1'],
'LoadPolicy' => [
'description' => '多会话云电脑池的负载均衡策略。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'enumValueTitles' => ['深度优先', '广度优先'],
'example' => '0',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为多会话云电脑设置自动扩缩策略',
'summary' => '为多会话云电脑设置自动扩缩策略。多会话云电脑允许多个用户同时连接同一台云电脑,可节省成本。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupScaleTimer'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetDesktopGroupScaleTimer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'SetDesktopGroupTimer' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-dbdkfmh883****'],
],
[
'name' => 'TimerType',
'in' => 'query',
'schema' => [
'description' => '定时任务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [1 => '定时重置', '定时开机', '定时关机', '定时重启'],
'example' => '1',
],
],
[
'name' => 'CronExpression',
'in' => 'query',
'schema' => ['description' => '定时任务Cron表达式。当`TimerType`设为2、3、4时为必填参数。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0 0 9 * * ?'],
],
[
'name' => 'ResetType',
'in' => 'query',
'schema' => [
'description' => '重置类型。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['不重置', '只重置系统盘', '只重置用户磁盘', '重置系统盘和用户磁盘'],
'example' => '1',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => ['description' => '是否强制执行。', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '388CF76E-FFB3-5174-9F91-CDD****'],
],
],
],
],
'title' => '设置共享型云电脑定时任务',
'summary' => '设置共享型云电脑定时任务,执行定时开机、关机、重启或重置任务。',
'changeSet' => [
['createdAt' => '2024-02-04T08:49:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-01-11T08:21:03.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimer'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"388CF76E-FFB3-5174-9F91-CDD****\\"\\n}","type":"json"}]',
],
'SetDesktopGroupTimerStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopGroupId',
'in' => 'query',
'schema' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dg-fgxsniu6at****'],
],
[
'name' => 'TimerType',
'in' => 'query',
'schema' => [
'description' => '定时任务类型。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [1 => '定时重置', '定时开机', '定时关机', '定时重启'],
'example' => '1',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '定时任务状态。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'enumValueTitles' => [1 => '启用', '禁用', '删除', 100 => '未知状态'],
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AC7912E7-8BDF-547F-BCAC****'],
],
],
],
],
'title' => '设置共享型云电脑定时任务的状态',
'summary' => '设置共享型云电脑定时任务的状态,例如将定时任务设为启用或禁用。',
'changeSet' => [
['createdAt' => '2024-02-04T08:49:54.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2023-01-11T08:21:03.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimerStatus'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC7912E7-8BDF-547F-BCAC****\\"\\n}","type":"json"}]',
],
'SetDesktopMaintenance' => [
'summary' => '设置云电脑维护模式。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Mode',
'in' => 'query',
'schema' => [
'description' => '进入或退出云电脑维护模式。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ENTER' => '进入维护模式', 'EXIT' => '退出维护模式'],
'example' => 'enter',
],
],
[
'name' => 'DesktopIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要设置维护模式的云电脑ID列表。最多支持100个云电脑ID。',
'type' => 'array',
'items' => ['description' => '要设置维护模式的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-dzeotbgawdnfo****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA6A1853-3EA9-5EEB-86C8-3D14A3E01905'],
],
'description' => '',
],
],
],
'title' => '设置云电脑维护模式',
'description' => '如果您需要对云电脑进行一些维护操作,并希望在此期间禁止终端用户连接和使用该云电脑,您可以将其切换为维护模式。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopMaintenance'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA6A1853-3EA9-5EEB-86C8-3D14A3E01905\\"\\n}","type":"json"}]',
],
'SetDirectorySsoStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => 'AD办公网络ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-h95efs1mbukd9****'],
],
[
'name' => 'EnableSso',
'in' => 'query',
'schema' => [
'description' => '开启或者关闭单点登录SSO。',
'type' => 'boolean',
'required' => true,
'enumValueTitles' => ['true' => '开启SSO', 'false' => '关闭SSO'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '设置AD办公网络的单点登录SSO开关状态',
'summary' => '为基于AD账号的办公网络开启或关闭单点登录SSO功能。',
'description' => '作用与接口[SetOfficeSiteSsoStatus](~~SetOfficeSiteSsoStatus~~)相同,建议使用`SetOfficeSiteSsoStatus`接口。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDirectorySsoStatus'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:SetDirectorySsoStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n AF5539DC-F0CE-4F04-A8BC-50B65F86FE61\\r\\n","errorExample":""}]',
],
'SetIdpMetadata' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DirectoryId',
'in' => 'query',
'schema' => ['description' => '办公网络ID,与`OfficeSiteId`含义相同。建议停止使用`DirectoryId`,改为使用`OfficeSiteId`。`DirectoryId`和`OfficeSiteId`只能填写一个,不可同时填写。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-400695****'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-400695****'],
],
[
'name' => 'IdpMetadata',
'in' => 'query',
'schema' => ['description' => '身份提供商IdP的元数据。', 'type' => 'string', 'required' => true, 'example' => '<EntityDescriptor ID********Descriptor>'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'IdpEntityId' => ['description' => 'IdP元数据文件解析后获得的entityID值。', 'type' => 'string', 'example' => 'http://test****.cn/adfs/services/trust'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '上传身份提供商元数据',
'summary' => '上传基于SAML 2.0的身份提供商IdP(Identity Provider)的元数据。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetIdpMetadata'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IdpEntityId\\": \\"http://test****.cn/adfs/services/trust\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F369A091-002F-49C8-AD55-02A776297C7B\\n http://test****.cn/adfs/services/trust\\n","errorExample":""}]',
],
'SetOfficeSiteSsoStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OfficeSiteId',
'in' => 'query',
'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou+dir-363353****'],
],
[
'name' => 'EnableSso',
'in' => 'query',
'schema' => [
'description' => '开启或者关闭单点登录SSO。',
'type' => 'boolean',
'required' => true,
'enumValueTitles' => ['true' => '开启SSO', 'false' => '关闭SSO'],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '设置办公网络的单点登录SSO开关状态',
'summary' => '为办公网络开启或关闭单点登录SSO功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-07-07T06:14:54.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetOfficeSiteSsoStatus'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 5CC5E450-FC43-4F5B-B540-9964BD313427\\r\\n","errorExample":""}]',
],
'StartDesktops' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'],
'required' => true,
'example' => 'ecd-7w78ozhjcwa3u****',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '启动一台或者多台已停止的云电脑',
'summary' => '启动一台或者多台已停止的云电脑。接口调用成功后,云电脑进入运行中状态。',
'description' => '云电脑的状态必须为已停止(Stopped)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDesktops'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53\\r\\n","errorExample":""}]',
],
'StopDesktops' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'StoppedMode',
'in' => 'query',
'schema' => [
'description' => '关机后的计费模式。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['StopCharging' => '关机后系统将自动回收计算资源,计算资源不再计费,但存储资源仍正常计费。[默认值]', 'KeepCharging' => '关机后系统不回收资源,避免因为库存不足导致无法启动,仍正常收取费用。'],
'example' => 'StopCharging',
],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'],
'required' => true,
'example' => 'ecd-7w78ozhjcwa3u****',
'maxItems' => 100,
],
],
[
'name' => 'OsUpdate',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '在更新已就绪的前提下,是否执行补丁更新。为true表示执行补丁更新。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'PatchId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['type' => 'string', 'example' => 'KB5082063'],
],
[
'name' => 'CreateSnapshot',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['type' => 'string', 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '停止一台或者多台运行中的云电脑',
'summary' => '停止一台或者多台运行中的云电脑。接口调用成功后,云电脑进入已停止状态。',
'description' => '云电脑的状态必须为运行中(Running)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-03-18T06:39:50.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDesktops'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:StopDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53\\r\\n","errorExample":""}]',
],
'StopInvocation' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InvokeId',
'in' => 'query',
'schema' => ['description' => '脚本进程执行ID。取自[RunCommand](~~RunCommand~~)的返回参数。', 'type' => 'string', 'required' => true, 'example' => 't-hz059ngm63k****'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '要停止执行脚本的云电脑ID列表。N的取值范围:1\\~50。',
'type' => 'array',
'items' => ['description' => '要停止执行脚本的云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'],
'required' => false,
'example' => 'ecd-7w78ozhjcwa3u****',
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '停止脚本执行',
'summary' => '停止一台或多台云电脑中的一条执行中云助手脚本的进程。',
'description' => '停止单次脚本进程后,已经开始执行脚本的云电脑会继续执行,未开始执行脚本的云电脑将不再执行。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInvocation'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:StopInvocation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n F5F82BA8-92FE-49E4-AEB9-9010CE7329F3\\r\\n","errorExample":""}]',
],
'TagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => '云电脑'],
'example' => 'ALIYUN::GWS::INSTANCE',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即云电脑ID列表。可包含1\\~50个。',
'type' => 'array',
'items' => ['description' => '资源ID,即云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
'required' => true,
'example' => 'ecd-ia2zw38bi6cm7****',
'maxItems' => 100,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。可包含1\\~20个。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '标签键。一旦传入该值,则不允许为空字符串。最多支持128个字符,不能以`aliyun`和`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'Value' => ['description' => '标签值。可以为空字符串。最多支持128个字符,不能以`acs:`开头,不能包含`http://`或者`https://`。', 'type' => 'string', 'required' => false, 'example' => 'design'],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为云电脑添加标签',
'summary' => '为指定的云电脑添加标签,方便通过标签统一筛选和管理云电脑。',
'description' => '如果设置的标签键(TagKey)已存在,则新设置的TagValue将覆盖原有TagValue。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-04-17T08:21:10.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]',
],
'TransferTaskApprovalCallback' => [
'summary' => '提交文件传输审批结果。',
'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' => '传输任务ID。', 'type' => 'string', 'required' => false, 'example' => 'trt-msndfksm18fs****'],
],
[
'name' => 'Result',
'in' => 'query',
'schema' => [
'description' => '审批结果。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Approved' => '审批通过', 'Rejected' => '审批拒绝'],
'example' => 'Approved',
],
],
[
'name' => 'OssBucketRegionId',
'in' => 'query',
'schema' => ['description' => '文件所在bucket地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OssBucketName',
'in' => 'query',
'schema' => ['description' => '文件所在bucket名称。', 'type' => 'string', 'required' => false, 'example' => 'ed****-17337752804***'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据结构。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AE7B699F-625C-587E-BC5F-1395CA****'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE7B699F-625C-587E-BC5F-1395CA****\\"\\n}","type":"json"}]',
'title' => '提交文件传输审批结果',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UnbindConfigGroup' => [
'summary' => '将绑定在资源上的配置组解绑。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。该功能无地域属性,该字段固定填写`cn-shanghai`。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解绑的配置组类型。',
'type' => 'string',
'required' => true,
'enumValueTitles' => ['Timer' => '定时任务'],
'example' => 'Timer',
],
],
[
'name' => 'ResourceInfos',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要解绑的资源信息。',
'type' => 'array',
'items' => [
'description' => '资源信息。',
'type' => 'object',
'properties' => [
'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ctwj0bk3l5nz****'],
'ResourceRegionId' => ['description' => '资源所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-chengdu'],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['RESOURCE_GROUP' => '资源组', 'CLOUD_DESKTOP' => '云电脑'],
'example' => 'CLOUD_DESKTOP',
],
'ProductType' => [
'description' => '资源所属的产品类型。',
'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' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'AD0FF13D-FC7D-56AD-934F-91C8487*****'],
'GroupIds' => [
'description' => '解绑的配置组ID列表。',
'type' => 'array',
'items' => ['description' => '配置组ID。', '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' => '解绑配置组',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'UnlockVirtualMFADevice' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => ['description' => '虚拟MFA设备的序列号,也是其唯一标识。您可以调用[DescribeVirtualMFADevices](~~DescribeVirtualMFADevices~~)查询AD账号绑定的虚拟MFA设备序列号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a25f297f-f2e1-4a44-bbf1-5f48a6e5****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '解锁虚拟MFA设备',
'summary' => '解锁处于锁定(LOCKED)状态的虚拟MFA设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnlockVirtualMFADevice'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'ecd:UnlockVirtualMFADevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FB550AAB-FB36-4A91-93F6-F4374AF65403\\r\\n","errorExample":""}]',
],
'UntagResources' => [
'summary' => '为云电脑移除标签。移除标签后,如果该标签没有被添加到任何云电脑上,则标签会被自动删除。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['ALIYUN::GWS::INSTANCE' => '云电脑'],
'example' => 'ALIYUN::GWS::INSTANCE',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => '是否解绑资源上的所有标签。仅当未设置TagKey.N时,该参数生效。默认为false。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即云电脑ID列表。可包含1\\~50个。',
'type' => 'array',
'items' => ['description' => '资源ID,即云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-ia2zw38bi6cm7****'],
'required' => true,
'example' => 'ecd-ia2zw38bi6cm7****',
'maxItems' => 50,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键。可包含1\\~20个。',
'type' => 'array',
'items' => ['description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'department'],
'required' => false,
'example' => 'TestKey',
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为云电脑移除标签',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-08-19T08:14:40.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 3EB7FCEE-D731-4948-85A3-4B2C341CA983\\r\\n","errorExample":""}]',
],
'UpdateFotaTask' => [
'summary' => '为镜像升级任务打开或关闭自动推送。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'TaskUid',
'in' => 'query',
'schema' => ['description' => '镜像升级任务的信息。可调用[DescribeFotaTasks](~~437001~~)获取该参数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aot-c4khwrp9ocml4****'],
],
[
'name' => 'UserStatus',
'in' => 'query',
'schema' => [
'description' => '设置镜像升级任务是否自动推送。',
'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' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'],
],
],
],
],
'title' => '为镜像升级任务打开或关闭自动推送',
'description' => '本接口用于控制每个镜像升级任务的独立开关,仅当镜像升级功能模块的全局自动升级开关被关闭时生效。若全局自动升级开关被打开,则每个镜像升级任务的开关均始终保持打开。如需打开或关闭该全局自动升级开关,请前往无影云电脑控制台的**运维\\>镜像升级**页面。',
'changeSet' => [
['createdAt' => '2024-03-25T11:43:53.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-03-15T14:44:18.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFotaTask'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:UpdateFotaTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]',
],
'UploadImage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OssObjectPath',
'in' => 'query',
'schema' => ['description' => '镜像文件的OSS Object路径。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://ossbucket:endpoint/object'],
],
[
'name' => 'ImageName',
'in' => 'query',
'schema' => ['description' => '镜像名称。长度为2\\~128个英文或中文字符。必须以大小写字母或中文开头,不能以`http://`和`https://`开头。可以包含数字、半角冒号(:)、下划线(\\_)或者短划线(-)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Win10_Test'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => '镜像的描述信息。长度为2\\~256个英文或中文字符,不能以`http://`和`https://`开头。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test description'],
],
[
'name' => 'OsType',
'in' => 'query',
'schema' => [
'description' => '操作系统类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'],
'example' => 'Windows',
],
],
[
'name' => 'GpuCategory',
'in' => 'query',
'schema' => ['description' => '是否为GPU类型镜像。', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'example' => 'true'],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '协议类型。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'enumValueTitles' => ['ASP' => '阿里云自研ASP协议'],
'example' => 'ASP',
],
],
[
'name' => 'DataDiskSize',
'in' => 'query',
'schema' => ['description' => '数据盘大小,取值范围:80~500。单位:GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '500', 'minimum' => '5', 'example' => '80'],
],
[
'name' => 'GpuDriverType',
'in' => 'query',
'schema' => [
'description' => '预装的GPU驱动类型。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['gpu_grid9' => '可用于图形型4vCPU-23GiB内存-4GiB显存和图形型10vCPU-46GiB内存-8GiB显存这两个规格的云电脑上。', 'gpu_custom' => '用户后续自行安装驱动。', 'gpu_grid12' => '可用于除了图形型4vCPU-23GiB内存-4GiB显存和图形型10vCPU-46GiB内存-8GiB显存这两个规格之外的图形型云电脑上。'],
'example' => 'gpu_grid9',
],
],
[
'name' => 'LicenseType',
'in' => 'query',
'schema' => [
'description' => '导入镜像后,激活操作系统采用的许可证类型。取值范围:'."\n"
."\n"
.'- Auto:由阿里云检测源操作系统并分配许可证。自动模式下,系统优先搜索您设置的`Platform`是否有阿里云官方渠道的许可证并分配给导入的镜像,如果缺乏该类许可,会切换成BYOL(Bring Your Own License)方式。'."\n"
.'- Aliyun:根据您设置的`Platform`采用阿里云官方渠道的许可证。'."\n"
.'- BYOL:源操作系统自带的许可证。采用BYOL时,您必须确保您的许可证密钥支持在阿里云使用。'."\n"
."\n"
.'默认值:Auto'."\n"
."\n"
.'> Windows 10等系统无法通过阿里云激活,请将`LicenseType`设为自定义激活(BYOL)。'."\n"
."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Auto' => '由阿里云检测源操作系统并分配许可证。自动模式下,系统优先搜索您设置的Platform是否有阿里云官方渠道的许可证并分配给导入的镜像,如果缺乏该类许可,会切换成BYOL(Bring Your Own License)方式。', 'Aliyun' => '根据您设置的Platform采用阿里云官方渠道的许可证。', 'BYOL' => '源操作系统自带的许可证。采用BYOL时,您必须确保您的许可证密钥支持在阿里云使用。'],
'example' => 'Auto',
],
],
[
'name' => 'EnableSecurityCheck',
'in' => 'query',
'schema' => ['description' => '是否开启安全检查。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SystemDiskSize',
'in' => 'query',
'schema' => ['description' => '系统盘大小,单位:GiB。'."\n"
."\n"
.'> 系统盘大小不能小于镜像文件。', 'type' => 'string', 'required' => false, 'example' => '80'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-d4dwr5tgrgvd****'],
'RequestId' => ['description' => '请求ID。', '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' => '上传自定义Windows镜像',
'summary' => '上传用户的自定义Windows镜像。',
'description' => '> 仅支持上传Windows操作系统的镜像。',
'changeSet' => [
['createdAt' => '2024-11-09T02:21:46.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-06-01T06:27:18.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-02-24T10:07:21.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadImage'],
],
],
'ramActions' => [],
],
'VerifyCen' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'CenId',
'in' => 'query',
'schema' => ['description' => '云企业网实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cen-3gwy16dojz1m65****'],
],
[
'name' => 'CenOwnerId',
'in' => 'query',
'schema' => ['description' => '云企业实例所属的阿里云账号ID。'."\n"
."\n"
.'- 如果配置的CenId属于本阿里云账号,该参数无需配置。'."\n"
."\n"
.'- 如果配置的CenId属于其他阿里云账号,请填写所属阿里云账号的ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '102681951715****'],
],
[
'name' => 'CidrBlock',
'in' => 'query',
'schema' => ['description' => '办公网络对应的IPv4网段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.168.0.0/16'],
],
[
'name' => 'VerifyCode',
'in' => 'query',
'schema' => ['description' => '验证码。如果配置的CenId属于其他阿里云账号,必须先调用[SendVerifyCode](~~436847~~)获取验证码。', 'type' => 'string', 'required' => false, 'example' => '12****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '网段冲突校验的结果。',
'type' => 'string',
'enumValueTitles' => ['InvalidCen.CenUidInvalid' => '阿里云账号错误或者该阿里云账号没有访问云电脑服务的权限。', 'VerifyCode.InvalidTokenCode' => '验证码错误。', 'VerifyCode.ReachTokenRetryTime' => '验证码达到重试次数上限。', 'Conflict' => '存在网段冲突。至少有一条路由的校验结果为Conflict。', 'Access' => '校验通过。所有路由的校验结果均为Access。', 'InvalidCen.ParameterCenInstanceId' => '云企业网实例ID与所属阿里云账号ID配置错误,阿里云账号下未包含配置的云企业网实例。'],
'example' => 'Access',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0AF9D857-AE96-53D6-B317-5DD665EC4EC0'],
'CidrBlocks' => [
'description' => '推荐使用的IPv4网段,随机推荐三个网段。当`Status`为`Conflict`时,返回该参数。',
'type' => 'array',
'items' => ['description' => '推荐使用的IPv4网段,随机推荐三个网段。当`Status`为`Conflict`时,返回该参数。', 'type' => 'string', 'example' => ' ["10.0.XX.XX","172.24.XX.XX","192.168.XX.XX"]'],
],
'RouteEntries' => [
'description' => '云企业网实例包含的路由信息列表。',
'type' => 'array',
'items' => [
'description' => '云企业网实例包含的路由信息。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '路由校验结果。',
'type' => 'string',
'enumValueTitles' => ['Conflict' => '存在网段冲突', 'Access' => '校验通过'],
'example' => 'Access',
],
'NextHopInstanceId' => ['description' => '路由对应的网络实例ID。', 'type' => 'string', 'example' => 'vpc-uf62bu0xs5j8md54p****'],
'DestinationCidrBlock' => ['description' => '路由网段。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'RegionId' => ['description' => '路由所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'TransitRouterService.TrNotExistInRegion', 'errorMessage' => 'The transit router need create in current region.', 'description' => '云企业网中不存在当前地域的转发路由器,请去云企业网控制台新建。'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '校验云企业网',
'summary' => '校验云企业网实例ID与所属阿里云账号ID是否正确,以及实例路由与办公网络IPv4网段是否存在网段冲突。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-09-23T07:04:51.000Z', 'description' => '错误码发生变更'],
['createdAt' => '2021-10-28T07:27:58.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyCen'],
],
],
'ramActions' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Access\\",\\n \\"RequestId\\": \\"0AF9D857-AE96-53D6-B317-5DD665EC4EC0\\",\\n \\"CidrBlocks\\": [\\n \\" [\\\\\\"10.0.XX.XX\\\\\\",\\\\\\"172.24.XX.XX\\\\\\",\\\\\\"192.168.XX.XX\\\\\\"]\\"\\n ],\\n \\"RouteEntries\\": [\\n {\\n \\"Status\\": \\"Access\\",\\n \\"NextHopInstanceId\\": \\"vpc-uf62bu0xs5j8md54p****\\",\\n \\"DestinationCidrBlock\\": \\"172.16.XX.XX\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n Access\\n \\n Access\\n 100.64.X.X/10\\n cn-shanghai\\n \\n \\n Access\\n 172.16.111.0/27\\n cn-shanghai\\n vpc-uf62bu0xs5j8md54****\\n \\n \\n Access\\n 192.168.0.0/24\\n cn-shanghai\\n vpc-uf6n17kvw0t15br3s****\\n \\n 06D87278-F765-5FC9-9978-ADD7DC070C7D\\n","errorExample":""}]',
],
'WakeupDesktops' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~DescribeRegions~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DesktopId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云电脑ID。可设置1~100个。',
'type' => 'array',
'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-j2eoqgf5u4mwj****'],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息集合。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '6557DBA9-CF3E-5C1B-B1F1-68FDA599****'],
],
],
],
],
'title' => '唤醒一台或多台云电脑',
'summary' => '对云电脑执行唤醒操作。',
'description' => '只能对状态为已休眠的云电脑执行唤醒操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '160', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WakeupDesktops'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6557DBA9-CF3E-5C1B-B1F1-68FDA599****\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-beijing.aliyuncs.com', 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-qingdao.aliyuncs.com', 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-shanghai.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-hongkong.aliyuncs.com', 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-nanjing', 'regionName' => '华东5(南京-本地地域)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-nanjing.aliyuncs.com', 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.ap-northeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-chengdu.aliyuncs.com', 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => '华南3(广州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-guangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.ap-southeast-5.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾(马尼拉)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.ap-southeast-6.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'],
['regionId' => 'ap-southeast-7', 'regionName' => '泰国(曼谷)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.ap-southeast-7.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ecd.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ecd.eu-west-1.aliyuncs.com', 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ecd.us-west-1.aliyuncs.com', 'endpoint' => 'ecd.us-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'ecd.eu-central-1.aliyuncs.com', 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'ecd.me-east-1.aliyuncs.com', 'endpoint' => 'ecd.me-east-1.aliyuncs.com', 'vpc' => 'ecd-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'me-central-1', 'regionName' => '沙特(利雅得)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'ecd.me-central-1.aliyuncs.com', 'endpoint' => 'ecd.me-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'ecd-vpc.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'App.Authing', 'message' => 'App is authing.', 'http_code' => 400, 'description' => '应用正在设置可见,请稍后再试。'],
['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => '您的用户名或密码不正确。'],
['code' => 'Benefit.NotExist', 'message' => 'The specified benefit is not found.', 'http_code' => 400, 'description' => '指定的权益不存在。'],
['code' => 'Benefit.StockInsufficient', 'message' => 'The specified benefit is out of stock.', 'http_code' => 400, 'description' => '目标权益库存不足。'],
['code' => 'Channel.NotExist', 'message' => 'The specified channel is not found.', 'http_code' => 400, 'description' => '指定的渠道不存在。'],
['code' => 'Channel.TokenInvalid', 'message' => 'The channel service request token is invalid.', 'http_code' => 400, 'description' => '请求渠道服务的凭证无效。'],
['code' => 'ChooseClusterError.ZoneId', 'message' => 'Cannot choose zone, please try other zone.', 'http_code' => 400, 'description' => '资源可用区属性不匹配,请确认目标办公网络是否支持资源所属可用区'],
['code' => 'DeletedBundleStatus', 'message' => 'The specified bundle status is deleted.', 'http_code' => 400, 'description' => '指定的模板已经被删除'],
['code' => 'DesktopCpuHighLoad%s', 'message' => 'The specified desktop cpu high load.', 'http_code' => 400, 'description' => '此台云电脑的CPU使用率过高导致连接超时,占用CPU最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员。'],
['code' => 'DesktopMemoryHighLoad%s', 'message' => 'The specified desktop memory high load.', 'http_code' => 400, 'description' => '此台云电脑的内存使用率过高导致连接超时,占用内存最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员.'],
['code' => 'ExistedFingerPrintTemplate', 'message' => 'The fingerprint is already registered as %s.', 'http_code' => 400, 'description' => '当前手指的指纹已经在当前环境中录入过'],
['code' => 'ExistedHostname', 'message' => 'The specified hostname is existed on the domain.', 'http_code' => 400, 'description' => '指定的主机名在当前工作区已存在'],
['code' => 'ExportDesktop.UnknowError', 'message' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => '导出桌面列表失败,请重试,如果依然失败请提交工单反馈;'."\n"
.'可能原因:依赖的OSS服务权限被意外关停等'],
['code' => 'ExportDesktopGroup.UnknowError', 'message' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => '导出桌面组列表失败,请重试,如果依然失败请提交工单反馈; 可能原因:依赖的OSS服务权限被意外关停等'],
['code' => 'FengyuTestCode1.%s', 'message' => 'FengyuTestMsg1.%s.', 'http_code' => 400, 'description' => '丰禹测试动态错误描述1,动态错误信息(%s)'],
['code' => 'FengyuTestCode2', 'message' => 'FengyuTestMsg2.', 'http_code' => 400, 'description' => '丰禹测试中文'],
['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '用户无权对指定资源进行操作'],
['code' => 'FOTAVersion.NotSupported', 'message' => 'Desktop version does not support this function, please upgrade.', 'http_code' => 400, 'description' => '桌面版本不支持该功能,请升级。'],
['code' => 'HostnameCannotCustomizeForLinux', 'message' => 'Customizing hostname is not supported for Linux desktop.', 'http_code' => 400, 'description' => '自定义主机名功能不支持Linux桌面'],
['code' => 'IncorrectDirectoryStatus', 'message' => 'Only registered directory can create desktop.', 'http_code' => 400, 'description' => '工作区状态错误,仅支持使用已注册的工作区创建桌面'],
['code' => 'IncorrectDirectoryType', 'message' => 'The protocol type of directory and desktop do not match.', 'http_code' => 400, 'description' => '指定工作区和目标桌面的协议类型不匹配,请检查'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '服务内部异常,请稍候重试。'],
['code' => 'InvalidAmount', 'message' => 'The specified Amount is not a valid value.', 'http_code' => 400, 'description' => '指定的数量不合法'],
['code' => 'InvalidAmount.NotTimesOfUsers', 'message' => 'The specified Amount is notmatch EndUserId size.', 'http_code' => 400, 'description' => '指定的桌面数量不等于待分配用户的数量,请重新指定'],
['code' => 'InvalidClientIp.Policy', 'message' => 'Client ip %s is not in white list.', 'http_code' => 400, 'description' => 'IT管理员设置了IP白名单策略导致无法在您目前的IP环境(%s)下连接此台云电脑,请联系IT管理员。'],
['code' => 'InvalidDesktopBundle.NotFound', 'message' => 'The specified param BundleId is not found.', 'http_code' => 400, 'description' => '指定的BundleId找不到'],
['code' => 'InvalidDirectoryId.NotFound', 'message' => 'The specified param DirectoryId is not found.', 'http_code' => 400, 'description' => '无法找到工作区ID,请检查工作区ID是否正确'],
['code' => 'InvalidDirectoryType.NotSupported', 'message' => 'The specified DirectoryType is not supported.', 'http_code' => 400, 'description' => '指定的工作区类型不支持创建该桌面'],
['code' => 'InvalidEncryptionEnabled.Invalid', 'message' => 'The parameter VolumeEncryptionEnabled is invalid.', 'http_code' => 400, 'description' => '指定加密密钥时,需开启磁盘加密功能'],
['code' => 'InvalidEncryptionKey.Missing', 'message' => 'Parameter VolumeEncryptionKey is missing.', 'http_code' => 400, 'description' => '开启磁盘加密功能时,加密密钥不可为空'],
['code' => 'InvalidEncryptionKey.NotAuthorized', 'message' => 'Eds service cannot access the given VolumeEncryptionKey.', 'http_code' => 400, 'description' => '无法访问未经授权的加密密钥'],
['code' => 'InvalidEncryptionKey.NotFound', 'message' => 'The specified VolumeEncryptionKey is not found.', 'http_code' => 400, 'description' => '找不到指定的磁盘加密密钥'],
['code' => 'InvalidFingerPrintTemplate', 'message' => 'The fingerprint template is invalid.', 'http_code' => 400, 'description' => '非法指纹模板数据'],
['code' => 'InvalidFingerPrintTemplateIndex', 'message' => 'The index of the fingerprint template is invalid.', 'http_code' => 400, 'description' => '非法指纹模板索引'],
['code' => 'InvalidImageStatus.NotValid', 'message' => 'The specified image status is not valid.', 'http_code' => 400, 'description' => '指定镜像的状态不可用,不支持创建桌面'],
['code' => 'InvalidImageVersion.NotSupported', 'message' => 'The specified image version is no longer supported.', 'http_code' => 400, 'description' => '指定的镜像版本已不再支持,请选择其他镜像'],
['code' => 'InvalidMemberIp.DesktopAmount', 'message' => 'The desktop amount need to be 1.', 'http_code' => 400, 'description' => '指定IP创建桌面时,桌面数量仅可为1'],
['code' => 'InvalidOssObjectPath.NotFound', 'message' => 'Cannot parse input oss object path. eg: http://bucket/object.vhd.', 'http_code' => 400, 'description' => '检测到上传镜像文件不可用,请您确保将正确的自定义镜像上传至指定的OSS Bucket地址下'],
['code' => 'InvalidParameter.ResourceId', 'message' => 'The specified parameter ResourceId is invalid.', 'http_code' => 400, 'description' => '您指定的实例资源ID无效'],
['code' => 'InvalidParameterError', 'message' => 'Cannot query with end user id and include assigned user.', 'http_code' => 400, 'description' => '不支持同时查询未分配的用户和终端用户ID'],
['code' => 'InvalidPolicyGroup.Status', 'message' => 'The target policy group is being created. Please try again later.', 'http_code' => 400, 'description' => '目标策略组正在创建中,请稍后再试。'],
['code' => 'LockedUser', 'message' => 'User is locked.', 'http_code' => 400, 'description' => '用户已经被锁定。'],
['code' => 'NetworkSpace.DependencyViolation', 'message' => 'networkSpace dependency violation.', 'http_code' => 400, 'description' => '当前办公网络下存在资源,无法直接删除'],
['code' => 'NetworkSpace.VpcInfoExist', 'message' => 'vpc info already exist.', 'http_code' => 400, 'description' => '对应VPC已存在办公网络'],
['code' => 'NoStock.ZoneInvalid', 'message' => 'The requested resource is sold out in the specified zone.', 'http_code' => 400, 'description' => '指定资源在所选可用区库存不足。'],
['code' => 'OperationTooFrequent', 'message' => 'The operation is too frequent, please try again later.', 'http_code' => 400, 'description' => '操作过于频繁,请稍后再试'],
['code' => 'Order.Unpaid', 'message' => 'You have unpaid orders, please pay such orders before placing a new order.', 'http_code' => 403, 'description' => '您选择的资源存在未支付订单,请支付或作废后再下单!'],
['code' => 'ParamError.NoDesktopGroupId', 'message' => 'You must specify desktopGroupId.', 'http_code' => 400, 'description' => '缺少桌面组 ID'],
['code' => 'Protocol.NotAllowed', 'message' => 'Procotol of the image is not allowed.', 'http_code' => 400, 'description' => '不支持该镜像的协议类型,请检查镜像ID'],
['code' => 'RedeemCode.QuantityExceeded', 'message' => 'The number of redeem codes obtained at a time is out of the valid range.', 'http_code' => 400, 'description' => '单次获取的兑换码数量超过阈值。'],
['code' => 'RESOURCE_GROUP_ALREADY_BOUND_APP_RULE', 'message' => 'Resource group already bound app rule.', 'http_code' => 400, 'description' => '云电脑所属资源组正在绑定/解绑应用管控规则'],
['code' => 'RISK.RISK_CONTROL_REJECTION', 'message' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', 'http_code' => 400, 'description' => '为保护您的账户安全,下单被中止,详情请联系客服。'],
['code' => 'SALES_SERVICE_ERROR_INFORMATION', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your information is incomplete. Please complete all required fields here(超链接:https://myaccount.alibabacloud.com/user_info.htm?callback=#/userinfo ) before proceeding.'],
['code' => 'StartApplicationFail', 'message' => 'The application start fail.', 'http_code' => 400, 'description' => '启动失败,请前往win系统的“开始”菜单中打开无影管家'],
['code' => 'StartApplicationGuestNoApp', 'message' => 'The application no start app.', 'http_code' => 400, 'description' => '请到无影应用中心下载无影管家'],
['code' => 'StartApplicationGuestOffline', 'message' => 'The application guest offline.', 'http_code' => 400, 'description' => '桌面异常,请前往win系统的“开始”菜单中打开无影管家'],
['code' => 'StartApplicationGuestTimeout', 'message' => 'The application guest timeout.', 'http_code' => 400, 'description' => '调用超时,请前往win系统的“开始”菜单中打开无影管家'],
['code' => 'Throttling.FingerPrintTemplateSet', 'message' => 'The previous fingerprint template setting is not completed yet.', 'http_code' => 400, 'description' => '先前的指纹模板设定调用还未完成。'],
['code' => 'TooManyFingerPrintTemplateForDevice', 'message' => 'The maximum number of fingerprint templates that any user can save on the current device is exceeded.', 'http_code' => 400, 'description' => '该设备上已经录入了太多指纹模板,无法继续录入'],
['code' => 'TooManyFingerPrintTemplateForUser', 'message' => 'The maximum number of fingerprint templates that you can save in the current environment is exceeded.', 'http_code' => 400, 'description' => '当前用户在当前环境下已经存至少4个指纹模板,无法录入新的模板。'],
['code' => 'TransitRouterService.TrNotExistInRegion', 'message' => 'The transit router need create in current region.', 'http_code' => 400, 'description' => '云企业网中不存在当前地域的转发路由器,请去云企业网控制台新建。'],
['code' => 'UnavailableDesktop', 'message' => 'Authentication failure.', 'http_code' => 400, 'description' => '认证失败,导致无法连接。'],
['code' => 'DesktopCanOnlyAssignedToOneUser', 'message' => 'The desktop can only assigned to one user.', 'http_code' => 400, 'description' => '云电脑被分配了多名用户时禁止强制连接'],
['code' => 'GET_APP_RULE_LOCK_FAILED', 'message' => 'Get app rule lock failed.', 'http_code' => 400, 'description' => '操作过于频繁,请稍候再试。'],
['code' => 'INSUFFICIENT_QUOTA', 'message' => 'Insufficient quota.', 'http_code' => 400, 'description' => '用户配额不足'],
],
'changeSet' => [
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopMetadata'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2025-12-27T14:57:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateTemplate'],
['description' => '请求参数发生变更', 'api' => 'ModifyTemplate'],
],
'createdAt' => '2025-12-25T06:33:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeGlobalTimerRecords'],
],
'createdAt' => '2025-12-24T11:16:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateConfigGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeConfigGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeTimerGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyTimerGroup'],
],
'createdAt' => '2025-12-23T14:11:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2025-12-23T02:20:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCenterPolicy'],
['description' => '请求参数发生变更', 'api' => 'ModifyCenterPolicy'],
],
'createdAt' => '2025-12-10T02:26:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCenterPolicy'],
['description' => '请求参数发生变更', 'api' => 'DescribeCenterPolicyList'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyCenterPolicy'],
],
'createdAt' => '2025-12-08T03:21:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktopRecords'],
],
'createdAt' => '2025-12-01T06:53:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCenterPolicy'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyCenterPolicy'],
],
'createdAt' => '2025-11-24T08:36:46.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeModificationPrice'],
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2025-11-04T08:22:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2025-11-03T09:39:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2025-11-03T08:20:42.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCenterPolicy'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyCenterPolicy'],
],
'createdAt' => '2025-10-27T02:27:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateSimpleOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => '请求参数发生变更', 'api' => 'ModifyOfficeSiteAttribute'],
],
'createdAt' => '2025-10-24T06:35:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroupSessions'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2025-10-17T12:22:53.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeSnapshots'],
],
'createdAt' => '2025-04-10T09:28:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2025-04-10T02:57:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateImage'],
['description' => '请求参数发生变更', 'api' => 'RebuildDesktops'],
],
'createdAt' => '2025-04-09T09:55:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '响应参数发生变更', 'api' => 'DescribeUsersInGroup'],
['description' => '响应参数发生变更', 'api' => 'ListDirectoryUsers'],
['description' => '响应参数发生变更', 'api' => 'ListOfficeSiteUsers'],
],
'createdAt' => '2025-04-09T06:40:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateConfigGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeTimerGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyTimerGroup'],
],
'createdAt' => '2025-03-27T02:08:40.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddUserToDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'DescribeUsersInGroup'],
['description' => '请求参数发生变更', 'api' => 'RemoveUserFromDesktopGroup'],
],
'createdAt' => '2025-03-24T03:52:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'RebootDesktops'],
['description' => '请求参数发生变更', 'api' => 'StopDesktops'],
],
'createdAt' => '2025-03-18T06:41:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2025-03-18T03:50:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2025-03-17T06:50:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2025-03-13T10:29:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2025-03-03T16:22:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
],
'createdAt' => '2025-02-27T02:51:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'CreateSimpleOfficeSite'],
],
'createdAt' => '2025-02-25T06:02:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2025-02-25T03:27:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyOfficeSiteDnsInfo'],
],
'createdAt' => '2025-02-18T08:37:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2025-02-17T12:03:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'RenewNetworkPackages'],
],
'createdAt' => '2025-02-14T06:20:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2025-02-14T04:04:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2025-02-11T09:33:38.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2025-01-24T02:43:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2025-01-24T01:26:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeAclEntries'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2025-01-20T07:28:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'DescribeRecordings'],
],
'createdAt' => '2025-01-16T11:30:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2025-01-15T03:19:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ApplyAutoSnapshotPolicy'],
['description' => '响应参数发生变更', 'api' => 'DescribeSnapshots'],
],
'createdAt' => '2025-01-15T02:18:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeClientEvents'],
],
'createdAt' => '2025-01-11T09:28:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2025-01-10T07:46:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2024-12-19T08:53:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeNASFileSystems'],
],
'createdAt' => '2024-12-19T08:11:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2024-12-09T12:04:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2024-12-06T03:15:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopSpec'],
],
'createdAt' => '2024-12-02T07:41:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeCloudDriveGroups'],
],
'createdAt' => '2024-12-02T02:37:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'MigrateDesktops'],
],
'createdAt' => '2024-11-20T09:59:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetConnectionTicket'],
],
'createdAt' => '2024-11-13T06:38:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
['description' => '请求参数发生变更', 'api' => 'UploadImage'],
],
'createdAt' => '2024-11-09T02:22:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyCloudDrivePermission'],
],
'createdAt' => '2024-11-04T09:17:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeRenewalPrice'],
],
'createdAt' => '2024-11-01T02:06:14.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2024-10-29T05:29:55.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更、请求参数发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2024-10-23T08:48:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2024-09-27T09:48:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2024-09-27T07:36:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'VerifyCen'],
],
'createdAt' => '2024-09-23T07:05:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateAutoSnapshotPolicy'],
],
'createdAt' => '2024-09-12T07:13:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListDirectoryUsers'],
],
'createdAt' => '2024-09-06T14:20:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2024-08-21T01:36:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-08-15T02:55:13.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeInvocations'],
['description' => '请求参数发生变更', 'api' => 'RunCommand'],
],
'createdAt' => '2024-08-13T06:30:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
],
'createdAt' => '2024-08-09T10:00:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-08-05T08:34:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2024-08-05T02:53:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2024-07-31T10:04:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2024-07-25T11:11:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeCloudDriveGroups'],
],
'createdAt' => '2024-07-23T12:38:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CancelAutoSnapshotPolicy'],
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeAutoSnapshotPolicy'],
],
'createdAt' => '2024-07-22T02:12:18.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeBundles'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2024-07-19T04:02:28.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-07-19T01:53:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2024-07-10T12:27:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'RenewDesktops'],
],
'createdAt' => '2024-07-09T03:34:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2024-07-08T12:44:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2024-07-04T13:59:40.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-07-01T02:35:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2024-07-01T02:32:43.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeDirectories'],
['description' => '请求参数发生变更', 'api' => 'ModifyADConnectorOfficeSite'],
],
'createdAt' => '2024-06-26T07:32:31.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'MigrateDesktops'],
],
'createdAt' => '2024-06-19T06:03:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyDesktopSpec'],
['description' => '请求参数发生变更', 'api' => 'RenewDesktops'],
],
'createdAt' => '2024-06-17T13:20:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'RebuildDesktops'],
],
'createdAt' => '2024-06-17T13:00:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2024-06-17T11:57:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更', 'api' => 'ExportDesktopGroupInfo'],
],
'createdAt' => '2024-06-14T11:08:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => '请求参数发生变更', 'api' => 'MigrateDesktops'],
],
'createdAt' => '2024-06-01T13:42:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'RenewDesktops'],
],
'createdAt' => '2024-06-01T11:49:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopInfo'],
],
'createdAt' => '2024-05-07T04:25:40.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
['description' => '请求参数发生变更', 'api' => 'RenewDesktops'],
],
'createdAt' => '2024-04-29T13:58:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2024-04-29T06:51:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateCloudDriveService'],
],
'createdAt' => '2024-04-19T03:12:01.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopSessions'],
],
'createdAt' => '2024-04-15T06:39:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AddDevices'],
['description' => '请求参数发生变更', 'api' => 'DescribeFotaPendingDesktops'],
['description' => '请求参数发生变更', 'api' => 'UpdateFotaTask'],
],
'createdAt' => '2024-03-25T11:44:06.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ResetDesktops'],
],
'createdAt' => '2024-03-13T02:48:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateCloudDriveService'],
],
'createdAt' => '2024-03-12T12:16:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateSnapshot'],
],
'createdAt' => '2024-02-05T08:10:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-01-26T09:20:11.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2024-01-05T03:28:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopInfo'],
],
'createdAt' => '2024-01-04T05:05:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopSpec'],
],
'createdAt' => '2023-12-12T02:44:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCloudDriveService'],
['description' => '响应参数发生变更', 'api' => 'DescribeCloudDriveGroups'],
],
'createdAt' => '2023-12-11T14:21:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeFotaTasks'],
],
'createdAt' => '2023-12-06T02:38:11.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeFotaTasks'],
],
'createdAt' => '2023-11-23T06:18:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-11-21T14:37:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-11-15T13:06:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-11-15T12:07:26.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyOfficeSiteAttribute'],
],
'createdAt' => '2023-11-15T09:36:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateSimpleOfficeSite'],
],
'createdAt' => '2023-11-15T08:55:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeNetworkPackages'],
],
'createdAt' => '2023-10-26T06:49:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CompleteCdsFile'],
['description' => '请求参数发生变更', 'api' => 'CopyCdsFile'],
],
'createdAt' => '2023-09-25T12:03:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2023-09-25T11:13:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2023-09-22T09:14:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2023-09-20T03:02:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2023-09-11T08:23:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateDesktopGroup'],
],
'createdAt' => '2023-09-05T03:59:19.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddFilePermission'],
['description' => '请求参数发生变更', 'api' => 'CreateCdsFileShareLink'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DeleteCdsFile'],
['description' => '请求参数发生变更', 'api' => 'ListCdsFiles'],
['description' => '请求参数发生变更', 'api' => 'ListFilePermission'],
['description' => '请求参数发生变更', 'api' => 'ModifyCdsFile'],
['description' => '请求参数发生变更', 'api' => 'MoveCdsFile'],
['description' => '请求参数发生变更', 'api' => 'RemoveFilePermission'],
],
'createdAt' => '2023-08-29T02:56:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2023-08-01T01:54:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2023-07-31T09:51:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopChargeType'],
],
'createdAt' => '2023-07-19T09:19:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeFotaPendingDesktops'],
],
'createdAt' => '2023-07-14T09:45:52.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2023-07-12T03:57:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2023-07-03T09:44:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeCloudDriveUsers'],
],
'createdAt' => '2023-06-30T08:55:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeCloudDriveGroups'],
],
'createdAt' => '2023-06-27T02:27:13.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
],
'createdAt' => '2023-06-19T11:40:57.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateImage'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeImages'],
],
'createdAt' => '2023-06-13T12:35:37.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2023-06-13T08:13:07.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2023-06-10T09:39:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-05-24T02:48:46.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-05-24T02:38:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '响应参数发生变更', 'api' => 'DescribeInvocations'],
],
'createdAt' => '2023-05-18T06:09:39.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CopyCdsFile'],
['description' => '请求参数发生变更', 'api' => 'ListCdsFiles'],
],
'createdAt' => '2023-05-16T11:00:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2023-05-06T07:42:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2023-04-27T14:08:02.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2023-04-26T07:15:13.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'RebuildDesktops'],
],
'createdAt' => '2023-04-25T03:54:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2023-04-24T09:37:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-04-24T07:40:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ConfigADConnectorTrust'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2023-04-19T03:15:48.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'TagResources'],
],
'createdAt' => '2023-04-17T08:21:34.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListOfficeSiteOverview'],
],
'createdAt' => '2023-04-13T07:46:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2023-04-10T12:50:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'CreateCdsFile'],
],
'createdAt' => '2023-04-03T07:01:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyCloudDriveGroups'],
],
'createdAt' => '2023-03-31T10:38:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
],
'createdAt' => '2023-03-28T10:13:22.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeFotaTasks'],
],
'createdAt' => '2023-03-28T04:47:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeSnapshots'],
],
'createdAt' => '2023-03-24T08:25:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateAutoSnapshotPolicy'],
['description' => '请求参数发生变更', 'api' => 'ModifyAutoSnapshotPolicy'],
],
'createdAt' => '2023-03-24T08:25:39.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyOfficeSiteAttribute'],
],
'createdAt' => '2023-03-24T08:24:44.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
],
'createdAt' => '2023-03-24T08:22:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2023-03-24T08:22:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DeleteImages'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeBundles'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2023-03-24T08:21:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'SetDesktopGroupTimer'],
['description' => '响应参数发生变更、响应参数发生变更', 'api' => 'SetDesktopGroupTimerStatus'],
],
'createdAt' => '2023-01-11T08:21:57.000Z',
'description' => '更新SetDesktopGroupTimer和SetDesktopGroupTimerStatus返回值',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2023-01-05T11:09:40.000Z',
'description' => '增加sessionType字段',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeImages'],
],
'createdAt' => '2023-01-04T02:47:28.000Z',
'description' => '查询镜像接口增加镜像信息',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListUserAdOrganizationUnits'],
],
'createdAt' => '2022-12-14T07:35:29.000Z',
'description' => '1、列举OU支持分页查找;2、支持导入用户的校验',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeClientEvents'],
],
'createdAt' => '2022-12-08T05:12:14.000Z',
'description' => '添加autoCleanUserData字段,支持自动清理用户残留数据',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateNetworkPackage'],
['description' => '响应参数发生变更', 'api' => 'DescribeNetworkPackages'],
],
'createdAt' => '2022-11-30T03:34:19.000Z',
'description' => '后付费按带宽网络包',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyDesktopsPolicyGroup'],
],
'createdAt' => '2022-11-25T01:43:13.000Z',
'description' => '预检查参数供内部使用,不开放',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateSnapshot'],
],
'createdAt' => '2022-11-22T06:32:19.000Z',
'description' => '新增云盘文件修改、删除,文件夹共享相关API',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ExportClientEvents'],
],
'createdAt' => '2022-11-22T03:46:31.000Z',
'description' => '数据导出支持英文表头',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-11-22T01:57:20.000Z',
'description' => '策略创建与修改',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '响应参数发生变更', 'api' => 'GetDesktopGroupDetail'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopsPolicyGroup'],
],
'createdAt' => '2022-11-22T01:56:45.000Z',
'description' => '多策略支持',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeAutoSnapshotPolicy'],
],
'createdAt' => '2022-11-17T09:23:19.000Z',
'description' => '修改快照策略创建时间的后端字段名称',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorDirectory'],
['description' => '请求参数发生变更', 'api' => 'CreateRAMDirectory'],
],
'createdAt' => '2022-11-14T06:22:52.000Z',
'description' => '参数变更',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-11-04T13:39:38.000Z',
'description' => '新增录屏音频录制选项',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeNASFileSystems'],
],
'createdAt' => '2022-10-27T01:46:26.000Z',
'description' => '暂时隐藏domainId',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeNASFileSystems'],
],
'createdAt' => '2022-10-27T01:33:16.000Z',
'description' => '桌面组支持UPM',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeInvocations'],
],
'createdAt' => '2022-10-18T15:10:21.000Z',
'description' => 'DescribeInvocations接口增加DesktopIds参数',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ModifyDiskSpec'],
],
'createdAt' => '2022-10-17T02:12:23.000Z',
'description' => '变更ESSD云盘性能等级',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
['description' => '请求参数发生变更', 'api' => 'ExportDesktopListInfo'],
],
'createdAt' => '2022-10-14T06:27:52.000Z',
'description' => '限制ExportDesktopListInfo和DescribeDesktopsInGroup的分页查询最大数量为100',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-10-14T02:36:33.000Z',
'description' => '文档更新',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-10-08T02:11:23.000Z',
'description' => '基于会话生命周期的录屏设计能力以及文件阅览时长设置',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeDesktopMetricList'],
],
'createdAt' => '2022-10-08T02:08:14.000Z',
'description' => '监控二期会话操作,应用程序查询扩展',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeInvocations'],
['description' => '请求参数发生变更', 'api' => 'RunCommand'],
],
'createdAt' => '2022-09-29T06:07:42.000Z',
'description' => 'ASP桌面新增会话级别命令下发',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'GetConnectionTicket'],
],
'createdAt' => '2022-09-28T12:18:05.000Z',
'description' => '新增应用自启动功能',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
],
'createdAt' => '2022-09-23T08:24:33.000Z',
'description' => 'CreateDesktopGroup接口的PolicyGroupId的修改为必填参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeImages'],
],
'createdAt' => '2022-09-22T06:08:51.000Z',
'description' => '将fotachannel改为私有参数',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ApplyCoordinatePrivilege'],
['description' => 'OpenAPI 下线', 'api' => 'ApplyCoordinatePrivilege'],
['description' => 'OpenAPI 下线', 'api' => 'RevokeCoordinatePrivilege'],
['description' => 'OpenAPI 下线', 'api' => 'RevokeCoordinatePrivilege'],
],
'createdAt' => '2022-09-16T02:36:15.000Z',
'description' => '增加远程协助的键鼠控制功能',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2022-09-13T02:35:45.000Z',
'description' => 'DescribeBundle add Platform parameter',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeCustomizedListHeaders'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyCustomizedListHeaders'],
],
'createdAt' => '2022-09-09T06:35:01.000Z',
'description' => '增加用户自定义桌面列表表头的API',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateImage'],
],
'createdAt' => '2022-09-06T06:31:49.000Z',
'description' => '用户操作日志接口:DescribeClientEvents、ExportClientEvents,增加了组合EventType,可以在query参数中添加:"EventTypes.1":"GET_CONNECTION_TICKET","EventTypes.2":"DESKTOP_START"等来查询多个EventType类型的操作事件,快来试试吧~',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateAndBindNasFileSystem'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-09-05T12:56:50.000Z',
'description' => '增加UPM相关的接口参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-09-05T11:20:37.000Z',
'description' => '策略添加防截屏, 自定义录屏策略',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateDrive'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteDrive'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeDrives'],
],
'createdAt' => '2022-08-31T07:12:00.000Z',
'description' => '发布存储服务drive相关API',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
],
'createdAt' => '2022-08-24T14:48:40.000Z',
'description' => 'CreateDesktopGroup接口的ChargeType设置为必填参数。',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeSnapshots'],
],
'createdAt' => '2022-08-19T06:40:16.000Z',
'description' => 'DescribeSnapshots接口增加协议类型返回字段',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
['description' => '响应参数发生变更', 'api' => 'GetDesktopGroupDetail'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-08-19T03:29:10.000Z',
'description' => '为自动开关机功能,增加桌面组接口相关的入参和出参',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopsInGroup'],
],
'createdAt' => '2022-08-17T08:47:41.000Z',
'description' => 'DescribeDesktopsInGroup 增加出参:MemberEniIp 和 PrimaryEniIp',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DeleteCloudDriveUsers'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeCloudDrivePermissions'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyCloudDrivePermission'],
],
'createdAt' => '2022-08-17T02:00:13.000Z',
'description' => '无影云盘支持个人账户的设置',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-08-11T07:30:38.000Z',
'description' => '更改桌面组,添加最大空闲时间和最大链接时间',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'GetDesktopGroupDetail'],
],
'createdAt' => '2022-08-11T06:39:10.000Z',
'description' => '增加空闲时间和最大连接时间,版本号',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'GetDesktopGroupDetail'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-08-11T02:45:02.000Z',
'description' => '配合多 session 自动伸缩需求,在桌面组相关的创建,修改和查询等 4 个接口中增加自动伸缩参数 RatioThreshold',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeUsersInGroup'],
],
'createdAt' => '2022-08-10T09:10:03.000Z',
'description' => '在 DescribeUsersInGroup 接口中增加出参 userDesktopId,向前兼容',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
],
'createdAt' => '2022-08-08T08:04:15.000Z',
'description' => '新增UserCommands字段,可以在新建桌面后执行自定义脚本命令。',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeUsersPassword'],
],
'createdAt' => '2022-08-04T10:24:20.000Z',
'description' => '管理员支持获取登陆密码',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-08-04T09:52:45.000Z',
'description' => 'DescribeDesktops 恢复取消限制',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-08-04T09:35:20.000Z',
'description' => 'describeDesktops 查询数量集限制500',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeRegions'],
],
'createdAt' => '2022-08-02T02:03:06.000Z',
'description' => 'describeRegions增加参数language and localName',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeNetworkPackages'],
],
'createdAt' => '2022-07-28T02:07:35.000Z',
'description' => '网络包返回工作区类型',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-07-19T03:54:59.000Z',
'description' => '新增录屏文件过期时间设置和查询参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateNetworkPackage'],
['description' => '请求参数发生变更', 'api' => 'ModifyNetworkPackageBandwidth'],
],
'createdAt' => '2022-07-14T07:58:43.000Z',
'description' => '带宽售卖下限调整',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-07-12T07:03:51.000Z',
'description' => '允许自动伸缩策略中的最大桌面数设置为 0',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'ExportDesktopListInfo'],
],
'createdAt' => '2022-07-07T06:28:42.000Z',
'description' => 'describeDesktops 和 ExportDesktopListInfo 接口入参新增tag字段,用户可以通过tag来进行筛选桌面',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'SetOfficeSiteSsoStatus'],
],
'createdAt' => '2022-07-07T06:15:19.000Z',
'description' => '隐藏部分参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ApplyCoordinationForMonitoring'],
],
'createdAt' => '2022-07-07T03:54:52.000Z',
'description' => '添加了远程协助接口',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeInvocations'],
],
'createdAt' => '2022-06-30T12:11:48.000Z',
'description' => '新增EndUserId,支持用户态命令执行,查询',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-06-30T06:10:19.000Z',
'description' => '新增网络重定向策略',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeUsersInGroup'],
],
'createdAt' => '2022-06-17T03:46:00.000Z',
'description' => 'DescribeUsersInGroup接口支持按姓名过滤',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeVulList'],
],
'createdAt' => '2022-06-16T09:19:13.000Z',
'description' => 'Progress,DesktopGroupId 字段设置成不可见',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeConvertQuota'],
],
'createdAt' => '2022-06-10T06:56:57.000Z',
'description' => '内部接口,不对外',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2022-06-08T02:37:36.000Z',
'description' => '无需展示',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'DeleteDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
],
'createdAt' => '2022-06-07T11:38:11.000Z',
'description' => '修改桌面组相关的POP API的流控配置,可能被频繁调用的设置为单用户每分钟6000次,其他的设置为单用户每分钟600次。',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-06-07T11:37:56.000Z',
'description' => 'ModifyPolicyGroup 和 CreatePolicyGroup 设置 水印自定义字段为私有',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeVirtualMFADevices'],
],
'createdAt' => '2022-06-07T11:37:03.000Z',
'description' => '优化api文档',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ExportDesktopGroupInfo'],
['description' => '请求参数发生变更', 'api' => 'ExportDesktopListInfo'],
],
'createdAt' => '2022-06-02T09:00:10.000Z',
'description' => '设置DirectoryId私有,并更新文档中两个字段的必填属性',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'UploadImage'],
],
'createdAt' => '2022-06-01T06:40:29.000Z',
'description' => '增加可选的安全防护能力',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeVulList'],
],
'createdAt' => '2022-05-31T09:55:37.000Z',
'description' => '返回体增加Progress字段和desktopGroupId字段,Progress用于漏洞操作进度展示,desktopGroupId用于控制桌面组桌面跳转能力',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2022-05-31T07:08:04.000Z',
'description' => '不对外开放的字段,无需变更文档',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'AssociateNetworkPackage'],
['description' => 'OpenAPI 下线', 'api' => 'DissociateNetworkPackage'],
],
'createdAt' => '2022-05-30T01:27:20.000Z',
'description' => '网络包增加解绑/绑定操作',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ResetDesktops'],
],
'createdAt' => '2022-05-26T11:38:47.000Z',
'description' => '新增重置云桌面接口',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeFlowStatistic'],
],
'createdAt' => '2022-05-26T08:06:00.000Z',
'description' => '桌面粒度流量统计接口',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeRefundPrice'],
],
'createdAt' => '2022-05-26T07:17:47.000Z',
'description' => '内部使用 不展示',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CancelCopyImage'],
['description' => 'OpenAPI 下线', 'api' => 'CopyImage'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeImagePermission'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyImagePermission'],
],
'createdAt' => '2022-05-26T07:14:08.000Z',
'description' => '复制与共享镜像功能发布',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2022-05-23T06:55:52.000Z',
'description' => '模版磁盘加密参数',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateDesktopSavingPlan'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopTypes'],
['description' => '请求参数发生变更', 'api' => 'DescribeHardwareTerminals'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeSavingPlanPrice'],
],
'createdAt' => '2022-05-23T06:03:31.000Z',
'description' => '无影接入节省计划',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeUsersInGroup'],
],
'createdAt' => '2022-05-23T04:53:13.000Z',
'description' => '获取桌面组授权用户接口返回用户的一些附加信息',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CheckServiceLinkedRoleForDeleting'],
['description' => '请求参数发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'CreateDesktops'],
['description' => 'OpenAPI 下线', 'api' => 'CreateDiskEncryptionService'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '响应参数发生变更', 'api' => 'DescribeImages'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeKmsKeys'],
['description' => '响应参数发生变更', 'api' => 'DescribeSnapshots'],
],
'createdAt' => '2022-05-23T04:53:01.000Z',
'description' => '无影云桌面增加磁盘加密功能',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'DescribeUserConnectionRecords'],
],
'createdAt' => '2022-05-13T03:57:56.000Z',
'description' => '获取用户连接记录接口支持一系列的过滤条件。',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ExportDesktopGroupInfo'],
['description' => '请求参数发生变更', 'api' => 'ExportDesktopListInfo'],
],
'createdAt' => '2022-05-13T03:23:37.000Z',
'description' => '1、导出云桌面和桌面组列表支持中英文切换;2、桌面组导出列表增加新的资源配置项',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeImageModifiedRecords'],
],
'createdAt' => '2022-05-13T03:11:16.000Z',
'description' => '新增无影云桌面镜像变更记录查询的OpenApi,无影云桌面镜像变更记录功能可以在云桌面详情镜像名称后点击变更记录按钮查看。',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateNASFileSystem'],
['description' => '响应参数发生变更', 'api' => 'DescribeNASFileSystems'],
],
'createdAt' => '2022-05-11T06:01:31.000Z',
'description' => '增加nas加密参数',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2022-04-29T03:16:27.000Z',
'description' => '修改桌面组 新增classify字段',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-04-24T10:10:39.000Z',
'description' => '去掉无用参数',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeRecordings'],
['description' => 'OpenAPI 下线', 'api' => 'DownloadRecordings'],
],
'createdAt' => '2022-04-24T08:17:11.000Z',
'description' => '录屏审计-下载、查询',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2022-04-24T08:17:03.000Z',
'description' => '桌面策略中新增录屏相关的策略',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeFrontVulPatchList'],
['description' => '请求参数发生变更', 'api' => 'HandleSecurityEvents'],
['description' => '请求参数发生变更', 'api' => 'ModifyOperateVul'],
],
'createdAt' => '2022-04-24T08:16:59.000Z',
'description' => '云桌面安全相关接口Bug修复:HandleSecurityEvents, ModifyOperateVul, DescribeFrontVulPatchList将一些必选参数做强限制,之前不填会报Internal error,实际是不支持为空',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-04-22T02:14:27.000Z',
'description' => '在DescribeDesktops接口返回中添加Platform字段,用于显示操作系统的平台详情。',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2022-04-21T14:09:30.000Z',
'description' => '支持显示多 session 镜像,目前处于白名单阶段,不对外开放',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddUserToDesktopGroup'],
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'DescribeUsersInGroup'],
['description' => '请求参数发生变更', 'api' => 'ModifyUserToDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'RemoveUserFromDesktopGroup'],
],
'createdAt' => '2022-04-13T08:15:24.000Z',
'description' => '桌面组授权用户时,用户数量从100扩展到10000;查询桌面组授权用户接口增加入参QueryUserDetail,控制是否获取用户详情。',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'ModifyUserToDesktopGroup'],
],
'createdAt' => '2022-03-23T11:46:06.000Z',
'description' => 'ModifyUserToDesktopGroup接口限制OldEndUserIds和NewEndUserIds最大数量为100',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddUserToDesktopGroup'],
['description' => '请求参数发生变更', 'api' => 'RemoveUserFromDesktopGroup'],
],
'createdAt' => '2022-03-23T11:33:15.000Z',
'description' => 'AddUserToDesktopGroup和RemoveUserFromDesktopGroup限制EndUserIds和DesktopGroupIds的最大值为100',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'AddUserToDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeClientEvents'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'RemoveUserFromDesktopGroup'],
],
'createdAt' => '2022-03-23T09:10:18.000Z',
'description' => '获取桌面组列表接口:DescribeDesktopGroups,增加入参EndUserIds、ExcludedEndUserIds增加桌面组用户授权:AddUserToDesktopGroup,增加入参DesktopGroupIds移除桌面组用户授权:RemoveUserFromDesktopGroup,增加入参DesktopGroupIds获取用户日志:DescribeClientEvents,增加出参DesktopGroupId、DesktopGroupName',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetDesktopGroupDetail'],
],
'createdAt' => '2022-03-21T03:14:22.000Z',
'description' => 'GetDesktopGroupDetail接口的出参desktops的类型由数组改成object。',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-03-18T09:11:43.000Z',
'description' => 'DescribeDesktops支持返回PerformanceLevel参数,用于显示essd的存储性能级别。',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ApproveFotaUpdate'],
['description' => 'OpenAPI 下线', 'api' => 'CreateUserTags'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteUserTags'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeFotaPendingDesktops'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeFotaTasks'],
['description' => '响应参数发生变更', 'api' => 'DescribeImages'],
['description' => 'OpenAPI 下线', 'api' => 'UpdateFotaTask'],
],
'createdAt' => '2022-03-15T14:45:11.000Z',
'description' => '增加镜像升级API',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ConfigADConnectorUser'],
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorDirectory'],
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeDirectories'],
['description' => '响应参数发生变更', 'api' => 'ListDirectoryUsers'],
['description' => '响应参数发生变更', 'api' => 'ListOfficeSiteUsers'],
['description' => '请求参数发生变更', 'api' => 'ModifyADConnectorDirectory'],
['description' => '请求参数发生变更', 'api' => 'ModifyADConnectorOfficeSite'],
],
'createdAt' => '2022-03-14T08:03:47.000Z',
'description' => '支持ASP AD工作区',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2022-03-03T09:12:51.000Z',
'description' => '在DescribeBundles接口的输出中,添加SessionType字段,表明是单session还是多session镜像,如果没有返回改字段,则表明为默认的单session镜像',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2022-03-02T08:14:42.000Z',
'description' => '工作区增加VPC类型字段',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'ListOfficeSiteOverview'],
],
'createdAt' => '2022-03-02T08:09:22.000Z',
'description' => '工作区增加VPC类型字段',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DisableDesktopsInGroup'],
],
'createdAt' => '2022-03-02T07:13:32.000Z',
'description' => '新增接口,允许将桌面置为 disable',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'UploadImage'],
],
'createdAt' => '2022-02-24T10:11:53.000Z',
'description' => 'UploadImage接口:支持用户上传自定义镜像CreateUserOssPath:私有接口,在资源账号中创建用户oss bucket并授权DescribeUserOssPath:私有接口,展示用户可用的bucket',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => '请求参数发生变更', 'api' => 'SetOfficeSiteSsoStatus'],
],
'createdAt' => '2022-02-16T03:39:35.000Z',
'description' => '工作区增加oauth协议的sso地址',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-02-07T02:43:14.000Z',
'description' => '查询桌面增加创建进度',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ExportClientEvents'],
],
'createdAt' => '2022-01-20T05:17:25.000Z',
'description' => '支持客户端日志导出',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-01-20T05:15:19.000Z',
'description' => '桌面查询增加工作区名称查询,并返回桌面对应的模板名称模板查询返回镜像名称',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'RenewNetworkPackages'],
],
'createdAt' => '2022-01-19T15:22:59.000Z',
'description' => '添加错误码映射',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateSimpleOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => '请求参数发生变更', 'api' => 'ModifyOfficeSiteAttribute'],
],
'createdAt' => '2022-01-13T08:29:43.000Z',
'description' => '工作区增加可信设备校验开关',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2022-01-06T02:39:25.000Z',
'description' => 'DescribeDesktops接口返回GPU Category和GPU driver version',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
],
'createdAt' => '2021-12-24T04:48:20.000Z',
'description' => '添加返回工作区桌面数量',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'GetConnectionTicket'],
],
'createdAt' => '2021-12-23T06:22:07.000Z',
'description' => '修复GetConnectionTicket定义',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyCloudDriveService'],
],
'createdAt' => '2021-12-23T05:16:18.000Z',
'description' => '内部变更,未面向客户。',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'],
['description' => '请求参数发生变更', 'api' => 'DescribeDesktopTypes'],
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2021-12-22T01:25:34.000Z',
'description' => '增加预付费桌面降配次数限制',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'QueryAccountLabel'],
],
'createdAt' => '2021-12-17T02:45:10.000Z',
'description' => '查询用户是否已经实名',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateBandwidthResourcePackages'],
['description' => '请求参数发生变更', 'api' => 'DescribeNetworkPackages'],
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeResourcePackageQuota'],
],
'createdAt' => '2021-12-10T09:25:08.000Z',
'description' => '带宽资源包',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopChargeType'],
],
'createdAt' => '2021-12-10T01:51:26.000Z',
'description' => '转换桌面付费类型支持使用优惠券',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateOrderForHardware'],
],
'createdAt' => '2021-12-10T01:45:21.000Z',
'description' => '硬件终端售卖页面,支持用户选择优惠券的功能。',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateOrderForHardware'],
],
'createdAt' => '2021-12-10T01:41:52.000Z',
'description' => '在售卖硬件终端的页面,支持用户使用优惠券的功能',
],
[
'apis' => [
['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeDesktopsInGroup'],
['description' => '响应参数发生变更', 'api' => 'ListOfficeSiteOverview'],
],
'createdAt' => '2021-12-09T02:22:26.000Z',
'description' => 'ListOfficeSiteOverview:可以同时返回云桌面和桌面组下的云桌面的数量;DescribeDesktopsInGroup:增加ManagementFlag出参。',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreatePolicyGroup'],
['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribePolicyGroups'],
['description' => '请求参数发生变更', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2021-12-01T09:28:07.000Z',
'description' => '策略支持GPU优化',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateNetworkPackage'],
['description' => '请求参数发生变更', 'api' => 'DescribeModificationPrice'],
['description' => '请求参数发生变更', 'api' => 'DescribeRenewalPrice'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopSpec'],
['description' => '请求参数发生变更', 'api' => 'ModifyNetworkPackageBandwidth'],
['description' => '请求参数发生变更', 'api' => 'RenewDesktops'],
['description' => '请求参数发生变更', 'api' => 'RenewNetworkPackages'],
],
'createdAt' => '2021-11-26T04:06:00.000Z',
'description' => '云桌面及网络包新购、续费、变配支持使用优惠券',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeImages'],
['description' => '请求参数发生变更', 'api' => 'RebuildDesktops'],
],
'createdAt' => '2021-11-26T03:28:00.000Z',
'description' => '重建桌面支持传入指定镜像',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBundles'],
],
'createdAt' => '2021-11-18T07:44:32.000Z',
'description' => 'DescribeBundles模板查询返回创建时间',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ModifyNetworkPackageBandwidth'],
],
'createdAt' => '2021-11-18T05:40:38.000Z',
'description' => '包年包月按固定带宽网络支持升降配',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListOfficeSiteOverview'],
],
'createdAt' => '2021-11-18T05:40:32.000Z',
'description' => 'ListOfficeSiteOverview增加入参QueryRange。',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktopTypes'],
],
'createdAt' => '2021-11-18T05:38:14.000Z',
'description' => '桌面规格查询接口增加桌面id查询条件,返回的桌面规格会包含变配的兼容性状态检查的结果',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeModificationPrice'],
['description' => '请求参数发生变更', 'api' => 'ModifyDesktopSpec'],
],
'createdAt' => '2021-11-18T05:37:25.000Z',
'description' => '1、变配询价支持网络;2、变配支持添加高性能等级的ESSD;',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeRenewalPrice'],
],
'createdAt' => '2021-11-04T10:26:01.000Z',
'description' => 'DescribeRenewalPrice支持批量续费询价',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateDesktopGroup'],
['description' => '响应参数发生变更', 'api' => 'DescribeDesktopGroups'],
['description' => '响应参数发生变更、错误码发生变更', 'api' => 'GetDesktopGroupDetail'],
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'ModifyDesktopGroup'],
],
'createdAt' => '2021-11-04T10:05:13.000Z',
'description' => '增加桌面组 resetType 和 status 参数',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateCloudDriveService'],
['description' => 'OpenAPI 下线', 'api' => 'DeleteCloudDriveServices'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeCloudDriveService'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyCloudDriveService'],
],
'createdAt' => '2021-10-28T14:33:50.000Z',
'description' => 'sm增加pds网盘集成openapi',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateBundle'],
['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeBundles'],
['description' => '请求参数发生变更', 'api' => 'DescribePrice'],
],
'createdAt' => '2021-10-28T13:09:02.000Z',
'description' => '支持创建高性能等级的ESSD',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDirectories'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'ModifyOfficeSiteAttribute'],
],
'createdAt' => '2021-10-28T11:55:45.000Z',
'description' => '增加登录二次验证开关标识',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更、错误码发生变更', 'api' => 'DescribeImages'],
],
'createdAt' => '2021-10-28T11:24:31.000Z',
'description' => '镜像查询API新增语言出入参',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AttachCen'],
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '请求参数发生变更', 'api' => 'CreateSimpleOfficeSite'],
['description' => 'OpenAPI 下线', 'api' => 'SendVerifyCode'],
['description' => '请求参数发生变更', 'api' => 'VerifyCen'],
],
'createdAt' => '2021-10-28T07:30:21.000Z',
'description' => '跨账号挂载CEN增加验证码',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CheckUserTags'],
],
'createdAt' => '2021-10-27T04:22:46.000Z',
'description' => '检查该用户是否设置了某些标签',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ModifyDesktopChargeType'],
],
'createdAt' => '2021-09-28T06:41:49.000Z',
'description' => '按量付费云桌面支持转换为包年包月',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'DescribeDesktops'],
],
'createdAt' => '2021-09-28T06:39:25.000Z',
'description' => 'DescribeDesktops接口增加DesktopGroupId入参,可以获取桌面组下的桌面的信息。',
],
[
'apis' => [
['description' => '请求参数发生变更、错误码发生变更', 'api' => 'DescribeDesktopGroups'],
],
'createdAt' => '2021-09-10T07:07:38.000Z',
'description' => 'DescribeDesktopGroups 增加入参 PolicyGroupId,允许根据 PolicyGroupId 查询桌面组',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListDirectoryUsers'],
['description' => '请求参数发生变更', 'api' => 'ListOfficeSiteUsers'],
],
'createdAt' => '2021-09-08T07:19:18.000Z',
'description' => '列举AD用户的时候,支持先选择OU',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ModifyBundle'],
],
'createdAt' => '2021-08-23T10:39:38.000Z',
'description' => '动态后端地址规则修改',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'ConfigADConnectorTrust'],
['description' => 'OpenAPI 下线', 'api' => 'ConfigADConnectorUser'],
['description' => '请求参数发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '响应参数发生变更', 'api' => 'DescribeDirectories'],
['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'],
['description' => 'OpenAPI 下线', 'api' => 'ListUserAdOrganizationUnits'],
],
'createdAt' => '2021-08-23T07:52:57.000Z',
'description' => '新版AD工作区创建OpenAPI',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'AddUserToSecurityCenterWhiteList'],
['description' => '错误码发生变更', 'api' => 'AttachCen'],
['description' => '错误码发生变更', 'api' => 'CheckUserInSecurityCenterWhiteList'],
['description' => '错误码发生变更', 'api' => 'CreateADConnectorDirectory'],
['description' => '错误码发生变更', 'api' => 'CreateADConnectorOfficeSite'],
['description' => '错误码发生变更', 'api' => 'CreateDesktopsLite'],
['description' => '错误码发生变更', 'api' => 'CreateNetworkPackage'],
['description' => '错误码发生变更', 'api' => 'CreateRAMDirectory'],
['description' => '错误码发生变更', 'api' => 'CreateServiceLinkedRole'],
['description' => '错误码发生变更', 'api' => 'CreateSimpleOfficeSite'],
],
'createdAt' => '2021-08-19T08:17:26.000Z',
'description' => '统一动态后端地址规则',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreateBundle'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeBundles'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyBundle'],
],
'createdAt' => '2021-08-06T04:03:20.000Z',
'description' => '模板支持多语言',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'CreatePolicyGroup'],
['description' => 'OpenAPI 下线', 'api' => 'DescribePolicyGroups'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyPolicyGroup'],
],
'createdAt' => '2021-04-19T11:08:15.000Z',
'description' => 'api名称:SM:CreatePolicyGroup、ModifyPolicyGroup、DescribePolicyGroups 接口中新增了preemptLogin 和oreemptLoginUser 两个字段 ',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UnlockVirtualMFADevice'],
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveFilePermission'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopsPolicyGroup'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSnapshots'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDirectories'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UploadImage'],
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktopGroup'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerBatches'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddFilePermission'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'BatchModifyEntitlement'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePolicyGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroupSessions'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachCen'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAutoSnapshotPolicy'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopTimer'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNetworkPackages'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateNASFileSystem'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSimpleOfficeSite'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteOfficeSites'],
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDiskSpec'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateNetworkPackage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorTrust'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDrivePermission'],
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAutoSnapshotPolicy'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNetworkPackages'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeKmsKeys'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeVirtualMFADevices'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeletePolicyGroups'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorDirectory'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserEntitlement'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAutoSnapshotPolicy'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'LockVirtualMFADevice'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSnapshot'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetOfficeSiteSsoStatus'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBundles'],
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ConfigADConnectorUser'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopName'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopGroups'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCdsFileShareLink'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordings'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyPolicyGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorDirectory'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StartDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeInvocations'],
['threshold' => '200', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeEcdReportTasks'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MigrateImageProtocol'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopInvocation'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFotaTask'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCloudDriveGroups'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetSnapshot'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteBundles'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetIdpMetadata'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddDevices'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeZones'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCdsFileShareLink'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNASDefaultMountTarget'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteVirtualMFADevice'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyCustomizedListHeaders'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DetachEndUser'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAclEntries'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyUserToDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDirectories'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'VerifyCen'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ActivateOfficeSite'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SendVerifyCode'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageEnabled'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetOfficeSiteSsoStatus'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListFilePermission'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'MoveCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeGuestApplications'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeOfficeSites'],
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopListInfo'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeClientEvents'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDrives'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBundle'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalTimerRecords'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetAsyncTask'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetDesktops'],
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportDesktopGroupInfo'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'StopDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePrice'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RevokeCoordinatePrivilege'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDevices'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListCdsFiles'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFileShareLink'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeModificationPrice'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDevices'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RenewNetworkPackages'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRAMDirectory'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopSessions'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebootDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCloudDriveGroups'],
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDesktopGroupDetail'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopChargeType'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RunCommand'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribePolicyGroups'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDiskEncryptionService'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateADConnectorOfficeSite'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDesktopsInGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportClientEvents'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteDnsInfo'],
['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateNetworkPackage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteImages'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDirectoryUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImages'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimerStatus'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyADConnectorOfficeSite'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CopyImage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaTasks'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopHostName'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateNetworkPackage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateSnapshot'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteCrossDesktopAccess'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCustomizedListHeaders'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopMaintenance'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachCen'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DownloadCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRenewalPrice'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFlowStatistic'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveService'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateEcdReportTask'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDrive'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCens'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RebuildDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetSpMetadata'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateImage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersPassword'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFlowMetric'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImageAttribute'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDriveGroups'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeFotaPendingDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeNASFileSystems'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopsInGroup'],
['threshold' => '80', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDesktopSpec'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteMfaEnabled'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDrive'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyAutoSnapshotPolicy'],
['threshold' => '60', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUsersInGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDirectorySsoStatus'],
['threshold' => '1000', 'countWindow' => 30, 'regionId' => '*', 'api' => 'DescribeDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImageModifiedRecords'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ClonePolicyGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAutoSnapshotPolicy'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCoordinationForMonitoring'],
['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupScaleTimer'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinatePrivilege'],
['threshold' => '500', 'countWindow' => 30, 'regionId' => '*', 'api' => 'GetConnectionTicket'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetCoordinateTicket'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteNASFileSystems'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyNetworkPackageBandwidth'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopTypes'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HibernateDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAclEntries'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeUserConnectionRecords'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddUserToDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListOfficeSiteOverview'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCdsFileShareLinks'],
['threshold' => '160', 'countWindow' => 1, 'regionId' => '*', 'api' => 'WakeupDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DisconnectDesktopSessions'],
['threshold' => '800', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBandwidthResourcePackages'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AttachEndUser'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCdsFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRecordFile'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDesktops'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeImagePermission'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRefundPrice'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelCopyImage'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'RemoveUserFromDesktopGroup'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateCloudDriveUsers'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyEntitlement'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyImagePermission'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopMetadata'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBundle'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetNASDefaultMountTarget'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAutoSnapshotPolicy'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeCloudDrivePermissions'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ApplyCoordinationForMonitoring'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyOfficeSiteAttribute'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDesktopInfo'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktopRecords'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SetDesktopGroupTimer'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListUserAdOrganizationUnits'],
['threshold' => '1000', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CompleteCdsFile'],
['threshold' => '100', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAndBindNasFileSystem'],
],
],
'ram' => [
'productCode' => 'ECD',
'productName' => '无影云电脑',
'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'CreateBundle',
'description' => '创建自定义云电脑模板',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateBundle',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopsPolicyGroup',
'description' => '为云电脑更换绑定的云电脑策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopsPolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeQosRules',
'description' => '查询限速规则。',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeQosRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDesktops',
'description' => '释放云电脑',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopGroup',
'description' => '修改共享型云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCloudDriveGroups',
'description' => '删除团队共享盘',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteCloudDriveGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelCopyImage',
'description' => '取消跨地域复制镜像',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CancelCopyImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ApplyCoordinatePrivilege',
'description' => '申请流协同操作权限',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ApplyCoordinatePrivilege',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteConfigGroup',
'description' => '删除配置组',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DeleteConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyUserToDesktopGroup',
'description' => '为共享型云电脑替换授权用户',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyUserToDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCloudDriveUsers',
'description' => '修改用户个人盘属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCloudDriveUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopChargeType',
'description' => '修改云电脑付费类型',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopChargeType',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetDesktops',
'description' => '重置共享型云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ResetDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryHistoryAvgMetricList',
'description' => '历史平均监控指标查询',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:QueryHistoryAvgMetricList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateBandwidthResourcePackages',
'description' => '创建无影流量包',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateBandwidthResourcePackages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeEcdReportTasks',
'description' => '查询无影报表任务列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeEcdReportTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CopyCdsFile',
'description' => '复制文件或文件夹',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CopyCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryHistoryActiveUserCount',
'description' => '查询历史日活月活用户数',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:QueryHistoryActiveUserCount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDesktopGroupTimerStatus',
'description' => '设置共享型云电脑定时任务的状态',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetDesktopGroupTimerStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeImages',
'description' => '查询镜像的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeImages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelAutoSnapshotPolicy',
'description' => '取消自动快照策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:CancelAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribePolicyGroups',
'description' => '查询云电脑策略详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribePolicyGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopDesktops',
'description' => '停止一台或者多台运行中的云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:StopDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAclEntries',
'description' => '修改公网访问控制策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyAclEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyBundle',
'description' => '修改自定义云电脑模板',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyBundle',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAsyncTask',
'description' => '获取异步任务信息',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:GetAsyncTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDesktopMaintenance',
'description' => '设置云电脑维护模式',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetDesktopMaintenance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyOfficeSiteAttribute',
'description' => '修改办公网络属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteNASFileSystems',
'description' => '删除NAS文件系统',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteNASFileSystems',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopGroups',
'description' => '查询共享型云电脑列表及详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnlockVirtualMFADevice',
'description' => '解锁虚拟MFA设备',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:UnlockVirtualMFADevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveFilePermission',
'description' => '取消网盘文件夹共享',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:RemoveFilePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeFotaPendingDesktops',
'description' => '获取待升级镜像的云电脑信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeFotaPendingDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTransferFileDownloadUrl',
'description' => '获取传输文件的下载地址',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListTransferFileDownloadUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudDriveUsers',
'description' => '查询用户个人盘列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCloudDriveUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteVirtualMFADevice',
'description' => '删除AD账号绑定的虚拟MFA设备',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteVirtualMFADevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetOfficeSiteSsoStatus',
'description' => '设置办公网络的单点登录SSO开关状态',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetOfficeSiteSsoStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopTypes',
'description' => '查询云电脑规格详细信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopTypes',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateEcdReportTask',
'description' => '创建无影报表任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CreateEcdReportTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportDesktopListInfo',
'description' => '导出云电脑列表',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ExportDesktopListInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartDesktops',
'description' => '启动一台或者多台已停止的云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:StartDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyNASDefaultMountTarget',
'description' => '修改NAS文件系统的挂载点',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyNASDefaultMountTarget',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeClientEvents',
'description' => '查询终端用户的操作日志',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeClientEvents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ConfigADConnectorUser',
'description' => '配置AD办公网络的组织单元OU和管理员',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ConfigADConnectorUser',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCustomizedListHeaders',
'description' => '获取云电脑列表表头',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCustomizedListHeaders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZones',
'description' => '查询指定地域支持的可用区',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeZones',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ApplyCoordinationForMonitoring',
'description' => '向终端用户发起远程协助请求',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ApplyCoordinationForMonitoring',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopTimer',
'description' => '创建或修改云电脑定时任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopTimer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteBundles',
'description' => '删除一个或多个自定义云电脑模板',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteBundles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CloneCenterPolicy',
'description' => '克隆无地域策略',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CloneCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddDevices',
'description' => '添加可信设备',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:AddDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopInfo',
'description' => '查询云电脑基础信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryHistoryMetricDistribution',
'description' => '历史指标分布查询',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:QueryHistoryMetricDistribution',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CopyImage',
'description' => '跨地域复制镜像',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CopyImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetNASDefaultMountTarget',
'description' => '重置NAS文件系统的挂载点',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ResetNASDefaultMountTarget',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeModificationPrice',
'description' => '查询变配价格',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeModificationPrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ApproveFotaUpdate',
'description' => '允许升级镜像',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ApproveFotaUpdate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteAutoSnapshotPolicy',
'description' => '删除自动快照策略',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRecordFile',
'description' => '查询全地域录屏文件列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeRecordFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribePrice',
'description' => '查询新购价格',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribePrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyOfficeSiteCrossDesktopAccess',
'description' => '设置办公网络内云电脑的互通性',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteCrossDesktopAccess',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDiskEncryptionService',
'description' => '开启磁盘加密功能',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CreateDiskEncryptionService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAutoSnapshotPolicy',
'description' => '查询自动快照策略',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateADConnectorOfficeSite',
'description' => '创建基于企业AD账号的办公网络',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateADConnectorOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInvocations',
'description' => '查询云助手脚本的执行列表和状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeInvocations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCoordinateTicket',
'description' => '获取协同流凭证',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:GetCoordinateTicket',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RebuildDesktops',
'description' => '为云电脑变更镜像',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:RebuildDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAndBindNasFileSystem',
'description' => '创建并绑定NAS文件系统',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateAndBindNasFileSystem',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeResourceByCenterPolicyId',
'description' => '查询无地域策略关联的资源',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeResourceByCenterPolicyId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyNetworkPackageBandwidth',
'description' => '修改公网精品带宽的带宽大小',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyNetworkPackageBandwidth',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRAMDirectory',
'description' => '创建RAM类型的目录',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateRAMDirectory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListOfficeSiteOverview',
'description' => '查询办公网络的概览信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListOfficeSiteOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTemplates',
'description' => '查询云电脑模板详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSessionStatistic',
'description' => '查询会话统计',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeSessionStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DissociateNetworkPackage',
'description' => '从办公网络解绑公网精品带宽',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DissociateNetworkPackage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListFilePermission',
'description' => '查询网盘共享文件夹',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ListFilePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddUserToDesktopGroup',
'description' => '为共享型云电脑添加授权用户',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:AddUserToDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopGroupSessions',
'description' => '查询共享型云电脑会话监控详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopGroupSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteTemplates',
'description' => '删除自定义云电脑模板',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteTemplates',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetachCen',
'description' => '将高级办公网络与云企业网实例解绑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:DetachCen',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeOfficeSites',
'description' => '查询办公网络的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeOfficeSites',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RunCommand',
'description' => '在云电脑中执行脚本',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:RunCommand',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeConfigGroup',
'description' => '查询配置组列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteImages',
'description' => '删除一个或多个自定义镜像',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteImages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopInvocation',
'description' => '停止脚本执行',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:StopInvocation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyPolicyGroup',
'description' => '修改云电脑策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyPolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopHostName',
'description' => '修改AD办公网络下Windows云电脑的主机名称',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopHostName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyTimerGroup',
'description' => '修改配置组设置',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:ModifyTimerGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCenterPolicy',
'description' => '创建无地域策略',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:CreateCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCloudDrivePermission',
'description' => '修改用户在企业网盘与本地设备之间的文件传输权限',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCloudDrivePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenewNetworkPackages',
'description' => '续费包年包月公网精品带宽',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:RenewNetworkPackages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeFotaTasks',
'description' => '获取镜像升级任务列表',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeFotaTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCenterPolicyList',
'description' => '查询无地域策略',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCenterPolicyList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateNetworkPackage',
'description' => '为办公网络创建公网精品带宽',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateNetworkPackage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DetachEndUser',
'description' => '为无影硬件终端移除绑定用户',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:DetachEndUser',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudDiskGroupDrives',
'description' => '查询云盘团队空间',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDiskGroupDrives',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RevokeCoordinatePrivilege',
'description' => '取消流协同操作权限',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:RevokeCoordinatePrivilege',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopsInGroup',
'description' => '查询共享型云电脑内的云电脑',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDesktopsInGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCdsFile',
'description' => '创建文件夹或创建文件上传任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyUserEntitlement',
'description' => '为便捷用户新增或删除云电脑授权',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyUserEntitlement',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCloudDriveService',
'description' => '创建企业网盘',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateCloudDriveService',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDirectories',
'description' => '删除目录',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteDirectories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'VerifyCen',
'description' => '校验云企业网',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:VerifyCen',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ActivateOfficeSite',
'description' => '解锁办公网络',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ActivateOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResetSnapshot',
'description' => '恢复快照对应的磁盘数据',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ResetSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRefundPrice',
'description' => '查询按月购买云电脑的退订价格',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DescribeRefundPrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetConnectionTicket',
'description' => '获取连接凭证',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetConnectionTicket',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListUserAdOrganizationUnits',
'description' => '获取AD域的组织单元',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListUserAdOrganizationUnits',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'MigrateDesktops',
'description' => '将云电脑迁移至其他办公网络',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:MigrateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AttachEndUser',
'description' => '为无影硬件终端添加绑定用户',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:AttachEndUser',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDesktopGroupTimer',
'description' => '设置共享型云电脑定时任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetDesktopGroupTimer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UnbindConfigGroup',
'description' => '解绑配置组',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:UnbindConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RebootDesktops',
'description' => '重启一台或多台云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:RebootDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyOfficeSiteMfaEnabled',
'description' => '设置AD办公网络的多因素认证',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteMfaEnabled',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'LockVirtualMFADevice',
'description' => '锁定虚拟MFA设备',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:LockVirtualMFADevice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCdsFiles',
'description' => '查询网盘文件及获取文件下载链接',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ListCdsFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDevices',
'description' => '删除可信设备',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateFotaTask',
'description' => '为镜像升级任务打开或关闭自动推送',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:UpdateFotaTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CompleteCdsFile',
'description' => '完成文件上传',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:CompleteCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopMetadata',
'description' => '查询云桌面的元数据',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopMetadata',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGlobalTimerBatches',
'description' => '查询定时任务执行批次列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeGlobalTimerBatches',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyImagePermission',
'description' => '共享或取消共享镜像',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyImagePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeImageModifiedRecords',
'description' => '查询镜像变更记录',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeImageModifiedRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopSpec',
'description' => '变更云电脑配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopSpec',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTimerGroup',
'description' => '查询配置组详细信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeTimerGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateADConnectorDirectory',
'description' => '创建AD类型的目录',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateADConnectorDirectory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ClonePolicyGroup',
'description' => '克隆云电脑策略',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ClonePolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTransferFiles',
'description' => '查询传输文件信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListTransferFiles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAutoSnapshotPolicy',
'description' => '创建自动快照策略',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteOfficeSiteAccelerator',
'description' => '删除全球加速',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteOfficeSiteAccelerator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'MigrateImageProtocol',
'description' => '迁移镜像协议',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:MigrateImageProtocol',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDesktops',
'description' => '创建一台或多台云电脑',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDesktopGroupDetail',
'description' => '获取共享型云电脑详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetDesktopGroupDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyTemplateBaseInfo',
'description' => '修改自定义云电脑模板基本信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyTemplateBaseInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchModifyEntitlement',
'description' => '批量修改云电脑的用户授权',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:BatchModifyEntitlement',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDiskSpec',
'description' => '修改磁盘性能等级',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDiskSpec',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeKmsKeys',
'description' => '查询用户KMS密钥列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeKmsKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateImage',
'description' => '创建自定义镜像',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyADConnectorOfficeSite',
'description' => '修改AD办公网络',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyADConnectorOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDevices',
'description' => '查询可信设备列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudDiskGroups',
'description' => '查询云盘团队',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDiskGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSnapshots',
'description' => '查询云电脑的快照列表和详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeSnapshots',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCloudDriveUsers',
'description' => '添加用户个人盘',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateCloudDriveUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGuestApplications',
'description' => '查询云电脑指定用户的应用和进程信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeGuestApplications',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyOfficeSiteDnsInfo',
'description' => '修改办公网络DNS地址',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteDnsInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCustomizedListHeaders',
'description' => '修改云电脑列表页表头的显示类型',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCustomizedListHeaders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteNetworkPackages',
'description' => '删除公网精品带宽',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteNetworkPackages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenewDesktops',
'description' => '续费按月购买云电脑',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:RenewDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeUsersPassword',
'description' => '查询云电脑镜像内账号的密码',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeUsersPassword',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeUserConnectionRecords',
'description' => '查询共享型云电脑的用户连接记录',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeUserConnectionRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktops',
'description' => '查询云电脑详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAclEntries',
'description' => '查询公网访问控制策略详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeAclEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'HibernateDesktops',
'description' => '休眠一台或多台云电脑',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:HibernateDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyImageAttribute',
'description' => '修改镜像属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyImageAttribute',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateNASFileSystem',
'description' => '创建NAS文件系统',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateNASFileSystem',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'BindConfigGroup',
'description' => '绑定配置组',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:BindConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDesktopGroupScaleTimer',
'description' => '为多会话云电脑设置自动扩缩策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:SetDesktopGroupScaleTimer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RemoveUserFromDesktopGroup',
'description' => '为共享型云电脑移除授权用户',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:RemoveUserFromDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateOfficeSiteAccelerator',
'description' => '开通全球加速',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateOfficeSiteAccelerator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryHistoryUsageDurationRank',
'description' => '桌面历史使用时长排行榜查询',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:QueryHistoryUsageDurationRank',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSimpleOfficeSite',
'description' => '创建基于便捷账号的办公网络',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateSimpleOfficeSite',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListOfficeSiteUsers',
'description' => '查询AD账号信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListOfficeSiteUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDirectoryUsers',
'description' => '查询AD目录对应的用户信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListDirectoryUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListInstalledApps',
'description' => '查询云电脑内安装应用',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ListInstalledApps',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateQosRule',
'description' => '新建限速规则',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateQosRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelCdsFileShareLink',
'description' => '取消文件分享',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CancelCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRecordings',
'description' => '查询录屏详细信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeRecordings',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDesktopGroup',
'description' => '释放共享型云电脑',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyADConnectorDirectory',
'description' => '修改AD目录',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyADConnectorDirectory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeOnlineUserCount',
'description' => '查询在线用户数量指标',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeOnlineUserCount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RenewDesktopGroup',
'description' => '续费包年包月共享型云电脑',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:RenewDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteOfficeSites',
'description' => '删除办公网络',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteOfficeSites',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendVerifyCode',
'description' => '获取加入其他账号云企业网实例的验证码',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:SendVerifyCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCens',
'description' => '查询云企业网实例信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeCens',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSnapshot',
'description' => '删除一份或多份快照',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCloudDriveGroup',
'description' => '添加团队空间',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateCloudDriveGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ConfigADConnectorTrust',
'description' => '为AD办公网络配置信任关系',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ConfigADConnectorTrust',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDrive',
'description' => '删除用户级别存储资源',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteDrive',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCdsFileShareLink',
'description' => '修改文件分享',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ModifyCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateTemplate',
'description' => '创建自定义云电脑模板',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AttachCen',
'description' => '将高级办公网络与云企业网实例绑定',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:AttachCen',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCdsFileShareLinks',
'description' => '查询文件分享',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeCdsFileShareLinks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGlobalDesktopRecords',
'description' => '查询全局桌面及相关使用记录',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeGlobalDesktopRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportClientEvents',
'description' => '导出客户端事件列表',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ExportClientEvents',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyTemplate',
'description' => '修改自定义云电脑模板全部参数',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ApplyAutoSnapshotPolicy',
'description' => '将自动快照策略关联至云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ApplyAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRegions',
'description' => '查看可选的地域和可用区',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'MoveCdsFile',
'description' => '移动网盘文件',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:MoveCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetDirectorySsoStatus',
'description' => '设置AD办公网络的单点登录SSO开关状态',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:SetDirectorySsoStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportDesktopGroupInfo',
'description' => '导出共享型云电脑列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ExportDesktopGroupInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCdsFile',
'description' => '删除网盘文件',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DeleteCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'WakeupDesktops',
'description' => '唤醒一台或多台云电脑',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:WakeupDesktops',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DownloadCdsFile',
'description' => '下载企业网盘文件',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DownloadCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRenewalPrice',
'description' => '查询续费价格',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeRenewalPrice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCloudDriveUsers',
'description' => '删除用户个人盘',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteCloudDriveUsers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDesktopSessions',
'description' => '查询云电脑会话详情',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeDesktopSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyQosEntries',
'description' => '修改限速规则资源绑定关系',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyQosEntries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCloudDriveGroups',
'description' => '修改团队共享盘属性',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCloudDriveGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudDriveGroups',
'description' => '查询团队共享盘列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeCloudDriveGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetOfficeSiteSsoStatus',
'description' => '查询办公网络单点登录SSO开关状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:GetOfficeSiteSsoStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCdsFile',
'description' => '修改网盘文件属性',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:ModifyCdsFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDirectories',
'description' => '查询目录的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeDirectories',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyNetworkPackageEnabled',
'description' => '恢复或停用公网精品带宽',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyNetworkPackageEnabled',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeImagePermission',
'description' => '获取镜像已共享的阿里云账号列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeImagePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TransferTaskApprovalCallback',
'description' => '提交文件传输审批结果',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:TransferTaskApprovalCallback',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeVirtualMFADevices',
'description' => '查询AD账号绑定的虚拟MFA设备',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeVirtualMFADevices',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePolicyGroups',
'description' => '删除一个或多个自定义云电脑策略',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeletePolicyGroups',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableDesktopsInGroup',
'description' => '禁用共享型云电脑中的云电脑',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:DisableDesktopsInGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDrive',
'description' => '创建用户级别存储资源',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDrive',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCenterPolicy',
'description' => '删除无地域策略',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:DeleteCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyResourceCenterPolicy',
'description' => '修改资源关联的无地域策略',
'operationType' => 'none',
'ramAction' => [
'action' => 'ecd:ModifyResourceCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudDrivePermissions',
'description' => '查询企业网盘的权限设置详情',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeCloudDrivePermissions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteQosRules',
'description' => '删除限速规则。',
'operationType' => 'delete',
'ramAction' => [
'action' => 'ecd:DeleteQosRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UploadImage',
'description' => '上传自定义Windows镜像',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:UploadImage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisconnectDesktopSessions',
'description' => '断开云电脑会话',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:DisconnectDesktopSessions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSnapshot',
'description' => '为云电脑的磁盘创建一份快照',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateSnapshot',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyDesktopName',
'description' => '修改云电脑名称',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyDesktopName',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyConfigGroup',
'description' => '修改配置组基本信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:ModifyConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAutoSnapshotPolicy',
'description' => '修改自动快照策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyAutoSnapshotPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeNASFileSystems',
'description' => '查询NAS文件系统信息',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeNASFileSystems',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeFlowMetric',
'description' => '查询流入带宽和流出带宽',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeFlowMetric',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddFilePermission',
'description' => '新增网盘共享文件夹',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:AddFilePermission',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '查询云电脑已添加标签的列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeUsersInGroup',
'description' => '查询共享型云电脑授权用户详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeUsersInGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '为云电脑移除标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyCenterPolicy',
'description' => '修改无地域策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyCenterPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateConfigGroup',
'description' => '创建配置组',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:CreateConfigGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyOfficeSiteAccelerator',
'description' => '修改全球加速配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyOfficeSiteAccelerator',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeGlobalTimerRecords',
'description' => '查询全局定时任务执行记录',
'operationType' => 'list',
'ramAction' => [
'action' => 'ecd:DescribeGlobalTimerRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCdsFileShareLink',
'description' => '创建文件分享',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CreateCdsFileShareLink',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '为云电脑添加标签',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeNetworkPackages',
'description' => '查询公网精品带宽的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeNetworkPackages',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBundles',
'description' => '查询云电脑模板的详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'ecd:DescribeBundles',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelCoordinationForMonitoring',
'description' => '取消向终端用户发起的远程协助请求',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:CancelCoordinationForMonitoring',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDesktopGroup',
'description' => '创建共享型云电脑',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreateDesktopGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDrives',
'description' => '查询用户级别的存储资源',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:DescribeDrives',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePolicyGroup',
'description' => '创建云电脑策略',
'operationType' => 'create',
'ramAction' => [
'action' => 'ecd:CreatePolicyGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyEntitlement',
'description' => '为云电脑重新选择授权用户',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyEntitlement',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyQosRule',
'description' => '修改限速规则。',
'operationType' => 'update',
'ramAction' => [
'action' => 'ecd:ModifyQosRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AssociateNetworkPackage',
'description' => '为办公网络绑定公网精品带宽',
'operationType' => '',
'ramAction' => [
'action' => 'ecd:AssociateNetworkPackage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ECD', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];