diff options
Diffstat (limited to 'data/zh_cn/ecd/2020-10-02')
| -rw-r--r-- | data/zh_cn/ecd/2020-10-02/api-docs.php | 6071 |
1 files changed, 2051 insertions, 4020 deletions
diff --git a/data/zh_cn/ecd/2020-10-02/api-docs.php b/data/zh_cn/ecd/2020-10-02/api-docs.php index e7fadf2..5945001 100644 --- a/data/zh_cn/ecd/2020-10-02/api-docs.php +++ b/data/zh_cn/ecd/2020-10-02/api-docs.php @@ -1,98 +1,120 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'ecd', - 'version' => '2020-10-02', - ], + 'info' => ['style' => 'RPC', 'product' => 'ecd', 'version' => '2020-10-02'], 'directories' => [ [ - 'id' => 203311, - 'title' => '云资源管理', + 'children' => ['DescribeUserResources', 'ReportSessionStatus', 'GetCloudDriveServiceMountToken', 'VerifyCredential'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - 'DescribeDirectories', - 'DescribeOfficeSites', - 'DescribeGlobalDesktops', - 'DescribeUserResources', - 'UnbindUserDesktop', - 'GetConnectionTicket', - 'StartDesktops', - 'StopDesktops', - 'RebootDesktops', - 'ReportSessionStatus', - 'ApproveFotaUpdate', - 'DescribeSnapshots', - 'ResetSnapshot', - 'GetCloudDriveServiceMountToken', - 'VerifyCredential', - ], + 'title' => '云资源管理', + 'id' => 329336, ], [ - 'id' => 203310, + 'children' => ['GetLoginToken', 'RefreshLoginToken', 'SendTokenCode', 'ChangePassword', 'ResetPassword', 'EncryptPassword', 'DescribeFingerPrintTemplates', 'SetFingerPrintTemplate', 'SetFingerPrintTemplateDescription', 'DeleteFingerPrintTemplate'], + 'type' => 'directory', 'title' => '用户登录', + 'id' => 329324, + ], + [ + 'children' => ['ApproveFotaUpdate', 'DescribeDirectories', 'DescribeGlobalDesktops', 'DescribeOfficeSites', 'DescribeRegions', 'DescribeSnapshots', 'GetConnectionTicket', 'RebootDesktops', 'ResetSnapshot', 'StartDesktops', 'StopDesktops', 'UnbindUserDesktop'], + 'title' => '其他', 'type' => 'directory', - 'children' => [ - 'GetLoginToken', - 'RefreshLoginToken', - 'SendTokenCode', - 'ChangePassword', - 'ResetPassword', - 'EncryptPassword', - 'DescribeFingerPrintTemplates', - 'SetFingerPrintTemplate', - 'SetFingerPrintTemplateDescription', - 'DeleteFingerPrintTemplate', - 'IsKeepAlive', - ], ], ], 'components' => [ - 'schemas' => [ - 'OssUploadCredential' => [ - 'title' => 'A short description of struct', - 'description' => 'postpolicy文件上传凭证', - 'type' => 'object', - 'properties' => [ - 'Endpoint' => [ - 'title' => 'url', - 'type' => 'string', - ], - 'OssPolicy' => [ - 'title' => '策略', - 'type' => 'string', - ], - 'OssSignature' => [ - 'title' => '前面', - 'type' => 'string', - ], - 'AccessKeyId' => [ - 'title' => 'ak', - 'type' => 'string', - ], - 'FilePath' => [ - 'title' => '文件路径', + 'schemas' => [], + ], + 'apis' => [ + 'ApproveFotaUpdate' => [ + 'summary' => '允许云电脑OTA升级。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd4452bd7-88df-4b90-a409-806da674****'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '4771b873-c757-4893-973c-7f5beejh****'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****'], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-138dsptkrt00u****'], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => ['description' => '应用版本。', 'type' => 'string', 'required' => true, 'example' => '0.0.1-D-20220513.14****'], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的“关于”面板上查看该参数。', 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329c****'], + ], + [ + 'name' => 'TargetStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '指定云电脑升级之后的状态。'."\n" + ."\n" + .'> 该参数暂未对外开放使用。目前升级完成后，云电脑状态将变成`RUNNING`。', 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['running' => '运行中'], + 'example' => 'running', ], - 'StsToken' => [ - 'title' => '凭证', - 'type' => 'string', + ], + ], + '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****'], + ], ], ], ], - ], - ], - 'apis' => [ - 'DescribeRegions' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => '允许云电脑OTA升级', + 'changeSet' => [ + ['createdAt' => '2025-02-26T08:10:59.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-09-21T08:17:55.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-14T02:07:02.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-03-21T12:59:53.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'], + ], ], + 'ramActions' => [], + ], + 'ChangePassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -103,103 +125,150 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****'], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-227468****'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => '用户。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], + ], + [ + 'name' => 'OldPassword', + 'in' => 'query', + 'schema' => ['description' => '旧密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12345678'], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => ['description' => '新密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '67436290'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****', + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****'], + 'LoginToken' => ['description' => '登录凭证。', 'type' => 'string', 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]', + 'title' => '修改密码', + 'summary' => '修改用户密码。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangePassword'], + ], + ], + 'ramActions' => [], + ], + 'DeleteFingerPrintTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6df06330-3b75-4768-b334-41a73a64****'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****'], + ], + [ + 'name' => 'Index', + 'in' => 'query', + 'schema' => ['description' => '索引。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '4', 'minimum' => '1', 'example' => '1'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****'], + ], + ], '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', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看可选的地域和可用区', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]', + 'title' => '删除指纹模板', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFingerPrintTemplate'], + ], + ], + 'ramActions' => [], ], 'DescribeDirectories' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****'], ], [ 'name' => 'DirectoryId', @@ -208,12 +277,7 @@ 'schema' => [ 'description' => '目录ID列表。', 'type' => 'array', - 'items' => [ - 'description' => '目录ID。同办公网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], + 'items' => ['description' => '目录ID。同办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'], 'required' => false, 'maxItems' => 100, ], @@ -225,11 +289,7 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F369A091-002F-49C8-AD55-02A77629****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F369A091-002F-49C8-AD55-02A77629****'], 'Directories' => [ 'description' => '目录信息。', 'type' => 'array', @@ -237,36 +297,16 @@ 'description' => '目录信息。', 'type' => 'object', 'properties' => [ - 'DirectoryType' => [ - 'description' => '目录类型。', - 'type' => 'string', - 'example' => 'AD_CONNECTOR', - ], - 'SsoServiceUrl' => [ - 'description' => 'SSO连接。', - 'type' => 'string', - 'example' => 'https://eds-cn-shanghai-67726****', - ], + 'DirectoryType' => ['description' => '目录类型。', 'type' => 'string', 'example' => 'AD_CONNECTOR'], + 'SsoServiceUrl' => ['description' => 'SSO连接。', 'type' => 'string', 'example' => 'https://eds-cn-shanghai-67726****'], 'DesktopAccessType' => [ 'description' => '连接云电脑时允许使用的方式。', 'type' => 'string', - 'enumValueTitles' => [ - 'VPC连接' => '企业专网连接', - 'INTERNET' => '公网连接', - 'ANY' => '公网和企业专网连接都允许', - ], + 'enumValueTitles' => ['VPC连接' => '企业专网连接', 'INTERNET' => '公网连接', 'ANY' => '公网和企业专网连接都允许'], 'example' => 'INTERNET', ], - 'DirectoryId' => [ - 'description' => '目录ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'ProviderId' => [ - 'description' => '用户账号BID。', - 'type' => 'string', - 'example' => '26842', - ], + 'DirectoryId' => ['description' => '目录ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****'], + 'ProviderId' => ['description' => '用户账号BID。', 'type' => 'string', 'example' => '26842'], ], ], ], @@ -277,78 +317,43 @@ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A77629****\\",\\n \\"Directories\\": [\\n {\\n \\"DirectoryType\\": \\"AD_CONNECTOR\\",\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67726****\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ProviderId\\": \\"26842\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询目录详细信息', 'summary' => '查询目录详细信息。', - ], - 'DescribeOfficeSites' => [ - 'summary' => '查询办公网络的详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ], ], + 'ramActions' => [], + ], + 'DescribeFingerPrintTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '61e39dc6-0450-45f6-a372-2a09e938****'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'SessionId', '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, - 'maxItems' => 100, - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****'], ], [ - 'name' => 'Uuid', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'title' => 'uuid', - 'description' => 'uuid', - 'type' => 'string', - 'required' => false, - 'example' => 'ASDASD', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****'], ], ], 'responses' => [ @@ -357,73 +362,21 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OfficeSites' => [ - 'description' => '办公网络信息集合。', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****'], + 'FingerPrintTemplates' => [ + 'description' => '指纹模板对象。', 'type' => 'array', 'items' => [ - 'description' => '办公网络信息。', + 'description' => '指纹模板对象。', 'type' => 'object', 'properties' => [ - 'SsoServiceUrl' => [ - 'description' => 'SSO连接。', - 'type' => 'string', - 'example' => 'https://eds-cn-shanghai-67****', - ], - 'DesktopAccessType' => [ - 'description' => '连接办公网络时允许使用的接入方式。'."\n" - ."\n" - .'> VPC连接方式依赖于阿里云私网连接PrivateLink服务，该服务不收取费用。该参数设置为VPC或者Any时，系统将自动为您开通私网连接服务。', - 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNET' => '只允许客户端通过公网连接云电脑 [默认值]', - 'VPC' => '只允许处于VPC网络内的客户端连接云电脑', - 'Any' => '使用客户端连接云电脑时可以自行选择连接方式', - ], - 'example' => 'VPC', - ], - 'DesktopVpcEndpoint' => [ - 'description' => 'VPC连接云电脑时所使用的终端节点。', - 'type' => 'string', - 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'OfficeSiteType' => [ - 'description' => '办公网络账号系统类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'ad_connector' => 'AD域账号', - 'simple' => '便捷账号', - ], - 'example' => 'SIMPLE', - ], - 'ProviderId' => [ - 'description' => '用户账号BID。', - 'type' => 'string', - 'example' => '268****', - ], - 'OfficeSiteId' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'BizType' => [ - 'title' => 'biztype', - 'description' => 'biztype', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'ENTERPRISE', - ], - 'AliUid' => [ - 'title' => 'aliuid', - 'description' => 'aliuid', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '125552', - ], + 'Index' => ['description' => '索引。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CreationTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-03-13T13:26:29Z'], + 'LoginTime' => ['description' => '登录时间。', 'type' => 'string', 'example' => '2022-03-13T13:26:29Z'], + 'EndUserId' => ['description' => '用户。', 'type' => 'string', 'example' => 'alice'], + 'Description' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'Finger 1'], + 'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-074949****'], + 'ClientId' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****'], ], ], ], @@ -431,18 +384,22 @@ ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSites\\": [\\n {\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67****\\",\\n \\"DesktopAccessType\\": \\"VPC\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"ProviderId\\": \\"268****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"BizType\\": 0,\\n \\"AliUid\\": 125552\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询办公网络详细信息', - ], - 'DescribeGlobalDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C1D3FBE-84E1-5ABB-AD98-2003AC71****\\",\\n \\"FingerPrintTemplates\\": [\\n {\\n \\"Index\\": 1,\\n \\"CreationTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"LoginTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"Description\\": \\"Finger 1\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-074949****\\",\\n \\"ClientId\\": \\"2258a3d5-b8f8-4d79-a221-eaecf211****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询指纹模板', + 'summary' => '查询指纹模板。', + 'changeSet' => [ + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFingerPrintTemplates'], + ], ], + 'ramActions' => [], + ], + 'DescribeGlobalDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -451,9 +408,7 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '121369', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ @@ -464,71 +419,40 @@ 'type' => 'string', 'required' => false, 'docRequired' => true, - 'enumValueTitles' => [ - 'cn-shanghai' => '华东2（上海）', - ], + 'enumValueTitles' => ['cn-shanghai' => '华东2（上海）'], 'example' => 'cn-shanghai', ], ], [ 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。'."\n" - ."\n" - .'> 该参数即将停用，请使用`OfficeSiteId`。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-880841****', - ], + 'schema' => ['description' => '办公网络ID。'."\n" + ."\n" + .'> 该参数即将停用，请使用`OfficeSiteId`。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-880841****'], ], [ 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。'."\n" - ."\n" - .'> `DirectoryId`参数即将停用，请使用该字段。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-880841****', - ], + 'schema' => ['description' => '办公网络ID。'."\n" + ."\n" + .'> `DirectoryId`参数即将停用，请使用该字段。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-880841****'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。'."\n" - .'通过登录接口GetLoginToken获取，返回参数：SessionId。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****', - ], + 'schema' => ['description' => '会话ID。'."\n" + .'通过登录接口GetLoginToken获取，返回参数：SessionId。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。'."\n" - .'通过GetLoginToken接口登录获取，或登录后通过更新接口RefreshLoginToken获取。返回参数：LoginToken。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v147c9114a180489f89691663893169****', - ], + 'schema' => ['description' => '登录凭证。'."\n" + .'通过GetLoginToken接口登录获取，或登录后通过更新接口RefreshLoginToken获取。返回参数：LoginToken。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v147c9114a180489f89691663893169****'], ], [ 'name' => 'DesktopStatus', @@ -537,53 +461,27 @@ 'description' => '云电脑状态。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Stopped' => '已关机', - 'Starting' => '启动中', - 'Rebuilding' => '重建中', - 'Running' => '运行中', - 'Stopping' => '停止中', - 'Expired' => '已过期', - 'Deleted' => '已删除', - 'Pending' => '等待中', - ], + 'enumValueTitles' => ['Stopped' => '已关机', 'Starting' => '启动中', 'Rebuilding' => '重建中', 'Running' => '运行中', 'Stopping' => '停止中', 'Expired' => '已过期', 'Deleted' => '已删除', 'Pending' => '等待中'], 'example' => 'Running', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。'."\n" - ."\n" - .'- 最大值：500'."\n" - .'- 默认值：10', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '500', - ], + 'schema' => ['description' => '分页查询时每页行数。'."\n" + ."\n" + .'- 最大值：500'."\n" + .'- 默认值：10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '500'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', - 'type' => 'string', - 'required' => false, - 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****', - ], + 'schema' => ['description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****'], ], [ 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'description' => '云电脑名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'DesktopTest', - ], + 'schema' => ['description' => '云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'DesktopTest'], ], [ 'name' => 'DesktopId', @@ -592,12 +490,7 @@ 'schema' => [ 'description' => '云电脑ID。可设置一个或多个，取值范围：1~20。', 'type' => 'array', - 'items' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-hkbl45il187d6****', - ], + 'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-hkbl45il187d6****'], 'required' => false, 'maxItems' => 100, ], @@ -605,12 +498,7 @@ [ 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '搜索地域ID。用于过滤出指定地域的云电脑信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => '搜索地域ID。用于过滤出指定地域的云电脑信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'], ], [ 'name' => 'DesktopAccessType', @@ -621,35 +509,19 @@ .'> VPC连接方式依赖于阿里云私网连接（PrivateLink）服务，该服务不收取费用。该参数设置为VPC或者Any时，系统将自动为您开通私网连接服务。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'INTERNET' => '只允许客户端通过公网连接云电脑 [默认值]', - 'VPC' => '只允许处于VPC网络内的客户端连接云电脑', - 'Any' => '使用客户端连接云电脑时可以自行选择连接方式', - ], + 'enumValueTitles' => ['INTERNET' => '只允许客户端通过公网连接云电脑 [默认值]', 'VPC' => '只允许处于VPC网络内的客户端连接云电脑', 'Any' => '使用客户端连接云电脑时可以自行选择连接方式'], 'example' => 'INTERNET', ], ], [ 'name' => 'QueryFotaUpdate', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询镜像更新信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '是否查询镜像更新信息。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'WithoutLatency', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询实时云电脑信息。当前接口中云电脑状态信息有1~3秒延迟，如果需要准确信息可将此值设为`true`。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => '是否查询实时云电脑信息。当前接口中云电脑状态信息有1~3秒延迟，如果需要准确信息可将此值设为`true`。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'], ], [ 'name' => 'OrderBy', @@ -658,9 +530,7 @@ 'description' => '排序字段。若不指定则按照创建时间倒序排列。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'AssignTime' => '按照分配时间排序', - ], + 'enumValueTitles' => ['AssignTime' => '按照分配时间排序'], 'example' => 'AssignTime', ], ], @@ -671,43 +541,27 @@ 'description' => '排序方式。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '升序 [默认值]', - 'DESC' => '降序', - ], + 'enumValueTitles' => ['ASC' => '升序 [默认值]', 'DESC' => '降序'], 'example' => 'ASC', ], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '关键字。支持模糊搜索云电脑ID、云电脑名称和终端用户自定义的云电脑名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd', - ], + 'schema' => ['description' => '关键字。支持模糊搜索云电脑ID、云电脑名称和终端用户自定义的云电脑名称。', 'type' => 'string', 'required' => false, 'example' => 'ecd'], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络所在的地域ID，使用组织ID登录时置为空。'."\n" - ."\n" - .'- 使用办公网络ID登录时，该参数必填。'."\n" - .'- 使用组织ID登录时，该参数可为空。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '办公网络所在的地域ID，使用组织ID登录时置为空。'."\n" + ."\n" + .'- 使用办公网络ID登录时，该参数必填。'."\n" + .'- 使用组织ID登录时，该参数可为空。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -715,16 +569,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', - 'type' => 'string', - 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '4686A731-D601-548C-83E2-4CB6371E****', - ], + 'NextToken' => ['description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', 'type' => 'string', 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4686A731-D601-548C-83E2-4CB6371E****'], 'Desktops' => [ 'description' => '云电脑详细信息。', 'type' => 'array', @@ -732,108 +578,36 @@ 'description' => '云电脑详细信息。', 'type' => 'object', 'properties' => [ - 'CreationTime' => [ - 'description' => '云电脑的创建时间。', - 'type' => 'string', - 'example' => '2020-11-06T08:28Z', - ], + 'CreationTime' => ['description' => '云电脑的创建时间。', 'type' => 'string', 'example' => '2020-11-06T08:28Z'], 'ChargeType' => [ 'description' => '付费类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '按量付费', - 'PrePaid' => '包年包月', - ], + 'enumValueTitles' => ['PostPaid' => '按量付费', 'PrePaid' => '包年包月'], 'example' => 'PostPaid', ], - 'DesktopName' => [ - 'description' => '云电脑名称。', - 'type' => 'string', - 'example' => 'testDesktopName', - ], - 'HostName' => [ - 'description' => '主机名称。', - 'type' => 'string', - 'example' => 'testName', - ], - 'DesktopGroupId' => [ - 'description' => '共享型云电脑ID。', - 'type' => 'string', - 'example' => 'dg-3uiojcc0j4kh7****', - ], - 'DesktopId' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LastStartTime' => [ - 'description' => '上次开机时间，即最近一次的开机时间。', - 'type' => 'string', - 'example' => '2021-07-13T15:59Z', - ], - 'Cpu' => [ - 'description' => 'CPU个数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'EndUserId' => [ - 'description' => '终端用户名称。', - 'type' => 'string', - 'example' => 'alice', - ], - 'ExpiredTime' => [ - 'description' => '云电脑的过期时间。 '."\n" - ."\n" - .'- 对于包年包月云电脑，该返回值有实际意义。'."\n" - .'- 对于按量付费云电脑，均返回`2099-12-31T15:59Z`。', - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], - 'DesktopStatus' => [ - 'description' => '云电脑状态。', - 'type' => 'string', - 'example' => 'Running', - ], - 'DesktopType' => [ - 'description' => '云电脑规格。', - 'type' => 'string', - 'example' => 'ecd.basic.large', - ], + 'DesktopName' => ['description' => '云电脑名称。', 'type' => 'string', 'example' => 'testDesktopName'], + 'HostName' => ['description' => '主机名称。', 'type' => 'string', 'example' => 'testName'], + 'DesktopGroupId' => ['description' => '共享型云电脑ID。', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****'], + 'DesktopId' => ['description' => '云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'LastStartTime' => ['description' => '上次开机时间，即最近一次的开机时间。', 'type' => 'string', 'example' => '2021-07-13T15:59Z'], + 'Cpu' => ['description' => 'CPU个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'EndUserId' => ['description' => '终端用户名称。', 'type' => 'string', 'example' => 'alice'], + 'ExpiredTime' => ['description' => '云电脑的过期时间。 '."\n" + ."\n" + .'- 对于包年包月云电脑，该返回值有实际意义。'."\n" + .'- 对于按量付费云电脑，均返回`2099-12-31T15:59Z`。', 'type' => 'string', 'example' => '2021-12-31T15:59Z'], + 'DesktopStatus' => ['description' => '云电脑状态。', 'type' => 'string', 'example' => 'Running'], + 'DesktopType' => ['description' => '云电脑规格。', 'type' => 'string', 'example' => 'ecd.basic.large'], 'ConnectionStatus' => [ 'description' => '终端节点连接状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => '已连接', - 'Disconnecting' => '断开连接中', - 'Pending' => '修改中', - 'Connecting' => '连接中', - 'Disconnected' => '未连接', - 'Deleting' => '删除中', - ], + 'enumValueTitles' => ['Connected' => '已连接', 'Disconnecting' => '断开连接中', 'Pending' => '修改中', 'Connecting' => '连接中', 'Disconnected' => '未连接', 'Deleting' => '删除中'], 'example' => 'Disconnected', ], - 'Memory' => [ - 'description' => '云电脑的内存。单位：MiB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - ], - 'ImageId' => [ - 'description' => '镜像ID。', - 'type' => 'string', - 'example' => 'm-4zfb6zj728hhr****', - ], - 'DirectoryId' => [ - 'description' => '办公网络ID，同`OfficeSiteId`。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** ', - ], + 'Memory' => ['description' => '云电脑的内存。单位：MiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '4096'], + 'ImageId' => ['description' => '镜像ID。', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****'], + 'DirectoryId' => ['description' => '办公网络ID，同`OfficeSiteId`。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** '], 'Disks' => [ 'description' => '磁盘信息。', 'type' => 'array', @@ -844,33 +618,18 @@ 'DiskType' => [ 'description' => '磁盘类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '系统盘', - 'DATA' => '数据盘', - ], + 'enumValueTitles' => ['SYSTEM' => '系统盘', 'DATA' => '数据盘'], 'example' => 'SYSTEM', ], - 'DiskId' => [ - 'description' => '磁盘ID。', - 'type' => 'string', - 'example' => 'd-jedbpr4sl9l37****', - ], - 'DiskSize' => [ - 'description' => '磁盘大小。单位：GiB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], + 'DiskId' => ['description' => '磁盘ID。', 'type' => 'string', 'example' => 'd-jedbpr4sl9l37****'], + 'DiskSize' => ['description' => '磁盘大小。单位：GiB。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], ], ], ], 'OsType' => [ 'description' => '操作系统类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], 'example' => 'Windows', ], 'Sessions' => [ @@ -880,146 +639,56 @@ 'description' => '会话信息。', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => '终端用户信息。', - 'type' => 'string', - 'example' => 'alice', - ], - 'EstablishmentTime' => [ - 'description' => '会话创建时间。', - 'type' => 'string', - 'example' => '2021-03-07T08:23Z', - ], + 'EndUserId' => ['description' => '终端用户信息。', 'type' => 'string', 'example' => 'alice'], + 'EstablishmentTime' => ['description' => '会话创建时间。', 'type' => 'string', 'example' => '2021-03-07T08:23Z'], ], ], ], - 'PolicyGroupId' => [ - 'description' => '云电脑策略ID。', - 'type' => 'string', - 'example' => 'pg-9cktlowtxfl6****', - ], + 'PolicyGroupId' => ['description' => '云电脑策略ID。', 'type' => 'string', 'example' => 'pg-9cktlowtxfl6****'], 'EndUserIds' => [ 'description' => '终端用户列表。', 'type' => 'array', - 'items' => [ - 'description' => '终端用户名。', - 'type' => 'string', - 'example' => 'alice', - ], - ], - 'GpuMemory' => [ - 'description' => '显存大小。'."\n" - .'对于GPU型云电脑，该返回值有实际意义。单位：MB。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', + 'items' => ['description' => '终端用户名。', 'type' => 'string', 'example' => 'alice'], ], + 'GpuMemory' => ['description' => '显存大小。'."\n" + .'对于GPU型云电脑，该返回值有实际意义。单位：MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048'], 'FotaUpdate' => [ 'description' => '镜像的更新信息。', 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => '项目名称。', - 'type' => 'string', - 'example' => 'testProject', - ], - 'Channel' => [ - 'description' => '订阅通道。', - 'type' => 'string', - 'example' => 'Enterprise', - ], - 'CurrentAppVersion' => [ - 'description' => '云电脑当前版本号。', - 'type' => 'string', - 'example' => '0.0.0-D-20220102.xxxx', - ], - 'NewAppVersion' => [ - 'description' => '更新后的应用版本号。', - 'type' => 'string', - 'example' => '0.0.0-R-20220307.xxxx', - ], - 'Force' => [ - 'description' => '是否强制升级。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReleaseNote' => [ - 'description' => '可升级的版本描述。', - 'type' => 'string', - 'example' => '测试升级包03-07', - ], - 'Size' => [ - 'description' => '可升级的版本安装包大小。单位：MiB。', - 'type' => 'string', - 'example' => '100', - ], - 'ReleaseNoteEn' => [ - 'description' => '可升级的版本英文描述。', - 'type' => 'string', - 'example' => 'Release note', - ], - 'ReleaseNoteJp' => [ - 'description' => '可升级的版本日文描述。', - 'type' => 'string', - 'example' => 'リリースノート', - ], - 'NewDcdVersion' => [ - 'type' => 'string', - ], + 'Project' => ['description' => '项目名称。', 'type' => 'string', 'example' => 'testProject'], + 'Channel' => ['description' => '订阅通道。', 'type' => 'string', 'example' => 'Enterprise'], + 'CurrentAppVersion' => ['description' => '云电脑当前版本号。', 'type' => 'string', 'example' => '0.0.0-D-20220102.xxxx'], + 'NewAppVersion' => ['description' => '更新后的应用版本号。', 'type' => 'string', 'example' => '0.0.0-R-20220307.xxxx'], + 'Force' => ['description' => '是否强制升级。', 'type' => 'boolean', 'example' => 'false'], + 'ReleaseNote' => ['description' => '可升级的版本描述。', 'type' => 'string', 'example' => 'Test upgrade package 03-07'], + 'Size' => ['description' => '可升级的版本安装包大小。单位：MiB。', 'type' => 'string', 'example' => '100'], + 'ReleaseNoteEn' => ['description' => '可升级的版本英文描述。', 'type' => 'string', 'example' => 'Release note'], + 'ReleaseNoteJp' => ['description' => '可升级的版本日文描述。', 'type' => 'string', 'example' => 'リリースノート'], + 'NewDcdVersion' => ['type' => 'string', 'description' => ''], ], ], 'ProtocolType' => [ 'description' => '协议类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => 'HDX协议', - 'ASP' => '阿里云自研ASP协议', - ], + 'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里云自研ASP协议'], 'example' => 'ASP', ], - 'OfficeSiteId' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'NetworkInterfaceIp' => [ - 'description' => '网卡IP。', - 'type' => 'string', - 'example' => '192.168.XX.XX', - ], - 'UserCustomName' => [ - 'description' => '用户自定义的云电脑名称。', - 'type' => 'string', - 'example' => 'testDesktop', - ], + 'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'], + 'NetworkInterfaceIp' => ['description' => '网卡IP。', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'UserCustomName' => ['description' => '用户自定义的云电脑名称。', 'type' => 'string', 'example' => 'testDesktop'], 'ManagementFlags' => [ 'description' => '云电脑管理状态列表。', 'type' => 'array', 'items' => [ 'description' => '云电脑管理状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'UNDER_MAINTENANCE' => '维护模式中', - 'MIGRATING' => '办公网络迁移中', - 'ASSIGNING' => '分配用户中', - 'MIGRATING_PROTOCOL' => '协议迁移中', - 'NO_FLAG' => '无状态', - 'ENTER_MAINTENANCE' => '进入维护模式中', - 'UPDATING' => '升级中', - ], + 'enumValueTitles' => ['UNDER_MAINTENANCE' => '维护模式中', 'MIGRATING' => '办公网络迁移中', 'ASSIGNING' => '分配用户中', 'MIGRATING_PROTOCOL' => '协议迁移中', 'NO_FLAG' => '无状态', 'ENTER_MAINTENANCE' => '进入维护模式中', 'UPDATING' => '升级中'], 'example' => 'UPDATING', ], ], - 'LocalName' => [ - 'description' => '地域名称。', - 'type' => 'string', - 'example' => '华东2（上海）', - ], - 'RealDesktopId' => [ - 'description' => '如果是共享型云电脑并且已分配真实云电脑，则显示云电脑ID。', - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsm****', - ], + 'LocalName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Shanghai)'], + 'RealDesktopId' => ['description' => '如果是共享型云电脑并且已分配真实云电脑，则显示云电脑ID。', 'type' => 'string', 'example' => 'ecd-gx2x1dhsm****'], 'DesktopTimers' => [ 'description' => '云电脑定时器对象。', 'type' => 'array', @@ -1029,66 +698,30 @@ 'TimerType' => [ 'description' => '定时任务类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '无操作断连', - 'NoConnectShutdown' => '无连接关机', - 'TimerBoot' => '定时开机', - 'TimerReset' => '定时重置', - 'NoOperationShutdown' => '无操作关机', - 'TimerShutdown' => '定时关机', - 'NoOperationReboot' => '无操作重启', - 'TimerReboot' => '定时重启', - ], + 'enumValueTitles' => ['NoOperationDisconnect' => '无操作断连', 'NoConnectShutdown' => '无连接关机', 'TimerBoot' => '定时开机', 'TimerReset' => '定时重置', 'NoOperationShutdown' => '无操作关机', 'TimerShutdown' => '定时关机', 'NoOperationReboot' => '无操作重启', 'TimerReboot' => '定时重启'], 'example' => 'NoConnectShutdown', ], - 'CronExpression' => [ - 'description' => '定时任务Cron表达式。'."\n" - ."\n" - .'例如：`0 0 4 1/1 * ?`表示从每月第一天上午4时开始，每天执行操作。', - 'type' => 'string', - 'example' => '0 0 0 ? * 1', - ], - 'Interval' => [ - 'description' => '时间间隔，单位为秒。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Enforce' => [ - 'description' => '是否强制执行。为`true`表示忽略云电脑及连接状态检测，强制执行定时任务。', - 'type' => 'boolean', - 'example' => 'false', - ], + 'CronExpression' => ['description' => '定时任务Cron表达式。'."\n" + ."\n" + .'例如：`0 0 4 1/1 * ?`表示从每月第一天上午4时开始，每天执行操作。', 'type' => 'string', 'example' => '0 0 0 ? * 1'], + 'Interval' => ['description' => '时间间隔，单位为秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'Enforce' => ['description' => '是否强制执行。为`true`表示忽略云电脑及连接状态检测，强制执行定时任务。', 'type' => 'boolean', 'example' => 'false'], 'ResetType' => [ 'description' => '如果是重置任务，需设置重置类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '重置系统盘', - 'RESET_TYPE_USER_DISK' => '重置数据盘', - 'RESET_TYPE_BOTH' => '重置系统盘和数据盘', - ], + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => '重置系统盘', 'RESET_TYPE_USER_DISK' => '重置数据盘', 'RESET_TYPE_BOTH' => '重置系统盘和数据盘'], 'example' => 'RESET_TYPE_BOTH', ], - 'AllowClientSetting' => [ - 'description' => '是否允许客户端设置策略。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'AllowClientSetting' => ['description' => '是否允许客户端设置策略。', 'type' => 'boolean', 'example' => 'true'], 'OperationType' => [ 'description' => '定时任务类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'HIBERNATE' => '休眠', - 'SHUTDOWN' => '关机', - ], + 'enumValueTitles' => ['HIBERNATE' => '休眠', 'SHUTDOWN' => '关机'], 'example' => 'SHUTDOWN', ], - 'ExecutionTime' => [ - 'description' => '任务执行时间。', - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], + 'ExecutionTime' => ['description' => '任务执行时间。', 'type' => 'string', 'example' => '2021-12-31T15:59Z'], ], + 'description' => '', ], ], 'Clients' => [ @@ -1101,23 +734,13 @@ 'Status' => [ 'description' => '客户端状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'OFF' => '不允许登录', - 'ON' => '允许登录', - ], + 'enumValueTitles' => ['OFF' => '不允许登录', 'ON' => '允许登录'], 'example' => 'ON', ], 'ClientType' => [ 'description' => '客户端类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'html5' => 'Web客户端', - 'android' => 'Android客户端', - 'linux' => 'Linux客户端', - 'ios' => 'iOS客户端', - 'windows' => 'Windows客户端', - 'macos' => 'macOS客户端', - ], + 'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'linux' => 'Linux客户端', 'ios' => 'iOS客户端', 'windows' => 'Windows客户端', 'macos' => 'macOS客户端'], 'example' => 'windows', ], ], @@ -1126,72 +749,328 @@ 'SupportHibernation' => [ 'description' => '是否支持休眠。', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '支持', - 'false' => '不支持', - ], - 'example' => 'true', - ], - 'HibernationBeta' => [ - 'description' => '是否为休眠测试版本。', - 'type' => 'boolean', + 'enumValueTitles' => ['true' => '支持', 'false' => '不支持'], 'example' => 'true', ], + 'HibernationBeta' => ['description' => '是否为休眠测试版本。', 'type' => 'boolean', 'example' => 'true'], 'SessionType' => [ 'description' => '会话类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '单会话', - 'MULTIPLE_SESSION' => '多会话', - ], + 'enumValueTitles' => ['SINGLE_SESSION' => '单会话', 'MULTIPLE_SESSION' => '多会话'], 'example' => 'SINGLE_SESSION', ], 'Platform' => [ 'description' => '操作系统平台信息。', 'type' => 'string', - 'enumValueTitles' => [ - 'Ubuntu' => 'Ubuntu', - 'UOS' => 'UOS', - 'CentOS' => 'CentOS', - 'Windows Server 2019' => 'Windows Server 2019', - 'Windows Server 2016' => 'Windows Server 2016', - ], + 'enumValueTitles' => ['Ubuntu' => 'Ubuntu', 'UOS' => 'UOS', 'CentOS' => 'CentOS', 'Windows Server 2019' => 'Windows Server 2019', 'Windows Server 2016' => 'Windows Server 2016'], 'example' => 'Ubuntu', ], - 'Os' => [ - 'description' => '操作系统类型', + 'Os' => ['description' => '操作系统类型', 'type' => 'string', 'example' => 'Windows'], + 'RegionLocation' => ['type' => 'string', 'description' => ''], + 'OsDescription' => ['type' => 'string', 'description' => ''], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****\\",\\n \\"RequestId\\": \\"4686A731-D601-548C-83E2-4CB6371E****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"HostName\\": \\"testName\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastStartTime\\": \\"2021-07-13T15:59Z\\",\\n \\"Cpu\\": 2,\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"Memory\\": 4096,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\t\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80\\n }\\n ],\\n \\"OsType\\": \\"Windows\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\"\\n }\\n ],\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"GpuMemory\\": 2048,\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"testProject\\",\\n \\"Channel\\": \\"Enterprise\\",\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.xxxx\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.xxxx\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"Test upgrade package 03-07\\",\\n \\"Size\\": \\"100\\",\\n \\"ReleaseNoteEn\\": \\"Release note\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\",\\n \\"NewDcdVersion\\": \\"\\"\\n },\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"UserCustomName\\": \\"testDesktop\\",\\n \\"ManagementFlags\\": [\\n \\"UPDATING\\"\\n ],\\n \\"LocalName\\": \\"China (Shanghai)\\",\\n \\"RealDesktopId\\": \\"ecd-gx2x1dhsm****\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"NoConnectShutdown\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1\\",\\n \\"Interval\\": 60,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_BOTH\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"SHUTDOWN\\",\\n \\"ExecutionTime\\": \\"2021-12-31T15:59Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"Os\\": \\"Windows\\",\\n \\"RegionLocation\\": \\"\\",\\n \\"OsDescription\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询全地域云电脑详细信息', + 'summary' => '查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询（不包含：南京-本地地域-关停中）。', + 'description' => '- 此接口为中心化域名，接入点为上海，不支持其他地域调用。'."\n" + .'- 此接口中的云电脑状态信息与实际值有1~3秒的延迟。', + 'changeSet' => [ + ['createdAt' => '2024-11-09T02:21:08.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-09-27T07:36:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-08-13T06:27:02.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-13T06:21:55.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-12-11T04:08:14.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-08-02T09:43:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-05-18T06:08:48.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2023-03-22T07:33:19.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-11-29T11:34:30.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-10-27T10:48:27.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-10-18T15:10:47.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-22T12:51:03.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-06-06T03:16:47.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktops'], + ], + ], + 'ramActions' => [], + ], + 'DescribeOfficeSites' => [ + 'summary' => '查询办公网络的详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****'], + ], + [ + '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, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['title' => 'uuid', 'description' => 'uuid', 'type' => 'string', 'required' => false, 'example' => 'ASDASD'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息集合。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'OfficeSites' => [ + 'description' => '办公网络信息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '办公网络信息。', + 'type' => 'object', + 'properties' => [ + 'SsoServiceUrl' => ['description' => 'SSO连接。', 'type' => 'string', 'example' => 'https://eds-cn-shanghai-67****'], + 'DesktopAccessType' => [ + 'description' => '连接办公网络时允许使用的接入方式。'."\n" + ."\n" + .'> VPC连接方式依赖于阿里云私网连接PrivateLink服务，该服务不收取费用。该参数设置为VPC或者Any时，系统将自动为您开通私网连接服务。', 'type' => 'string', - 'example' => 'Windows', + 'enumValueTitles' => ['INTERNET' => '只允许客户端通过公网连接云电脑 [默认值]', 'VPC' => '只允许处于VPC网络内的客户端连接云电脑', 'Any' => '使用客户端连接云电脑时可以自行选择连接方式'], + 'example' => 'VPC', ], - 'RegionLocation' => [ + 'DesktopVpcEndpoint' => ['description' => 'VPC连接云电脑时所使用的终端节点。', 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com'], + 'OfficeSiteType' => [ + 'description' => '办公网络账号系统类型。', 'type' => 'string', + 'enumValueTitles' => ['ad_connector' => 'AD域账号', 'simple' => '便捷账号'], + 'example' => 'SIMPLE', ], - 'OsDescription' => [ + 'ProviderId' => ['description' => '用户账号BID。', 'type' => 'string', 'example' => '268****'], + 'OfficeSiteId' => ['description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****'], + 'BizType' => ['title' => 'biztype', 'description' => 'biztype', 'type' => 'integer', 'format' => 'int32', 'example' => 'ENTERPRISE'], + 'AliUid' => ['title' => 'aliuid', 'description' => 'aliuid', 'type' => 'integer', 'format' => 'int64', 'example' => '125552'], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSites\\": [\\n {\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67****\\",\\n \\"DesktopAccessType\\": \\"VPC\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"ProviderId\\": \\"268****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"BizType\\": 0,\\n \\"AliUid\\": 125552\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询办公网络详细信息', + 'changeSet' => [ + ['createdAt' => '2025-10-24T07:30:13.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2023-01-09T11:54:21.000Z', 'description' => '响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOfficeSites'], + ], + ], + 'ramActions' => [], + ], + 'DescribeRegions' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****'], + ], + ], + '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'], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查看可选的地域和可用区', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + ], + 'ramActions' => [], + ], + 'DescribeSnapshots' => [ + 'summary' => '查询一台云电脑的快照列表和快照详细信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + '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, 'example' => 'ecd-gx2x1dhsmucyy****'], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => '分页查询时，每页最大行数。默认值：100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => '快照创建时间。按照[ISO8601](~~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' => '正在创建的快照剩余完成时间。单位：秒。', '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****'], + 'RestorePointId' => ['description' => '还原点ID。', 'type' => 'string', 'example' => 'rp-btgmaa20wkcju****'], + 'RestorePointName' => ['description' => '还原点名称。', 'type' => 'string', 'example' => 'Data disk backup'], ], + 'description' => '', ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****\\",\\n \\"RequestId\\": \\"4686A731-D601-548C-83E2-4CB6371E****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"HostName\\": \\"testName\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastStartTime\\": \\"2021-07-13T15:59Z\\",\\n \\"Cpu\\": 2,\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"Memory\\": 4096,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\t\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80\\n }\\n ],\\n \\"OsType\\": \\"Windows\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\"\\n }\\n ],\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"GpuMemory\\": 2048,\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"testProject\\",\\n \\"Channel\\": \\"Enterprise\\",\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.xxxx\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.xxxx\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": \\"100\\",\\n \\"ReleaseNoteEn\\": \\"Release note\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\",\\n \\"NewDcdVersion\\": \\"\\"\\n },\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"UserCustomName\\": \\"testDesktop\\",\\n \\"ManagementFlags\\": [\\n \\"UPDATING\\"\\n ],\\n \\"LocalName\\": \\"华东2（上海）\\",\\n \\"RealDesktopId\\": \\"ecd-gx2x1dhsm****\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"NoConnectShutdown\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1\\",\\n \\"Interval\\": 60,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_BOTH\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"SHUTDOWN\\",\\n \\"ExecutionTime\\": \\"2021-12-31T15:59Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"Os\\": \\"Windows\\",\\n \\"RegionLocation\\": \\"\\",\\n \\"OsDescription\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询全地域云电脑详细信息', - 'summary' => '查询多个地域的云电脑详细信息。目前仅支持中国内地对应的地域查询（不包含：南京-本地地域-关停中）。', - 'description' => '- 此接口为中心化域名，接入点为上海，不支持其他地域调用。'."\n" - .'- 此接口中的云电脑状态信息与实际值有1~3秒的延迟。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"Data disk backup\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询云电脑快照信息', + 'changeSet' => [ + ['createdAt' => '2025-01-15T01:27:24.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2021-11-18T00:29:27.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSnapshots'], + ], + ], + 'ramActions' => [], ], 'DescribeUserResources' => [ 'summary' => '查询用户资源列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -1204,9 +1083,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169949', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1214,13 +1091,7 @@ [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID，参考UUID。该参数非敏感字段，无需加密。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', - ], + 'schema' => ['description' => '客户端生成的唯一ID，参考UUID。该参数非敏感字段，无需加密。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****'], ], [ 'name' => 'ClientType', @@ -1230,71 +1101,35 @@ 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'html5' => 'Web客户端', - 'android' => 'Android客户端', - 'windows' => 'Windows客户端', - 'ios' => 'iOS客户端', - 'macos' => 'macOS客户端', - ], + 'enumValueTitles' => ['html5' => 'Web客户端', 'android' => 'Android客户端', 'windows' => 'Windows客户端', 'ios' => 'iOS客户端', 'macos' => 'macOS客户端'], 'example' => 'windows', ], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'title' => '客户端版本', - 'description' => '客户端版本。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7.6.0-R-20241112.222305', - ], + 'schema' => ['title' => '客户端版本', 'description' => '客户端版本。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '7.6.0-R-20241112.222305'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。'."\n" - .'通过`GetLoginToken`接口登录获取，或登录后通过更新接口`RefreshLoginToken`获取。返回参数：LoginToken。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '登录凭证。'."\n" + .'通过`GetLoginToken`接口登录获取，或登录后通过更新接口`RefreshLoginToken`获取。返回参数：LoginToken。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。调用`GetLoginToken`接口获取。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '会话ID。调用`GetLoginToken`接口获取。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'title' => '登录的地域ID，用于工作区ID登录场景。', - 'description' => '登录的地域ID，用于办公网络ID登录场景。组织ID登录场景无需填写。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '登录的地域ID，用于工作区ID登录场景。', 'description' => '登录的地域ID，用于办公网络ID登录场景。组织ID登录场景无需填写。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => '搜索地域ID。用于过滤出指定地域的云资源信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '搜索地域ID。用于过滤出指定地域的云资源信息。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'OfficeSiteIds', @@ -1304,13 +1139,7 @@ 'title' => '工作区ID列表。', 'description' => '办公网络ID列表。AD账号登录时填写。', 'type' => 'array', - 'items' => [ - 'title' => '工作区ID。', - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-5440****', - ], + 'items' => ['title' => '工作区ID。', 'description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-5440****'], 'required' => false, 'maxItems' => 100, ], @@ -1333,12 +1162,7 @@ 'description' => '资源类型。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'App' => '云应用（含云应用、云手机、云浏览器）', - 'Desktop' => '云电脑', - 'DesktopGroup' => '共享型云电脑', - 'CloudDrive' => '企业网盘', - ], + 'enumValueTitles' => ['App' => '云应用（含云应用、云手机、云浏览器）', 'Desktop' => '云电脑', 'DesktopGroup' => '共享型云电脑', 'CloudDrive' => '企业网盘'], 'example' => 'Desktop', ], 'required' => false, @@ -1365,12 +1189,7 @@ 'description' => '产品类型。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', - 'CloudApp' => '云应用', - 'CloudBrowser' => '云浏览器', - 'AndroidCloud' => '云手机', - ], + 'enumValueTitles' => ['CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', 'CloudApp' => '云应用', 'CloudBrowser' => '云浏览器', 'AndroidCloud' => '云手机'], 'example' => 'CloudApp', ], 'required' => false, @@ -1387,13 +1206,7 @@ 'description' => '资源ID列表。'."\n" .'可设置0\\~100个。', 'type' => 'array', - 'items' => [ - 'title' => '资源ID', - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-00001', - ], + 'items' => ['title' => '资源ID', 'description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-00001'], 'required' => false, 'maxItems' => 100, ], @@ -1401,13 +1214,7 @@ [ 'name' => 'ResourceName', 'in' => 'query', - 'schema' => [ - 'title' => '资源名称，支持模糊搜索。', - 'description' => '资源名称，支持模糊搜索。', - 'type' => 'string', - 'required' => false, - 'example' => 'testName', - ], + 'schema' => ['title' => '资源名称，支持模糊搜索。', 'description' => '资源名称，支持模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'testName'], ], [ 'name' => 'ProtocolType', @@ -1419,10 +1226,7 @@ 'description' => '协议类型。该参数仅用于过滤云电脑。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'HDX' => 'HDX协议', - 'ASP' => '阿里巴巴自研ASP协议', - ], + 'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里巴巴自研ASP协议'], 'example' => 'ASP', ], ], @@ -1437,10 +1241,7 @@ 'description' => '接入类型，不传表示两种都显示。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'INTERNET' => '互联网接入', - 'VPC' => '企业专网接入', - ], + 'enumValueTitles' => ['INTERNET' => '互联网接入', 'VPC' => '企业专网接入'], 'example' => 'INTERNET', ], ], @@ -1452,59 +1253,29 @@ 'description' => '客户端语言。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'en_US' => '英语', - 'zh_CN' => '简体中文', - 'ja_JP' => '日语', - ], + 'enumValueTitles' => ['en_US' => '英语', 'zh_CN' => '简体中文', 'ja_JP' => '日语'], 'example' => 'zh-CN', ], ], [ 'name' => 'CategoryType', 'in' => 'query', - 'schema' => [ - 'title' => '资源一级类目。', - 'description' => '资源一级类目。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '资源一级类目。', 'description' => '资源一级类目。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'title' => '资源二级类目', - 'description' => '资源二级类目。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['title' => '资源二级类目', 'description' => '资源二级类目。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'QueryFotaUpdate', 'in' => 'query', - 'schema' => [ - 'description' => '是否查询云电脑镜像版本信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => '是否查询云电脑镜像版本信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'], ], [ 'name' => 'RefreshFotaUpdate', 'in' => 'query', - 'schema' => [ - 'title' => '是否实时刷新OTA信息。', - 'description' => '是否实时刷新OTA信息。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '是否实时刷新OTA信息。', 'description' => '是否实时刷新OTA信息。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'OrderBy', @@ -1513,10 +1284,7 @@ 'description' => '排序字段，若不指定则按照创建时间倒序。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CreateTime' => '资源创建时间', - 'AssignTime' => '资源授权时间', - ], + 'enumValueTitles' => ['CreateTime' => '资源创建时间', 'AssignTime' => '资源授权时间'], 'example' => 'AssignTime', ], ], @@ -1527,34 +1295,19 @@ 'description' => '排序方式。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '升序 [默认值]', - 'DESC' => '降序', - ], + 'enumValueTitles' => ['ASC' => '升序 [默认值]', 'DESC' => '降序'], 'example' => 'ASC', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时每页行数。 默认值500。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '500', - ], + 'schema' => ['description' => '分页查询时每页行数。 默认值500。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '500'], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => '下一页Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => '下一页Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'], ], [ 'name' => 'AutoRefresh', @@ -1566,10 +1319,7 @@ .'> 为了保证接口响应速度，建议传入`false`。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'false' => '不立即刷新', - 'true' => '立即刷新', - ], + 'enumValueTitles' => ['false' => '不立即刷新', 'true' => '立即刷新'], 'example' => 'false', ], ], @@ -1581,9 +1331,7 @@ 'description' => '客户端场景，用于标识排序。请传入`desktop`。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'desktop' => '云电脑', - ], + 'enumValueTitles' => ['desktop' => '云电脑'], 'example' => 'desktop', ], ], @@ -1596,9 +1344,7 @@ 'type' => 'boolean', 'deprecated' => true, 'required' => false, - 'enumValueTitles' => [ - 'false' => '非双中心转发', - ], + 'enumValueTitles' => ['false' => '非双中心转发'], 'example' => 'false', ], ], @@ -1610,10 +1356,7 @@ 'description' => '是否查询云电脑定时任务信息，默认为true。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '是，默认值', - 'false' => '否', - ], + 'enumValueTitles' => ['true' => '是，默认值', 'false' => '否'], 'example' => 'true', 'default' => 'true', ], @@ -1626,10 +1369,7 @@ 'description' => '是否查询云桌面套餐包信息，默认为true。', 'type' => 'boolean', 'required' => false, - 'enumValueTitles' => [ - 'true' => '是，默认值', - 'false' => '否', - ], + 'enumValueTitles' => ['true' => '是，默认值', 'false' => '否'], 'example' => 'true', 'default' => 'true', ], @@ -1640,16 +1380,8 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => '下一页查询开始的Token，NextToken为空表示没有下一页。', - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'NextToken' => ['description' => '下一页查询开始的Token，NextToken为空表示没有下一页。', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], 'QueryFailedResourceTypes' => [ 'title' => '查询失败的资源类型列表。取值范围：'."\n" .'CloudDesktop：云桌面（含云电脑和云电脑池）'."\n" @@ -1660,11 +1392,7 @@ 'items' => [ 'description' => '资源类型', 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', - 'CloudApp' => '云应用（含云应用、云手机、云浏览器）', - 'CloudDrive' => '企业网盘', - ], + 'enumValueTitles' => ['CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', 'CloudApp' => '云应用（含云应用、云手机、云浏览器）', 'CloudDrive' => '企业网盘'], 'example' => 'CloudDesktop', ], 'enumValueTitles' => [], @@ -1678,12 +1406,7 @@ 'description' => '资源详细信息。', 'type' => 'object', 'properties' => [ - 'AliUid' => [ - 'description' => '阿里云账号ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '194101959****', - ], + 'AliUid' => ['description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '194101959****'], 'ResourceType' => [ 'title' => '资源类型。取值范围：'."\n" .'云桌面：Desktop'."\n" @@ -1692,42 +1415,19 @@ .'云盘：CloudDrive', 'description' => '资源类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'App' => '云应用（含云应用、云手机、云浏览器）', - 'Desktop' => '云电脑', - 'DesktopGroup' => '共享型云电脑', - 'CloudDrive' => '企业网盘', - ], + 'enumValueTitles' => ['App' => '云应用（含云应用、云手机、云浏览器）', 'Desktop' => '云电脑', 'DesktopGroup' => '共享型云电脑', 'CloudDrive' => '企业网盘'], 'example' => 'Desktop', ], - 'RegionId' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'RegionId' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], 'RegionLocation' => [ 'title' => '地域位置。', 'description' => '地域位置。', 'type' => 'string', - 'enumValueTitles' => [ - 'Mainland' => '中国内地地域', - 'Overseas' => '海外地域（含中国香港）', - ], + 'enumValueTitles' => ['Mainland' => '中国内地地域', 'Overseas' => '海外地域（含中国香港）'], 'example' => 'Mainland', ], - 'ResourceGroupId' => [ - 'title' => '资源组ID。', - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'dg-0****', - ], - 'ResourceId' => [ - 'title' => '资源ID。', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'ecd-d19tya8zi4****', - ], + 'ResourceGroupId' => ['title' => '资源组ID。', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'dg-0****'], + 'ResourceId' => ['title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'ecd-d19tya8zi4****'], 'ResourceLevel' => [ 'title' => '资源级别。'."\n" .'取值范围：'."\n" @@ -1735,30 +1435,12 @@ .'单元：Region', 'description' => '资源级别。', 'type' => 'string', - 'enumValueTitles' => [ - 'Center' => '中心化资源', - 'Region' => '单元化资源', - ], + 'enumValueTitles' => ['Center' => '中心化资源', 'Region' => '单元化资源'], 'example' => 'Center', ], - 'CenterResourceId' => [ - 'title' => '中心化资源ID。', - 'description' => '中心化资源ID。', - 'type' => 'string', - 'example' => 'ecds-0****', - ], - 'ResourceName' => [ - 'title' => '资源名称。', - 'description' => '资源名称。', - 'type' => 'string', - 'example' => 'testName01', - ], - 'CreateTime' => [ - 'title' => '资源创建时间。', - 'description' => '资源创建时间。', - 'type' => 'string', - 'example' => '2024-12-11T07:12:12Z', - ], + 'CenterResourceId' => ['title' => '中心化资源ID。', 'description' => '中心化资源ID。', 'type' => 'string', 'example' => 'ecds-0****'], + 'ResourceName' => ['title' => '资源名称。', 'description' => '资源名称。', 'type' => 'string', 'example' => 'testName01'], + 'CreateTime' => ['title' => '资源创建时间。', 'description' => '资源创建时间。', 'type' => 'string', 'example' => '2024-12-11T07:12:12Z'], 'ProductType' => [ 'title' => '产品类型。'."\n" .'CloudDesktop - 云桌面'."\n" @@ -1766,20 +1448,10 @@ .'AndroidCloud - 安卓云', 'description' => '产品类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', - 'CloudApp' => '云应用', - 'CloudBrowser' => '云浏览器', - 'AndroidCloud' => '云手机', - ], + 'enumValueTitles' => ['CloudDesktop' => '云电脑（含云电脑和共享型云电脑）', 'CloudApp' => '云应用', 'CloudBrowser' => '云浏览器', 'AndroidCloud' => '云手机'], 'example' => 'AndroidCloud', ], - 'OfficeSiteId' => [ - 'title' => '工作区ID。', - 'description' => '办公网络ID。', - 'type' => 'string', - 'example' => 'cn-shanghai+dir-3367****', - ], + 'OfficeSiteId' => ['title' => '工作区ID。', 'description' => '办公网络ID。', 'type' => 'string', 'example' => 'cn-shanghai+dir-3367****'], 'AccessType' => [ 'title' => '接入类型。'."\n" .'取值范围：'."\n" @@ -1788,11 +1460,7 @@ .'- ANY(互联网和企业专网均可以)', 'description' => '接入类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNET' => '互联网接入', - 'VPC' => '企业专网接入', - 'ANY' => '互联网接入和企业专网接入均可以', - ], + 'enumValueTitles' => ['INTERNET' => '互联网接入', 'VPC' => '企业专网接入', 'ANY' => '互联网接入和企业专网接入均可以'], 'example' => 'INTERNET', ], 'ProtocolType' => [ @@ -1801,10 +1469,7 @@ .'- ASP(阿里巴巴自研ASP协议)', 'description' => '协议类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => 'HDX协议', - 'ASP' => '阿里巴巴自研ASP协议', - ], + 'enumValueTitles' => ['HDX' => 'HDX协议', 'ASP' => '阿里巴巴自研ASP协议'], 'example' => 'ASP', ], 'OsType' => [ @@ -1814,52 +1479,29 @@ .'-Android', 'description' => '操作系统类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - 'Android' => 'Android', - ], + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'], 'example' => 'Windows', ], - 'Os' => [ - 'title' => '操作系统平台信息。', - 'description' => '操作系统平台信息。', - 'type' => 'string', - 'example' => 'Windows Server 2022', - ], - 'OsDescription' => [ - 'title' => '操作系统平台描述信息。', - 'description' => '操作系统平台描述信息。', - 'type' => 'string', - 'example' => 'Windows 正版授权', - ], + 'Os' => ['title' => '操作系统平台信息。', 'description' => '操作系统平台信息。', 'type' => 'string', 'example' => 'Windows Server 2022'], + 'OsDescription' => ['title' => '操作系统平台描述信息。', 'description' => '操作系统平台描述信息。', 'type' => 'string', 'example' => 'Windows 正版授权'], 'SupportHibernation' => [ 'title' => '是否支持休眠。', 'description' => '是否支持休眠。', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '支持休眠', - 'false' => '不支持休眠', - ], + 'enumValueTitles' => ['true' => '支持休眠', 'false' => '不支持休眠'], 'example' => 'true', ], 'HibernationBeta' => [ 'description' => '是否为休眠测试版本。', 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '是休眠测试版本', - 'false' => '不是休眠测试版本', - ], + 'enumValueTitles' => ['true' => '是休眠测试版本', 'false' => '不是休眠测试版本'], 'example' => 'false', ], 'SessionType' => [ 'title' => '会话类型。SINGLE_SESSION代表单会话，MULTIPLE_SESSION代表多会话。', 'description' => '会话类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '单会话', - 'MULTIPLE_SESSION' => '多会话', - ], + 'enumValueTitles' => ['SINGLE_SESSION' => '单会话', 'MULTIPLE_SESSION' => '多会话'], 'example' => 'SINGLE_SESSION', ], 'ChargeType' => [ @@ -1868,10 +1510,7 @@ .'- PrePaid(包年包月)', 'description' => '计费方式。', 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '按量付费 [默认值]', - 'PrePaid' => '包年包月', - ], + 'enumValueTitles' => ['PostPaid' => '按量付费 [默认值]', 'PrePaid' => '包年包月'], 'example' => 'PrePaid', ], 'SubPayType' => [ @@ -1880,18 +1519,10 @@ .'- PrePaid(时长包)', 'description' => '子计费方式。', 'type' => 'string', - 'enumValueTitles' => [ - 'monthPackage' => '按月预付费', - 'PrePaid' => '时长包', - ], + 'enumValueTitles' => ['monthPackage' => '按月预付费', 'PrePaid' => '时长包'], 'example' => 'PrePaid', ], - 'ExpiredTime' => [ - 'title' => '包年包月付费类型资源的到期时间。', - 'description' => '包年包月付费类型资源的到期时间。', - 'type' => 'string', - 'example' => '2025-02-22T16:00:00Z', - ], + 'ExpiredTime' => ['title' => '包年包月付费类型资源的到期时间。', 'description' => '包年包月付费类型资源的到期时间。', 'type' => 'string', 'example' => '2025-02-22T16:00:00Z'], 'AuthMode' => [ 'title' => '云应用授权模式。取值范围：'."\n" .'App：应用授权'."\n" @@ -1899,80 +1530,20 @@ .'AppInstanceGroup：交付组授权'."\n", 'description' => '云应用授权模式。', 'type' => 'string', - 'enumValueTitles' => [ - 'App' => '应用授权', - 'AppInstanceGroup' => '交付组授权', - 'Session' => '会话授权', - ], + 'enumValueTitles' => ['App' => '应用授权', 'AppInstanceGroup' => '交付组授权', 'Session' => '会话授权'], 'example' => 'App', ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => '应用ID。资源类型为App的资源特有参数。', - 'type' => 'string', - 'example' => 'app-0001', - ], - 'Version' => [ - 'title' => '资源版本。', - 'description' => '资源版本。资源类型为App的资源特有参数。', - 'type' => 'string', - 'example' => '资源版本。', - ], - 'CategoryType' => [ - 'title' => '资源一级类目。', - 'description' => '资源一级类目。资源类型为App的资源特有参数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CategoryId' => [ - 'description' => '资源二级类目。资源类型为App的资源特有参数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Icon' => [ - 'title' => '资源图标链接。', - 'description' => '资源图标链接。资源类型为App的资源特有参数。', - 'type' => 'string', - 'example' => 'http://example.com/icon.png', - ], - 'ThemeColor' => [ - 'title' => '资源主题颜色。', - 'description' => '资源主题颜色。资源类型为App的资源特有参数。', - 'type' => 'string', - 'example' => '#FFFFFF', - ], - 'CdsName' => [ - 'title' => '网盘名称。', - 'description' => '网盘名称。资源类型为CloudDrive的资源特有参数。', - 'type' => 'string', - 'example' => 'cn-shanghai+cds-695277****', - ], - 'ExternalDomainId' => [ - 'title' => '外部Domain ID。', - 'description' => '外部Domain ID。资源类型为CloudDrive的资源特有参数。', - 'type' => 'string', - 'example' => 'stg114510', - ], - 'ExternalUserId' => [ - 'title' => '外部用户ID。', - 'description' => '外部用户ID。资源类型为CloudDrive的资源特有参数。', - 'type' => 'string', - 'example' => 'test001', - ], - 'GlobalStatus' => [ - 'title' => '是否支持跨地域访问。', - 'description' => '是否支持跨地域访问。资源类型为CloudDrive的资源特有参数。', - 'type' => 'boolean', - 'example' => 'true', - ], - 'LocalName' => [ - 'title' => '地域名称。', - 'description' => '地域名称。', - 'type' => 'string', - 'example' => '华东1（杭州）', - ], + 'AppId' => ['title' => '应用ID。', 'description' => '应用ID。资源类型为App的资源特有参数。', 'type' => 'string', 'example' => 'app-0001'], + 'Version' => ['title' => '资源版本。', 'description' => '资源版本。资源类型为App的资源特有参数。', 'type' => 'string', 'example' => 'Resource version.'], + 'CategoryType' => ['title' => '资源一级类目。', 'description' => '资源一级类目。资源类型为App的资源特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CategoryId' => ['description' => '资源二级类目。资源类型为App的资源特有参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'Icon' => ['title' => '资源图标链接。', 'description' => '资源图标链接。资源类型为App的资源特有参数。', 'type' => 'string', 'example' => 'http://example.com/icon.png'], + 'ThemeColor' => ['title' => '资源主题颜色。', 'description' => '资源主题颜色。资源类型为App的资源特有参数。', 'type' => 'string', 'example' => '#FFFFFF'], + 'CdsName' => ['title' => '网盘名称。', 'description' => '网盘名称。资源类型为CloudDrive的资源特有参数。', 'type' => 'string', 'example' => 'cn-shanghai+cds-695277****'], + 'ExternalDomainId' => ['title' => '外部Domain ID。', 'description' => '外部Domain ID。资源类型为CloudDrive的资源特有参数。', 'type' => 'string', 'example' => 'stg114510'], + 'ExternalUserId' => ['title' => '外部用户ID。', 'description' => '外部用户ID。资源类型为CloudDrive的资源特有参数。', 'type' => 'string', 'example' => 'test001'], + 'GlobalStatus' => ['title' => '是否支持跨地域访问。', 'description' => '是否支持跨地域访问。资源类型为CloudDrive的资源特有参数。', 'type' => 'boolean', 'example' => 'true'], + 'LocalName' => ['title' => '地域名称。', 'description' => '地域名称。', 'type' => 'string', 'example' => '华东1（杭州）'], 'DesktopTimers' => [ 'title' => '桌面定时任务设置列表。', 'description' => '云电脑定时任务设置列表。', @@ -1982,55 +1553,14 @@ 'description' => '云电脑定时任务设置。', 'type' => 'object', 'properties' => [ - 'TimerType' => [ - 'title' => '任务类型。', - 'description' => '任务类型。', - 'type' => 'string', - 'example' => 'TimerBoot', - ], - 'CronExpression' => [ - 'title' => '定时任务的Cron表达式。', - 'description' => '定时任务的Cron表达式。', - 'type' => 'string', - 'example' => '0 30 13 ? * 1-7', - ], - 'Interval' => [ - 'title' => '定时任务间隔时间。', - 'description' => '定时任务间隔时间。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'Enforce' => [ - 'title' => '是否强制执行。', - 'description' => '是否强制执行。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ResetType' => [ - 'title' => '重置类型。', - 'description' => '重置类型。', - 'type' => 'string', - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'title' => '是否允许客户端设置', - 'description' => '是否允许客户端设置。', - 'type' => 'string', - 'example' => 'false', - ], - 'OperationType' => [ - 'title' => '操作类型', - 'description' => '操作类型。', - 'type' => 'string', - 'example' => 'Hibernate', - ], - 'ExecutionTime' => [ - 'title' => '执行时间', - 'description' => '执行时间。', - 'type' => 'string', - 'example' => '2025-01-21T11:37Z', - ], + 'TimerType' => ['title' => '任务类型。', 'description' => '任务类型。', 'type' => 'string', 'example' => 'TimerBoot'], + 'CronExpression' => ['title' => '定时任务的Cron表达式。', 'description' => '定时任务的Cron表达式。', 'type' => 'string', 'example' => '0 30 13 ? * 1-7'], + 'Interval' => ['title' => '定时任务间隔时间。', 'description' => '定时任务间隔时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], + 'Enforce' => ['title' => '是否强制执行。', 'description' => '是否强制执行。', 'type' => 'boolean', 'example' => 'false'], + 'ResetType' => ['title' => '重置类型。', 'description' => '重置类型。', 'type' => 'string', 'example' => 'RESET_TYPE_SYSTEM'], + 'AllowClientSetting' => ['title' => '是否允许客户端设置', 'description' => '是否允许客户端设置。', 'type' => 'string', 'example' => 'false'], + 'OperationType' => ['title' => '操作类型', 'description' => '操作类型。', 'type' => 'string', 'example' => 'Hibernate'], + 'ExecutionTime' => ['title' => '执行时间', 'description' => '执行时间。', 'type' => 'string', 'example' => '2025-01-21T11:37Z'], ], ], ], @@ -2043,20 +1573,12 @@ 'description' => '资源支持的单类客户端类型设置信息。', 'type' => 'object', 'properties' => [ - 'ClientType' => [ - 'title' => '客户端类型。', - 'description' => '客户端类型。', - 'type' => 'string', - 'example' => 'windows', - ], + 'ClientType' => ['title' => '客户端类型。', 'description' => '客户端类型。', 'type' => 'string', 'example' => 'windows'], 'Status' => [ 'title' => '支持状态。', 'description' => '支持状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'OFF' => '禁用', - 'ON' => '启用', - ], + 'enumValueTitles' => ['OFF' => '禁用', 'ON' => '启用'], 'example' => 'ON', ], ], @@ -2067,58 +1589,30 @@ 'description' => '资源状态。', 'type' => 'string', 'enumValueTitles' => [ - 'Unknown' => '未知', - 'Stopped' => '已关机', - 'Failed' => '创建失败', - 'Starting' => '启动中', - 'Rebuilding' => '变更中', - 'Running' => '运行中', - 'Stopping' => '停止中', - 'FotaUpdating' => '镜像升级中', - 'Pending' => '等待中', - 'Deleting' => '删除中', + 'Unknown' => '未知', 'Stopped' => '已关机', 'Failed' => '创建失败', 'Starting' => '启动中', 'Rebuilding' => '变更中', 'Running' => '运行中', 'Stopping' => '停止中', 'FotaUpdating' => '镜像升级中', 'Pending' => '等待中', 'Deleting' => '删除中', 'Unavailable' => '不可用', ], 'example' => 'Running', ], - 'LastStartTime' => [ - 'title' => '资源上次启动时间。', - 'description' => '资源上次启动时间。', - 'type' => 'string', - 'example' => '2025-01-24T03:12:04Z', - ], + 'LastStartTime' => ['title' => '资源上次启动时间。', 'description' => '资源上次启动时间。', 'type' => 'string', 'example' => '2025-01-24T03:12:04Z'], 'OrderStatus' => [ 'title' => '订单状态。', 'description' => '订单状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'Ceased' => '后付费欠费', - 'Released' => '订单关闭', - 'Expired' => '预付费停机', - 'Normal' => '正常', - ], + 'enumValueTitles' => ['Ceased' => '后付费欠费', 'Released' => '订单关闭', 'Expired' => '预付费停机', 'Normal' => '正常'], 'example' => 'Normal', ], 'ManagementStatuses' => [ 'title' => '管理状态列表。', 'description' => '管理状态列表。', 'type' => 'array', - 'items' => [ - 'title' => '管理状态', - 'description' => '管理状态', - 'type' => 'string', - 'example' => 'NoFlag', - ], + 'items' => ['title' => '管理状态', 'description' => '管理状态', 'type' => 'string', 'example' => 'NoFlag'], ], 'ResourceSessionStatus' => [ 'title' => '会话状态。', 'description' => '会话状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => '未知', - 'Connected' => '已连接', - 'Disconnected' => '已断开连接', - ], + 'enumValueTitles' => ['Unknown' => '未知', 'Connected' => '已连接', 'Disconnected' => '已断开连接'], 'example' => 'Connected', ], 'Sessions' => [ @@ -2128,118 +1622,38 @@ 'description' => '资源用户会话信息。', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '登录资源的用户名。', - 'description' => '登录资源的用户名。', - 'type' => 'string', - 'example' => 'user001', - ], - 'UserPrincipalName' => [ - 'title' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', - 'description' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', - 'type' => 'string', - 'example' => 'benchmark_test@test.shenzhen', - ], - 'ResourceSessionStartTime' => [ - 'title' => '资源会话连接的时间。', - 'description' => '资源会话连接的时间。', - 'type' => 'string', - 'example' => '2025-01-22T11:03:36Z', - ], - 'NickName' => [ - 'title' => '用户的昵称。', - 'description' => '用户的昵称。', - 'type' => 'string', - 'example' => 'user-001', - ], + 'UserId' => ['title' => '登录资源的用户名。', 'description' => '登录资源的用户名。', 'type' => 'string', 'example' => 'user001'], + 'UserPrincipalName' => ['title' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', 'description' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', 'type' => 'string', 'example' => 'benchmark_test@test.shenzhen'], + 'ResourceSessionStartTime' => ['title' => '资源会话连接的时间。', 'description' => '资源会话连接的时间。', 'type' => 'string', 'example' => '2025-01-22T11:03:36Z'], + 'NickName' => ['title' => '用户的昵称。', 'description' => '用户的昵称。', 'type' => 'string', 'example' => 'user-001'], ], ], ], - 'RealDesktopId' => [ - 'title' => '【桌面组】真实桌面ID，当桌面组存在会话时存在。', - 'description' => '【共享型云电脑】真实云电脑ID，当共享型云电脑存在会话时存在。', - 'type' => 'string', - 'example' => 'ecd-0001', - ], - 'UserCustomName' => [ - 'title' => '用户自定义名称。', - 'description' => '用户自定义名称。', - 'type' => 'string', - 'example' => '我的云电脑', - ], + 'RealDesktopId' => ['title' => '【桌面组】真实桌面ID，当桌面组存在会话时存在。', 'description' => '【共享型云电脑】真实云电脑ID，当共享型云电脑存在会话时存在。', 'type' => 'string', 'example' => 'ecd-0001'], + 'UserCustomName' => ['title' => '用户自定义名称。', 'description' => '用户自定义名称。', 'type' => 'string', 'example' => 'My cloud desktop'], 'FotaUpdate' => [ 'title' => '', 'description' => '云电脑升级信息。', 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => '项目名称。', - 'type' => 'string', - 'example' => 'wuying-asp_single_session_desktop_win_x64', - ], - 'Channel' => [ - 'description' => '通道。', - 'type' => 'string', - 'example' => 'aliyun', - ], - 'CurrentAppVersion' => [ - 'description' => '云电脑当前镜像的版本号。', - 'type' => 'string', - 'example' => '2.7.0-R-20250122.154826', - ], - 'NewAppVersion' => [ - 'description' => '云电脑可升级的版本号。', - 'type' => 'string', - 'example' => '2.7.0-R-20250125.154826', - ], - 'Force' => [ - 'description' => '是否强制升级。', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReleaseNote' => [ - 'description' => '可升级的版本描述。', - 'type' => 'string', - 'example' => '新版本', - ], - 'Size' => [ - 'description' => '可升级的版本安装包大小。单位：KB。', - 'type' => 'string', - 'example' => '474981930', - ], - 'ReleaseNoteEn' => [ - 'title' => '', - 'description' => '可升级的版本英文描述。', - 'type' => 'string', - 'example' => 'new version', - ], - 'ReleaseNoteJp' => [ - 'description' => '可升级的版本日文描述。', - 'type' => 'string', - 'example' => '新バージョン', - ], - 'NewDcdVersion' => [ - 'description' => '可升级的组件盘版本号。', - 'type' => 'string', - 'example' => '2.6.9-R-20250123.153415', - ], + 'Project' => ['description' => '项目名称。', 'type' => 'string', 'example' => 'wuying-asp_single_session_desktop_win_x64'], + 'Channel' => ['description' => '通道。', 'type' => 'string', 'example' => 'aliyun'], + 'CurrentAppVersion' => ['description' => '云电脑当前镜像的版本号。', 'type' => 'string', 'example' => '2.7.0-R-20250122.154826'], + 'NewAppVersion' => ['description' => '云电脑可升级的版本号。', 'type' => 'string', 'example' => '2.7.0-R-20250125.154826'], + 'Force' => ['description' => '是否强制升级。', 'type' => 'boolean', 'example' => 'false'], + 'ReleaseNote' => ['description' => '可升级的版本描述。', 'type' => 'string', 'example' => '新版本'], + 'Size' => ['description' => '可升级的版本安装包大小。单位：KB。', 'type' => 'string', 'example' => '474981930'], + 'ReleaseNoteEn' => ['title' => '', 'description' => '可升级的版本英文描述。', 'type' => 'string', 'example' => 'new version'], + 'ReleaseNoteJp' => ['description' => '可升级的版本日文描述。', 'type' => 'string', 'example' => '新バージョン'], + 'NewDcdVersion' => ['description' => '可升级的组件盘版本号。', 'type' => 'string', 'example' => '2.6.9-R-20250123.153415'], ], ], 'OsUpdate' => [ 'description' => '操作系统升级信息。', 'type' => 'object', 'properties' => [ - 'CheckId' => [ - 'description' => '校验ID。', - 'type' => 'string', - 'example' => 'wua-1740652957251743***', - ], - 'PackageCount' => [ - 'description' => '包数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'CheckId' => ['description' => '校验ID。', 'type' => 'string', 'example' => 'wua-1740652957251743***'], + 'PackageCount' => ['description' => '包数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Packages' => [ 'description' => '补丁包信息列表。', 'type' => 'array', @@ -2247,41 +1661,17 @@ 'description' => '补丁包信息。', 'type' => 'object', 'properties' => [ - 'Kb' => [ - 'description' => '补丁号。', - 'type' => 'string', - 'example' => 'KB2267***', - ], - 'Title' => [ - 'description' => '补丁标题。', - 'type' => 'string', - 'example' => '用于****的补丁。', - ], - 'Description' => [ - 'description' => '补丁描述。', - 'type' => 'string', - 'example' => '安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。', - ], + 'Kb' => ['description' => '补丁号。', 'type' => 'string', 'example' => 'KB2267***'], + 'Title' => ['description' => '补丁标题。', 'type' => 'string', 'example' => 'Patch for ****.'], + 'Description' => ['description' => '补丁描述。', 'type' => 'string', 'example' => '安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。'], ], ], ], - 'KbListString' => [ - 'description' => '补丁号列表信息。', - 'type' => 'string', - 'example' => 'KB2267***', - ], - 'UpdateCatalogUrl' => [ - 'description' => '更新分类URL。', - 'type' => 'string', - 'example' => 'https://catalog.update.microsoft.com/home.aspx', - ], + 'KbListString' => ['description' => '补丁号列表信息。', 'type' => 'string', 'example' => 'KB2267***'], + 'UpdateCatalogUrl' => ['description' => '更新分类URL。', 'type' => 'string', 'example' => 'https://catalog.update.microsoft.com/home.aspx'], ], ], - 'HasUpgrade' => [ - 'description' => '是否存在更新。', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HasUpgrade' => ['description' => '是否存在更新。', 'type' => 'boolean', 'example' => 'true'], 'DesktopDurationList' => [ 'description' => '云电脑套餐包信息列表。', 'type' => 'array', @@ -2289,44 +1679,12 @@ 'description' => '云电脑套餐包信息。', 'type' => 'object', 'properties' => [ - 'PackageCreationTime' => [ - 'title' => '创建时间', - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2025-01-17T07:01Z', - ], - 'PackageStatus' => [ - 'title' => '状态。', - 'description' => '状态。', - 'type' => 'string', - 'example' => 'Available', - ], - 'UsedDuration' => [ - 'title' => '已使用时长', - 'description' => '已使用时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16850', - ], - 'PackageExpiredTime' => [ - 'title' => '过期时间', - 'description' => '过期时间。', - 'type' => 'string', - 'example' => '2025-02-17T15:59Z', - ], - 'PackageId' => [ - 'title' => '套餐包ID。', - 'description' => '套餐包ID。', - 'type' => 'string', - 'example' => 'mdp-0bxls4qpi6bl6****', - ], - 'TotalDuration' => [ - 'title' => '总时长', - 'description' => '总时长。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '432000', - ], + 'PackageCreationTime' => ['title' => '创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2025-01-17T07:01Z'], + 'PackageStatus' => ['title' => '状态。', 'description' => '状态。', 'type' => 'string', 'example' => 'Available'], + 'UsedDuration' => ['title' => '已使用时长', 'description' => '已使用时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '16850'], + 'PackageExpiredTime' => ['title' => '过期时间', 'description' => '过期时间。', 'type' => 'string', 'example' => '2025-02-17T15:59Z'], + 'PackageId' => ['title' => '套餐包ID。', 'description' => '套餐包ID。', 'type' => 'string', 'example' => 'mdp-0bxls4qpi6bl6****'], + 'TotalDuration' => ['title' => '总时长', 'description' => '总时长。', 'type' => 'integer', 'format' => 'int64', 'example' => '432000'], 'PackageType' => [ 'title' => '时长包类型'."\n" .' * Duration：时长包'."\n" @@ -2335,63 +1693,29 @@ .' * FREE_PACKAGE：免费包', 'description' => '时长包类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'FREE_PACKAGE' => '免费包', - 'NORMAL_PACKAGE' => '付费包（120小时包）', - 'POSTPAID_PACKAGE' => '用于记录后付费额度包（200小时包）', - 'Duration' => '时长包', - ], + 'enumValueTitles' => ['FREE_PACKAGE' => '免费包', 'NORMAL_PACKAGE' => '付费包（120小时包）', 'POSTPAID_PACKAGE' => '用于记录后付费额度包（200小时包）', 'Duration' => '时长包'], 'example' => 'NORMAL_PACKAGE', ], - 'PeriodStartTime' => [ - 'title' => '当月包开始时间', - 'description' => '当月包开始时间。', - 'type' => 'string', - 'example' => '2025-01-17T07:01Z', - ], - 'PeriodEndTime' => [ - 'title' => '当月包结束时间', - 'description' => '当月包结束时间。', - 'type' => 'string', - 'example' => '2025-02-17T15:59Z', - ], - 'PostPaidLimitFee' => [ - 'title' => '第二阶段包的封顶金额'."\n" - .' * 仅ResourceType为POSTPAID_PACKAG 和 FREE_PACKAGE时会返回', - 'description' => '第二阶段包的封顶金额。'."\n" - ."\n" - .'> 仅ResourceType为`POSTPAID_PACKAG`和`FREE_PACKAGE`时会返回。', - 'type' => 'number', - 'format' => 'float', - 'example' => '199', - ], - 'OrderInstanceId' => [ - 'title' => '订单实例ID', - 'description' => '订单实例ID。', - 'type' => 'string', - 'example' => 'mdp-0bxls4qpi6bl6****', - ], + 'PeriodStartTime' => ['title' => '当月包开始时间', 'description' => '当月包开始时间。', 'type' => 'string', 'example' => '2025-01-17T07:01Z'], + 'PeriodEndTime' => ['title' => '当月包结束时间', 'description' => '当月包结束时间。', 'type' => 'string', 'example' => '2025-02-17T15:59Z'], + 'PostPaidLimitFee' => ['title' => '第二阶段包的封顶金额'."\n" + .' * 仅ResourceType为POSTPAID_PACKAG 和 FREE_PACKAGE时会返回', 'description' => '第二阶段包的封顶金额。'."\n" + ."\n" + .'> 仅ResourceType为`POSTPAID_PACKAG`和`FREE_PACKAGE`时会返回。', 'type' => 'number', 'format' => 'float', 'example' => '199'], + 'OrderInstanceId' => ['title' => '订单实例ID', 'description' => '订单实例ID。', 'type' => 'string', 'example' => 'mdp-0bxls4qpi6bl6****'], 'PackageUsedUpStrategy' => [ 'title' => '包用尽策略'."\n" .' * "Postpaid" //用尽扣费'."\n" .' * "Shutdown" //用尽关机或休眠', 'description' => '套餐当月额度使用完毕后的云电脑状态策略。', 'type' => 'string', - 'enumValueTitles' => [ - 'Shutdown' => '关机或休眠', - 'Postpaid' => '继续使用并按量付费', - ], + 'enumValueTitles' => ['Shutdown' => '关机或休眠', 'Postpaid' => '继续使用并按量付费'], 'example' => 'Postpaid', ], ], ], ], - 'ConnectionProperties' => [ - 'title' => '连接属性，JSON格式。', - 'description' => '连接属性，JSON字符串，客户端无需关心内容，当应用资源建联时直接传递给中心资源管控。', - 'type' => 'string', - 'example' => '{"authMode":"App"}', - ], + 'ConnectionProperties' => ['title' => '连接属性，JSON格式。', 'description' => '连接属性，JSON字符串，客户端无需关心内容，当应用资源建联时直接传递给中心资源管控。', 'type' => 'string', 'example' => '{"authMode":"App"}'], 'SupportedActions' => [ 'title' => '支持的操作类型列表，目前只支持安卓云。', 'description' => '支持的操作类型列表，目前只支持云手机和云电脑（含共享型云电脑）。', @@ -2400,282 +1724,281 @@ 'title' => '操作类型。', 'description' => '操作类型。', 'type' => 'string', - 'enumValueTitles' => [ - 'WakeUp' => '唤醒', - 'Hibernate' => '休眠', - 'Start' => '开机', - 'Stop' => '关机', - 'Restart' => '重启', - ], + 'enumValueTitles' => ['WakeUp' => '唤醒', 'Hibernate' => '休眠', 'Start' => '开机', 'Stop' => '关机', 'Restart' => '重启'], 'example' => 'Start', ], ], + 'SupportAgentIm' => ['title' => '是否支持AgentIM。', 'type' => 'boolean'], + 'AgentImUrl' => ['title' => 'AgentIm页面的URL。', 'type' => 'string', 'example' => 'https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx'], ], ], ], - 'RankVersion' => [ - 'title' => '排序数据版本号。', - 'description' => '排序数据版本号。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1732869815062', - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxResults' => [ - 'title' => '返回最大数量。', - 'description' => '返回最大数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'RankVersion' => ['title' => '排序数据版本号。', 'description' => '排序数据版本号。', 'type' => 'integer', 'format' => 'int64', 'example' => '1732869815062'], + 'TotalCount' => ['title' => '总数。', 'description' => '总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'MaxResults' => ['title' => '返回最大数量。', 'description' => '返回最大数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'AgentBriefSummary' => [ + 'title' => 'Agent概要汇总信息。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => 'Agent实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'AgentBriefs' => [ + 'title' => '包含的Agent实例类型概要信息列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'Agent实例类型概要信息。', + 'type' => 'object', + 'properties' => [ + 'AgentPlatform' => [ + 'title' => 'Agent平台', + 'type' => 'string', + 'example' => 'ENTERPRISE_JVS', + 'enum' => ['ENTERPRISE_JVS', 'ENTERPRISE', 'JVS'], + ], + 'AgentProvider' => [ + 'title' => 'Agent提供商。', + 'type' => 'string', + 'example' => 'OpenClaw', + 'enum' => ['OpenClaw', 'JVSCopilot'], + ], + 'Count' => ['title' => '数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'AvatarUrl' => ['title' => '该类型Agent的通用头像下载链接。'."\n" + .'后端根据ClientType自动返回不同的头像。匹配不到返回通用的头像。', 'type' => 'string', 'example' => 'https://abc.com/efg.png'], + 'Url' => ['title' => 'Agent管理页URL。', 'type' => 'string', 'example' => 'https://test.png'], + 'DisplayName' => ['title' => '显示名，如JVS Claw。'."\n" + .'后端根据Language自动返回不同的显示名。', 'type' => 'string', 'example' => 'JVS Claw'], + 'SubTitle' => ['title' => '副标题，如：智在进化 快乐养虾'."\n" + .'后端根据Language自动返回不同的副标题。', 'type' => 'string', 'example' => '智在进化，快乐养虾'], + 'AvatarNoResourceUrl' => ['title' => '无云资源时该类型Agent的通用头像下载链接。'."\n" + .'后端根据ClientType自动返回不同的头像。匹配不到返回通用的头像。', 'type' => 'string', 'example' => 'https://xxx.png'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QueryFailedResourceTypes\\": [\\n \\"CloudDesktop\\"\\n ],\\n \\"Resources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"Desktop\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionLocation\\": \\"Mainland\\",\\n \\"ResourceGroupId\\": \\"dg-0****\\",\\n \\"ResourceId\\": \\"ecd-d19tya8zi4****\\",\\n \\"ResourceLevel\\": \\"Center\\",\\n \\"CenterResourceId\\": \\"ecds-0****\\",\\n \\"ResourceName\\": \\"testName01\\",\\n \\"CreateTime\\": \\"2024-12-11T07:12:12Z\\",\\n \\"ProductType\\": \\"AndroidCloud\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-3367****\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"Os\\": \\"Windows Server 2022\\",\\n \\"OsDescription\\": \\"Windows 正版授权\\",\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": false,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SubPayType\\": \\"PrePaid\\",\\n \\"ExpiredTime\\": \\"2025-02-22T16:00:00Z\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"AppId\\": \\"app-0001\\",\\n \\"Version\\": \\"资源版本。\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 0,\\n \\"Icon\\": \\"http://example.com/icon.png\\",\\n \\"ThemeColor\\": \\"#FFFFFF\\",\\n \\"CdsName\\": \\"cn-shanghai+cds-695277****\\",\\n \\"ExternalDomainId\\": \\"stg114510\\",\\n \\"ExternalUserId\\": \\"test001\\",\\n \\"GlobalStatus\\": true,\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 30 13 ? * 1-7\\",\\n \\"Interval\\": 15,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": \\"false\\",\\n \\"OperationType\\": \\"Hibernate\\",\\n \\"ExecutionTime\\": \\"2025-01-21T11:37Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"ClientType\\": \\"windows\\",\\n \\"Status\\": \\"ON\\"\\n }\\n ],\\n \\"ResourceStatus\\": \\"Running\\",\\n \\"LastStartTime\\": \\"2025-01-24T03:12:04Z\\",\\n \\"OrderStatus\\": \\"Normal\\",\\n \\"ManagementStatuses\\": [\\n \\"NoFlag\\"\\n ],\\n \\"ResourceSessionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"UserId\\": \\"user001\\",\\n \\"UserPrincipalName\\": \\"benchmark_test@test.shenzhen\\",\\n \\"ResourceSessionStartTime\\": \\"2025-01-22T11:03:36Z\\",\\n \\"NickName\\": \\"user-001\\"\\n }\\n ],\\n \\"RealDesktopId\\": \\"ecd-0001\\",\\n \\"UserCustomName\\": \\"我的云电脑\\",\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"wuying-asp_single_session_desktop_win_x64\\",\\n \\"Channel\\": \\"aliyun\\",\\n \\"CurrentAppVersion\\": \\"2.7.0-R-20250122.154826\\",\\n \\"NewAppVersion\\": \\"2.7.0-R-20250125.154826\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"新版本\\",\\n \\"Size\\": \\"474981930\\",\\n \\"ReleaseNoteEn\\": \\"new version\\",\\n \\"ReleaseNoteJp\\": \\"新バージョン\\",\\n \\"NewDcdVersion\\": \\"2.6.9-R-20250123.153415\\"\\n },\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"wua-1740652957251743***\\",\\n \\"PackageCount\\": 1,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"KB2267***\\",\\n \\"Title\\": \\"用于****的补丁。\\",\\n \\"Description\\": \\"安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。\\"\\n }\\n ],\\n \\"KbListString\\": \\"KB2267***\\",\\n \\"UpdateCatalogUrl\\": \\"https://catalog.update.microsoft.com/home.aspx\\"\\n },\\n \\"HasUpgrade\\": true,\\n \\"DesktopDurationList\\": [\\n {\\n \\"PackageCreationTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PackageStatus\\": \\"Available\\",\\n \\"UsedDuration\\": 16850,\\n \\"PackageExpiredTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PackageId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"TotalDuration\\": 432000,\\n \\"PackageType\\": \\"NORMAL_PACKAGE\\",\\n \\"PeriodStartTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PeriodEndTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PostPaidLimitFee\\": 199,\\n \\"OrderInstanceId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"PackageUsedUpStrategy\\": \\"Postpaid\\"\\n }\\n ],\\n \\"ConnectionProperties\\": \\"{\\\\\\"authMode\\\\\\":\\\\\\"App\\\\\\"}\\",\\n \\"SupportedActions\\": [\\n \\"Start\\"\\n ]\\n }\\n ],\\n \\"RankVersion\\": 1732869815062,\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 100\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QueryFailedResourceTypes\\": [\\n \\"CloudDesktop\\"\\n ],\\n \\"Resources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"Desktop\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionLocation\\": \\"Mainland\\",\\n \\"ResourceGroupId\\": \\"dg-0****\\",\\n \\"ResourceId\\": \\"ecd-d19tya8zi4****\\",\\n \\"ResourceLevel\\": \\"Center\\",\\n \\"CenterResourceId\\": \\"ecds-0****\\",\\n \\"ResourceName\\": \\"testName01\\",\\n \\"CreateTime\\": \\"2024-12-11T07:12:12Z\\",\\n \\"ProductType\\": \\"AndroidCloud\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-3367****\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"Os\\": \\"Windows Server 2022\\",\\n \\"OsDescription\\": \\"Windows 正版授权\\",\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": false,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SubPayType\\": \\"PrePaid\\",\\n \\"ExpiredTime\\": \\"2025-02-22T16:00:00Z\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"AppId\\": \\"app-0001\\",\\n \\"Version\\": \\"Resource version.\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 0,\\n \\"Icon\\": \\"http://example.com/icon.png\\",\\n \\"ThemeColor\\": \\"#FFFFFF\\",\\n \\"CdsName\\": \\"cn-shanghai+cds-695277****\\",\\n \\"ExternalDomainId\\": \\"stg114510\\",\\n \\"ExternalUserId\\": \\"test001\\",\\n \\"GlobalStatus\\": true,\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 30 13 ? * 1-7\\",\\n \\"Interval\\": 15,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": \\"false\\",\\n \\"OperationType\\": \\"Hibernate\\",\\n \\"ExecutionTime\\": \\"2025-01-21T11:37Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"ClientType\\": \\"windows\\",\\n \\"Status\\": \\"ON\\"\\n }\\n ],\\n \\"ResourceStatus\\": \\"Running\\",\\n \\"LastStartTime\\": \\"2025-01-24T03:12:04Z\\",\\n \\"OrderStatus\\": \\"Normal\\",\\n \\"ManagementStatuses\\": [\\n \\"NoFlag\\"\\n ],\\n \\"ResourceSessionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"UserId\\": \\"user001\\",\\n \\"UserPrincipalName\\": \\"benchmark_test@test.shenzhen\\",\\n \\"ResourceSessionStartTime\\": \\"2025-01-22T11:03:36Z\\",\\n \\"NickName\\": \\"user-001\\"\\n }\\n ],\\n \\"RealDesktopId\\": \\"ecd-0001\\",\\n \\"UserCustomName\\": \\"My cloud desktop\\",\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"wuying-asp_single_session_desktop_win_x64\\",\\n \\"Channel\\": \\"aliyun\\",\\n \\"CurrentAppVersion\\": \\"2.7.0-R-20250122.154826\\",\\n \\"NewAppVersion\\": \\"2.7.0-R-20250125.154826\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"新版本\\",\\n \\"Size\\": \\"474981930\\",\\n \\"ReleaseNoteEn\\": \\"new version\\",\\n \\"ReleaseNoteJp\\": \\"新バージョン\\",\\n \\"NewDcdVersion\\": \\"2.6.9-R-20250123.153415\\"\\n },\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"wua-1740652957251743***\\",\\n \\"PackageCount\\": 1,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"KB2267***\\",\\n \\"Title\\": \\"Patch for ****.\\",\\n \\"Description\\": \\"安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。\\"\\n }\\n ],\\n \\"KbListString\\": \\"KB2267***\\",\\n \\"UpdateCatalogUrl\\": \\"https://catalog.update.microsoft.com/home.aspx\\"\\n },\\n \\"HasUpgrade\\": true,\\n \\"DesktopDurationList\\": [\\n {\\n \\"PackageCreationTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PackageStatus\\": \\"Available\\",\\n \\"UsedDuration\\": 16850,\\n \\"PackageExpiredTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PackageId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"TotalDuration\\": 432000,\\n \\"PackageType\\": \\"NORMAL_PACKAGE\\",\\n \\"PeriodStartTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PeriodEndTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PostPaidLimitFee\\": 199,\\n \\"OrderInstanceId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"PackageUsedUpStrategy\\": \\"Postpaid\\"\\n }\\n ],\\n \\"ConnectionProperties\\": \\"{\\\\\\"authMode\\\\\\":\\\\\\"App\\\\\\"}\\",\\n \\"SupportedActions\\": [\\n \\"Start\\"\\n ],\\n \\"SupportAgentIm\\": true,\\n \\"AgentImUrl\\": \\"https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx\\"\\n }\\n ],\\n \\"RankVersion\\": 1732869815062,\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 100,\\n \\"AgentBriefSummary\\": {\\n \\"TotalCount\\": 10,\\n \\"AgentBriefs\\": [\\n {\\n \\"AgentPlatform\\": \\"ENTERPRISE_JVS\\",\\n \\"AgentProvider\\": \\"OpenClaw\\",\\n \\"Count\\": 2,\\n \\"AvatarUrl\\": \\"https://abc.com/efg.png\\",\\n \\"Url\\": \\"https://test.png\\",\\n \\"DisplayName\\": \\"JVS Claw\\",\\n \\"SubTitle\\": \\"智在进化，快乐养虾\\",\\n \\"AvatarNoResourceUrl\\": \\"https://xxx.png\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询用户拥有的无影云资源列表', 'description' => '请确保在使用该接口前，已充分了解无影产品的资源类型和产品类型。', 'responseParamsDescription' => '返回参数并不是所有资源都拥有，请确保清楚每种资源拥有哪些参数字段。', - ], - 'UnbindUserDesktop' => [ - 'summary' => '将用户与云电脑解绑。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-09-17T15:04:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2025-05-07T08:16:39.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2025-02-25T11:42:53.000Z', 'description' => '响应参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserResources'], + ], ], + 'ramActions' => [], + ], + 'EncryptPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'example' => 'v12307f5e0****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****'], ], [ - 'name' => 'ClientType', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端的类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'windows', - ], + 'schema' => ['description' => '目录 ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing+dir-131196****'], ], [ - 'name' => 'ClientId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'example' => '58f96f67-7944-4f97-9342-****', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing+dir-131196****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'example' => '3b053331-dc98-43d8-b247-****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****'], ], [ - 'name' => 'UserDesktopId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '用户云电脑ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'ud-sdfs****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****'], ], [ - 'name' => 'Force', + 'name' => 'Password', 'in' => 'query', + 'schema' => ['description' => '密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Ab123456'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否强制解绑。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '即使在连接状态下也会解绑', - 'false' => '只有在未连接的状态下才解绑', + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'EncryptedPassword' => ['description' => '已加密密码。', 'type' => 'string', 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA=='], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****'], ], - 'example' => 'true', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]', + 'title' => '加密密码', + 'summary' => '加密用户密码。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPassword'], + ], + ], + 'ramActions' => [], + ], + 'GetCloudDriveServiceMountToken' => [ + 'summary' => '获取企业网盘登录凭证。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****'], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****'], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => false, 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****'], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-7186763****'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回信息合集。', + 'description' => '返回对象。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5B7CF35-E078-5EBF-A010-****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****'], + 'Token' => [ + 'description' => '返回Token信息列表。', + 'type' => 'object', + 'properties' => [ + 'Token' => ['description' => 'Token值。', 'type' => 'string', 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****'], + 'ExpiredAfter' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2022-10-10T04:41:35Z'], + 'UsedSize' => ['description' => '已使用的容量。单位：GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '605089'], + 'TotalSize' => ['description' => '企业网盘总容量。单位：GiB。', 'type' => 'integer', 'format' => 'int64', 'example' => '6050416754750'], + 'DomainId' => ['description' => '企业网盘域名。', 'type' => 'string', 'example' => 'h****'], + 'Status' => [ + 'description' => '当前企业网盘用户的状态。', + 'type' => 'string', + 'enumValueTitles' => ['disabled' => '已禁用', 'enabled' => '已启用'], + 'example' => 'enabled', + ], + ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC27288A-F9E1-5092-9B5B-71C27D15****\\",\\n \\"Token\\": {\\n \\"Token\\": \\"7836fa6eced7dc8d54c775k34iu3h4i2kh534f****\\",\\n \\"ExpiredAfter\\": \\"2022-10-10T04:41:35Z\\",\\n \\"UsedSize\\": 605089,\\n \\"TotalSize\\": 6050416754750,\\n \\"DomainId\\": \\"h****\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]', + 'title' => '获取企业网盘登录凭证', + 'changeSet' => [ + ['createdAt' => '2022-10-25T14:53:40.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-08-17T02:07:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2022-03-29T05:50:31.000Z', 'description' => 'OpenAPI 下线'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCloudDriveServiceMountToken'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]', - 'title' => '将用户与云电脑解绑', + 'ramActions' => [], ], 'GetConnectionTicket' => [ - 'summary' => '获取云电脑连接凭证。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + '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', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。调用GetLoginToken获取', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '会话ID。调用GetLoginToken获取', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。调用GetLoginToken获取', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '登录凭证。调用GetLoginToken获取', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '云电脑连接任务ID。 '."\n" - .'首次调用本接口时无需配置，后续调用本接口时配置为上一次调用本接口返回的`TaskId`。', - 'type' => 'string', - 'required' => false, - 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', - ], + 'schema' => ['description' => '云电脑连接任务ID。 '."\n" + .'首次调用本接口时无需配置，后续调用本接口时配置为上一次调用本接口返回的`TaskId`。', 'type' => 'string', 'required' => false, 'example' => '2afbad19-778a-4fc5-9674-1f19c638****'], ], [ 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****'], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '客户端操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => '客户端操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '客户端版本。', - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => '客户端版本。', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756'], ], [ 'name' => 'ClientType', @@ -2684,14 +2007,7 @@ 'description' => '客户端类型。', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'html5' => 'Web客户端', - 'linux' => '无影自研硬件终端', - 'android' => 'Android客户端', - 'windows' => 'Windows客户端', - 'ios' => 'iOS客户端', - 'macos' => 'macOS客户端', - ], + 'enumValueTitles' => ['html5' => 'Web客户端', 'linux' => '无影自研硬件终端', 'android' => 'Android客户端', 'windows' => 'Windows客户端', 'ios' => 'iOS客户端', 'macos' => 'macOS客户端'], 'example' => 'windows', ], ], @@ -2699,41 +2015,29 @@ 'name' => 'CommandContent', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '乐播需求，获取Tickek成功后自动在session里启动乐播应用。', - '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" - .'}', - 'maxLength' => 1024000, - ], + 'schema' => ['title' => '乐播需求，获取Tickek成功后自动在session里启动乐播应用。', '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" + .'}', 'maxLength' => 1024000], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', - ], + 'schema' => ['description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949'], ], [ 'name' => 'Tag', @@ -2746,18 +2050,8 @@ 'description' => '标签。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '标签键。如果传入`Tag`，则`Key`是必填的。不可超过128个字符，不能以`aliyun`或`acs:`开头，不能包含`http://`或者`https://`，也不能仅包含空格。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。可以为空字符串。最多支持128个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => '标签键。如果传入`Tag`，则`Key`是必填的。不可超过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, ], @@ -2768,10 +2062,7 @@ [ 'name' => 'AccessType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], [ 'name' => 'TicketBlackList', @@ -2779,11 +2070,7 @@ 'style' => 'repeatList', 'schema' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - ], - 'required' => false, + 'items' => ['type' => 'string'], 'maxItems' => 100, ], ], @@ -2794,368 +2081,201 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], 'TaskStatus' => [ 'description' => '任务状态。', 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '失败', - 'RUNNING' => '运行中', - 'FINISHED' => '已完成', - ], + 'enumValueTitles' => ['FAILED' => '失败', 'RUNNING' => '运行中', 'FINISHED' => '已完成'], 'example' => 'FINISHED', ], - 'Ticket' => [ - 'description' => '云电脑连接凭证。', - 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - 'TaskId' => [ - 'description' => '云电脑连接任务ID。', - 'type' => 'string', - 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da', - ], - '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****', - ], - 'P2PToken' => [ - 'type' => 'string', - ], - 'DesktopId' => [ - 'type' => 'string', - ], + 'Ticket' => ['description' => '云电脑连接凭证。', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********'], + 'TaskId' => ['description' => '云电脑连接任务ID。', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da'], + '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****'], + 'P2PToken' => ['type' => 'string', 'description' => ''], + 'DesktopId' => ['type' => 'string'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DesktopMemoryHighLoad%s', - 'errorMessage' => 'The specified desktop memory high load.', - ], - [ - 'errorCode' => 'DesktopCpuHighLoad%s', - 'errorMessage' => 'The specified desktop cpu high load.', - ], - [ - 'errorCode' => 'InvalidClientIp.Policy', - 'errorMessage' => 'Client ip %s is not in white list.', - ], + ['errorCode' => 'DesktopMemoryHighLoad%s', 'errorMessage' => 'The specified desktop memory high load.', 'description' => '此台云电脑的内存使用率过高导致连接超时，占用内存最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员.'], + ['errorCode' => 'DesktopCpuHighLoad%s', 'errorMessage' => 'The specified desktop cpu high load.', 'description' => '此台云电脑的CPU使用率过高导致连接超时，占用CPU最高的应用为%s。请重新连接或重启云电脑。如仍旧出现连接失败,请联系IT管理员。'], + ['errorCode' => 'InvalidClientIp.Policy', 'errorMessage' => 'Client ip %s is not in white list.', 'description' => 'IT管理员设置了IP白名单策略导致无法在您目前的IP环境（%s）下连接此台云电脑，请联系IT管理员。'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c63862da\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"P2PToken\\": \\"\\",\\n \\"DesktopId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetConnectionTicketResponse>\\n <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>\\n <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TaskStatus>Finished</TaskStatus>\\n</GetConnectionTicketResponse>","errorExample":""}]', 'title' => '获取云电脑连接凭证', + 'summary' => '获取云电脑连接凭证。', 'description' => '首次调用该接口时，将返回`TaskID`，使用该`TaskID`继续调用该接口，直到`TaskStatus`的值变为`FINISHED`或者`FAILED`。`TaskStatus`为`FINISHED`时，`Ticket`的值即为客户端连接云电脑的Ticket。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-10-17T09:12:25.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2024-11-24T01:49:36.000Z', 'description' => '错误码发生变更、请求参数发生变更'], + ['createdAt' => '2022-05-19T02:44:07.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c63862da\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"P2PToken\\": \\"\\",\\n \\"DesktopId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetConnectionTicketResponse>\\n <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>\\n <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TaskStatus>Finished</TaskStatus>\\n</GetConnectionTicketResponse>","errorExample":""}]', + ], + 'GetLoginToken' => [ + 'summary' => '获取登录凭证。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + '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', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ - 'name' => 'SessionId', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '办公网络ID，与`OfficeSiteId`含义相同。建议停止使用`DirectoryId`，改为使用`OfficeSiteId`。`DirectoryId`和`OfficeSiteId`只能填写一个，不可同时填写。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-885351****'], ], [ - 'name' => 'LoginToken', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-885351****'], ], [ - 'name' => 'ClientOS', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '运行客户端的设备的操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => '登录的会话ID。'."\n" + ."\n" + .'- 若未绑定虚拟MFA设备或者未开启客户端二次认证，则不需要填写`SessionId`。'."\n" + .'- 若已绑定虚拟MFA设备或者已开启客户端二次认证，则`ADPassword`之后的登录认证阶段需要填写`SessionId`。可从便捷账号验证（即`GetLoginToken`请求处于`ADPassword`阶段）的返回结果中获取`SessionId`。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ - 'name' => 'ClientVersion', + 'name' => 'CurrentStage', 'in' => 'query', - 'schema' => [ - 'description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => ' 2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => '当前登录认证阶段，依次为：'."\n" + ."\n" + .'- `ADPassword`：验证用户信息。当使用便捷账号或者AD账号的账密认证时填写此值。'."\n" + .'- `MFABind`：绑定虚拟MFA设备。'."\n" + .'- `MFAVerify`：验证虚拟MFA设备生成的安全码。'."\n" + .'- `TokenVerify`：客户端二次认证。'."\n" + .'- `ChangePassword`：修改用户密码。'."\n" + .'- `KeepAliveVerify`: KeepAliveToken有效时，可用于换取LoginToken。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ADPassword'], ], [ - 'name' => 'DesktopId', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '云电脑ID列表。可设置1\\~20个。', - 'type' => 'array', - 'items' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-cg27ufmapab08****', - ], - 'required' => true, - 'example' => 'ecd-cg27ufmapab08****', - 'maxItems' => 100, - ], + 'schema' => ['description' => '便捷用户或AD用户的用户名。当`CurrentStage`为`ADPassword`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice'], ], [ - 'name' => 'ClientToken', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****', - ], + 'schema' => ['description' => '便捷用户或AD用户的密码。当`CurrentStage`为`ADPassword`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Password1234'], ], [ - 'name' => 'Uuid', + 'name' => 'OldPassword', 'in' => 'query', - 'schema' => [ - 'description' => '客户端唯一标识符。', - 'type' => 'string', - 'required' => false, - 'example' => '71F6A700735E74A61161A53F0C47****', - ], - ], - ], - '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":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","errorExample":""}]', - 'title' => '启动云电脑', - 'summary' => '启动一台或者多台云电脑。', - 'description' => '云电脑的状态必须为已停止（Stopped），接口调用成功后，云电脑的状态将变更为运行中（Running）。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], + 'schema' => ['description' => '旧密码。当`CurrentStage`为`ChangePassword`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'OldPassword'], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'NewPassword', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '新密码。当`CurrentStage`为`ChangePassword`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'NewPassword'], ], [ - 'name' => 'ClientId', + 'name' => 'AuthenticationCode', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '虚拟MFA设备生成的安全码。当`CurrentStage`为`MFAVerify`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '47****'], ], [ - 'name' => 'SessionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '运行客户端的设备的操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756'], ], [ - 'name' => 'ClientOS', + 'name' => 'TokenCode', 'in' => 'query', - 'schema' => [ - 'description' => '运行客户端的设备的操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => '若已在无影云电脑控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当`CurrentStage`为`TokenVerify`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '63****'], ], [ - 'name' => 'ClientVersion', + 'name' => 'KeepAlive', 'in' => 'query', 'schema' => [ - 'description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', + 'description' => '是否保持登录。', + 'type' => 'boolean', 'required' => false, - 'example' => '2.1.0-R-20210731.151756', + 'enumValueTitles' => ['null' => '不保持登录 [默认值]', 'true' => '保持登录', 'false' => '不保持登录'], + 'example' => 'false', ], ], [ - 'name' => 'DesktopId', + 'name' => 'KeepAliveToken', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '云电脑ID列表。可设置1\\~20个。', - 'type' => 'array', - 'items' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u**** ', - ], - 'required' => true, - 'example' => 'ecd-7w78ozhjcwa3u**** ', - 'maxItems' => 100, - ], + 'schema' => ['description' => '用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回`KeepAliveToken`，在`KeepAliveToken`有效期内可以调用`GetLoginToken`接口并将`CurrentStage`设为`KeepAliveVerify`来换取登录凭证（LoginToken）。当`CurrentStage`为`KeepAliveVerify`时，`KeepAliveToken`必填。', 'type' => 'string', 'required' => false, 'example' => 'hide'], ], [ - 'name' => 'ClientToken', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '6ce412a8-399f-49f9-9518-66ee028a****', - ], + 'schema' => ['description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => 'C78CA9E99315687575DD2844C1F3****'], ], [ - 'name' => 'SessionToken', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => '登录凭证。', + 'description' => '无影软件客户端类型。', 'type' => 'string', 'required' => false, - 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', + 'enumValueTitles' => ['HTML5' => 'Web客户端', 'WINDOWS' => 'Windows客户端', 'MACOS' => 'macOS客户端', 'IOS' => 'iOS客户端', 'ANDROID' => 'Android客户端'], + 'example' => 'WINDOWS', ], ], [ - 'name' => 'OsUpdate', + 'name' => 'AvailableFeatures', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'boolean', + 'type' => 'object', 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => ''], + 'description' => '', ], ], [ - 'name' => 'Uuid', + 'name' => 'ClientName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -3164,104 +2284,138 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'Email' => ['description' => '用户邮箱。在登录后随LoginToken返回。 '."\n" + ."\n" + .'- 如果是便捷用户，返回创建便捷用户时设置的邮箱。'."\n" + .'- 如果是AD用户，返回以下形式：`用户名@AD域名`。', 'type' => 'string', 'example' => 'alice'], + 'Secret' => ['description' => '绑定虚拟MFA设备时的密钥。用于`MFABind`阶段。'."\n" + ."\n" + .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', 'type' => 'string', 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'EndUserId' => ['description' => '便捷账号用户名或AD用户名。', 'type' => 'string', 'example' => 'alice'], + 'LoginToken' => ['description' => '登录凭证。', 'type' => 'string', 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], + 'NextStage' => ['description' => '预期的下一阶段。例如，若管理员在无影云电脑控制台开启了MFA认证，则当用户名密码认证通过后（即`ADPassword`阶段后），该参数会返回`MFAVerify`，表示此时需要做MFA认证。'."\n" + ."\n" + .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', 'type' => 'string', 'example' => 'MFAVerify'], + 'QrCodePng' => ['description' => '绑定虚拟MFA设备时的密钥二维码。使用Base64编码。可以为空，用于`MFABind`阶段。'."\n" + ."\n" + .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', 'type' => 'string', 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******'], + 'Label' => ['description' => '便捷用户属性。如果是AD用户，则返回空值。', 'type' => 'string', 'example' => 'test:wuying'], + 'SessionId' => ['description' => '会话ID。 仅在同一会话第一次调用`GetLoginToken`时返回。需要多次认证时，后续的阶段需要传入该参数。'."\n" + ."\n" + .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', 'type' => 'string', 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****'], + 'Phone' => ['description' => '便捷用户的手机号。如果是AD用户，则返回空值。', 'type' => 'string', 'example' => '1381111****'], + 'TenantId' => ['description' => '阿里云账号ID。硬件终端识别使用。', 'type' => 'integer', 'format' => 'int64', 'example' => '166353906220****'], + 'KeepAliveToken' => ['description' => '用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回`KeepAliveToken`。若未开启保持登录选项，则返回空值。', 'type' => 'string', 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW'], + 'Industry' => ['description' => '> 内部专用字段，不对外开放使用。', 'type' => 'string', 'example' => 'edu'], + 'Props' => [ + 'description' => '> 内部专用字段，不对外开放使用。', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '> 内部专用字段，不对外开放使用。', 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}'], + ], + 'WindowDisplayMode' => ['description' => '> 内部专用字段，不对外开放使用。', 'type' => 'string', 'example' => 'mode'], + 'RiskVerifyInfo' => [ + 'description' => '登录风险识别相关信息。', + 'type' => 'object', + 'properties' => [ + 'Email' => ['description' => '触发核身时，通过该邮箱进行验证。', 'type' => 'string', 'example' => 'user@example.com'], + 'LastLockDuration' => ['description' => '账号锁定时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1713749778'], + 'Locked' => [ + 'description' => '账号是否已锁定。', + 'type' => 'string', + 'enumValueTitles' => ['true' => '是', 'false' => '否'], + 'example' => 'true', + ], + 'Phone' => ['description' => '触发核身时，通过该手机号进行验证。', 'type' => 'string', 'example' => '1381111****'], + ], ], + 'Reason' => ['description' => '> 内部专用字段，不对外开放使用。', 'type' => 'string', 'example' => 'null'], + 'PasswordStrategy' => [ + 'description' => '> 内部专用字段，不对外开放使用。', + 'type' => 'object', + 'properties' => [ + 'TenantPasswordLength' => ['description' => '> 内部专用字段，不对外开放使用。', 'type' => 'string', 'example' => 'null'], + 'TenantAlternativeChars' => [ + 'description' => '> 内部专用字段，不对外开放使用。', + 'type' => 'array', + 'items' => ['description' => '> 内部专用字段，不对外开放使用。', 'type' => 'string', 'example' => 'null'], + ], + ], + ], + 'NickName' => ['type' => 'string', 'description' => ''], + 'WyId' => ['type' => 'string'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","errorExample":""}]', - 'title' => '停止云电脑', - 'summary' => '停止一台或者多台云电脑。', - 'description' => '云电脑的状态必须为运行中（Running）。接口调用成功后，云电脑的状态将变更为已停止（Stopped）。', + 'title' => '获取登录凭证', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-08-22T02:52:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-07-30T12:42:46.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2025-05-08T08:24:11.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-06-04T02:15:58.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2024-04-23T02:39:56.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-10T13:31:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'], + ['createdAt' => '2022-09-13T10:33:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-09-13T10:33:16.000Z', 'description' => '响应参数发生变更'], + ['createdAt' => '2022-07-07T06:16:23.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-19T02:51:57.000Z', 'description' => '请求参数发生变更、错误码发生变更'], + ['createdAt' => '2021-08-19T02:51:57.000Z', 'description' => '请求参数发生变更、响应参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginToken'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"alice\\",\\n \\"Secret\\": \\"5OCLLKKOJU5HPBX66H3QCTWYI7MH****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\",\\n \\"NextStage\\": \\"MFAVerify\\",\\n \\"QrCodePng\\": \\"5OCLLKKOJU5HPBX66H3QCTWY******\\",\\n \\"Label\\": \\"test:wuying\\",\\n \\"SessionId\\": \\"d6ec166d-ab93-4286-bf7f-a18bb929****\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"TenantId\\": 0,\\n \\"KeepAliveToken\\": \\"006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW\\",\\n \\"Industry\\": \\"edu\\",\\n \\"Props\\": {\\n \\"key\\": \\"{\'dingUserName\': u\'\\\\\\\\u674e\\\\\\\\u66fc\', \'role\': \'student\'}\\"\\n },\\n \\"WindowDisplayMode\\": \\"mode\\",\\n \\"RiskVerifyInfo\\": {\\n \\"Email\\": \\"user@example.com\\",\\n \\"LastLockDuration\\": 1713749778,\\n \\"Locked\\": \\"true\\",\\n \\"Phone\\": \\"1381111****\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"PasswordStrategy\\": {\\n \\"TenantPasswordLength\\": \\"null\\",\\n \\"TenantAlternativeChars\\": [\\n \\"null\\"\\n ]\\n },\\n \\"NickName\\": \\"\\",\\n \\"WyId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetLoginTokenResponse>\\n <Email>alice</Email>\\n <Secret>5OCLLKKOJU5HPBX66H3QCTWYI7MH****</Secret>\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>\\n <EndUserId>alice</EndUserId>\\n <LoginToken>v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****</LoginToken>\\n <NextStage>MFAVerify</NextStage>\\n <QrCodePng>5OCLLKKOJU5HPBX66H3QCTWY******</QrCodePng>\\n <Label>test:wuying</Label>\\n <SessionId>d6ec166d-ab93-4286-bf7f-a18bb929****</SessionId>\\n <Phone>1381111****</Phone>\\n <KeepAliveToken>006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW</KeepAliveToken>\\n <Industry>edu</Industry>\\n <Props>\\n <key>{\'dingUserName\': u\'\\\\u674e\\\\u66fc\', \'role\': \'student\'}</key>\\n </Props>\\n</GetLoginTokenResponse>","errorExample":""}]', ], 'RebootDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '运行客户端的设备的操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => '运行客户端的设备的操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756'], ], [ 'name' => 'DesktopId', @@ -3270,12 +2424,7 @@ 'schema' => [ 'description' => '云电脑ID列表。可设置1\\~20个。', 'type' => 'array', - 'items' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], + 'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****'], 'required' => true, 'example' => 'ecd-7w78ozhjcwa3u**** ', 'maxItems' => 100, @@ -3284,41 +2433,22 @@ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****'], ], [ 'name' => 'SessionToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => false, - 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40'], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '客户端唯一标识符。', - 'type' => 'string', - 'required' => false, - 'example' => '91761ED27169E2FC564F29388E2D****', - ], + 'schema' => ['description' => '客户端唯一标识符。', 'type' => 'string', 'required' => false, 'example' => '91761ED27169E2FC564F29388E2D****'], ], [ 'name' => 'OsUpdate', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -3327,11 +2457,7 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], ], ], @@ -3342,107 +2468,63 @@ 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ReportSessionStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-18T03:52:33.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-04-25T06:05:27.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-05-18T06:48:19.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebootDesktops'], + ], ], + 'ramActions' => [], + ], + 'RefreshLoginToken' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-bp167fcodoa90ixn****', - ], + 'schema' => ['description' => '客户端生成的唯一ID，参考UUID。该参数非敏感字段，无需加密。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ - 'name' => 'SessionId', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['description' => '> 此参数不开放使用。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****'], ], [ - 'name' => 'SessionStatus', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '会话状态。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'SessionLogOff' => '会话关闭', - 'DesktopTimerDisconnection' => '云电脑定时任务断连', - 'SessionReboot' => '重启', - 'DesktopTimerShutdown' => '云电脑定时任务开机', - 'SessionLock' => '登录用户锁定会话', - 'SessionShutdown' => '关机', - 'SessionUnLock' => '登录用户未锁定会话', - 'DesktopTimerReboot' => '云电脑定时任务重启', - 'ConsoleConnect' => '会话开始前的控制台连接', - 'SessionLogOn' => '会话开始', - 'SessionPopup' => '断开连接前会话退出', - 'SessionDisconnect' => '会话断连', - 'ConsoleDisconnect' => '会话注销后控制台断开连接', - ], - 'example' => 'SessionLogOn', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai+dir-238191****'], ], [ - 'name' => 'SessionChangeTime', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话变更的持续时间。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1642909143781', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '连接用户。', - 'type' => 'string', - 'required' => false, - 'example' => 'liming', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice'], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], ], 'responses' => [ @@ -3451,461 +2533,220 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], + 'LoginToken' => ['description' => '登录凭证。', 'type' => 'string', 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****'], ], ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]', - 'title' => '报告会话状态', - 'summary' => '报告会话状态。', - ], - 'ApproveFotaUpdate' => [ - 'summary' => '允许云电脑OTA升级。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshLoginTokenResponse>\\r\\n <RequestId>FE379906-08A4-5893-9C18-77C32566D944</RequestId>\\r\\n</RefreshLoginTokenResponse>","errorExample":""}]', + 'title' => '刷新登录凭证', + 'summary' => '刷新登录凭证。', + 'description' => '登录凭证（LoginToken）的有效期为8小时。如果在8小时内，终端用户没有退出客户端，客户端需要重新刷新登录凭证。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshLoginToken'], + ], ], + 'ramActions' => [], + ], + 'ReportSessionStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'ClientId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd4452bd7-88df-4b90-a409-806da674****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp167fcodoa90ixn****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '4771b873-c757-4893-973c-7f5beejh****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2'], ], [ - 'name' => 'LoginToken', + 'name' => 'SessionStatus', 'in' => 'query', 'schema' => [ - 'description' => '登录凭证。', + 'description' => '会话状态。', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-138dsptkrt00u****', + 'enumValueTitles' => [ + 'SessionLogOff' => '会话关闭', 'DesktopTimerDisconnection' => '云电脑定时任务断连', 'SessionReboot' => '重启', 'DesktopTimerShutdown' => '云电脑定时任务开机', 'SessionLock' => '登录用户锁定会话', 'SessionShutdown' => '关机', 'SessionUnLock' => '登录用户未锁定会话', 'DesktopTimerReboot' => '云电脑定时任务重启', 'ConsoleConnect' => '会话开始前的控制台连接', 'SessionLogOn' => '会话开始', + 'SessionPopup' => '断开连接前会话退出', 'SessionDisconnect' => '会话断连', 'ConsoleDisconnect' => '会话注销后控制台断开连接', + ], + 'example' => 'SessionLogOn', ], ], [ - 'name' => 'AppVersion', + 'name' => 'SessionChangeTime', 'in' => 'query', - 'schema' => [ - 'description' => '应用版本。', - 'type' => 'string', - 'required' => true, - 'example' => '0.0.1-D-20220513.14****', - ], + 'schema' => ['description' => '会话变更的持续时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1642909143781'], ], [ - 'name' => 'Uuid', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的“关于”面板上查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '28c80e90-f71e-4c23-93d6-1225329c****', - ], - ], - [ - 'name' => 'TargetStatus', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '指定云电脑升级之后的状态。'."\n" - ."\n" - .'> 该参数暂未对外开放使用。目前升级完成后，云电脑状态将变成`RUNNING`。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'running' => '运行中', - ], - 'example' => 'running', - ], + 'schema' => ['description' => '连接用户。', 'type' => 'string', 'required' => false, 'example' => 'liming'], ], ], '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****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => '允许云电脑OTA升级', - ], - 'DescribeSnapshots' => [ - 'summary' => '查询一台云电脑的快照列表和快照详细信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]', + 'title' => '报告会话状态', + 'summary' => '报告会话状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReportSessionStatus'], + ], ], + 'ramActions' => [], + ], + 'ResetPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], '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, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SnapshotId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '快照ID。', - 'type' => 'string', - 'required' => false, - 'example' => 's-2ze81owrnv9pity4****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95e41934-383e-4c9f-824f-3b93b19b****'], ], [ - 'name' => 'MaxResults', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '分页查询时，每页最大行数。默认值：100。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-899235****'], ], [ - 'name' => 'NextToken', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '下一个查询开始的Token，NextToken为空表示没有下一个。', - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], + 'schema' => ['description' => '用户。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice'], ], [ - 'name' => 'ClientId', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****', - ], + 'schema' => ['description' => '邮箱。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'a***@example.edu'], ], [ - 'name' => 'SessionId', + 'name' => 'phone', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****', - ], + 'schema' => ['description' => '电话。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '138****1111'], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****', - ], + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****'], ], ], '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' => [ - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => '快照创建时间。按照[ISO8601](~~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' => '正在创建的快照剩余完成时间。单位：秒。', - '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****', - ], - 'RestorePointId' => [ - 'description' => '还原点ID。', - 'type' => 'string', - 'example' => 'rp-btgmaa20wkcju****', - ], - 'RestorePointName' => [ - 'description' => '还原点名称。', - 'type' => 'string', - 'example' => '数据盘备份', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询云电脑快照信息', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]', + 'title' => '重置密码', + 'summary' => '重置用户密码。', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetPassword'], + ], + ], + 'ramActions' => [], ], 'ResetSnapshot' => [ 'summary' => '恢复快照对应的磁盘数据。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~437810~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~437810~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SnapshotId', 'in' => 'query', - 'schema' => [ - 'description' => '快照ID。', - 'type' => 'string', - 'required' => true, - 'example' => 's-2zeipxmnhej803x7****', - ], + 'schema' => ['description' => '快照ID。', 'type' => 'string', 'required' => true, 'example' => 's-2zeipxmnhej803x7****'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****'], ], [ 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => '云电脑ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-e964cr92klwqb****', - ], + 'schema' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-e964cr92klwqb****'], ], [ 'name' => 'StopDesktop', 'in' => 'query', - 'schema' => [ - 'description' => '是否将云电脑关机。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => '是否将云电脑关机。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ @@ -3913,261 +2754,77 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + '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' => '恢复快照对应的磁盘数据', - ], - 'GetCloudDriveServiceMountToken' => [ - 'summary' => '获取企业网盘登录凭证。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => false, - 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => false, - 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-7186763****', - ], - ], + 'changeSet' => [ + ['createdAt' => '2025-01-15T01:27:24.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2024-10-30T09:25:28.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-11-18T00:29:27.000Z', 'description' => 'OpenAPI 下线'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '返回对象。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****', - ], - 'Token' => [ - 'description' => '返回Token信息列表。', - 'type' => 'object', - 'properties' => [ - 'Token' => [ - 'description' => 'Token值。', - 'type' => 'string', - 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****', - ], - 'ExpiredAfter' => [ - 'description' => '到期时间。', - 'type' => 'string', - 'example' => '2022-10-10T04:41:35Z', - ], - 'UsedSize' => [ - 'description' => '已使用的容量。单位：GiB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '605089', - ], - 'TotalSize' => [ - 'description' => '企业网盘总容量。单位：GiB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6050416754750', - ], - 'DomainId' => [ - 'description' => '企业网盘域名。', - 'type' => 'string', - 'example' => 'h****', - ], - 'Status' => [ - 'description' => '当前企业网盘用户的状态。', - 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '已禁用', - 'enabled' => '已启用', - ], - 'example' => 'enabled', - ], - ], - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetSnapshot'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC27288A-F9E1-5092-9B5B-71C27D15****\\",\\n \\"Token\\": {\\n \\"Token\\": \\"7836fa6eced7dc8d54c775k34iu3h4i2kh534f****\\",\\n \\"ExpiredAfter\\": \\"2022-10-10T04:41:35Z\\",\\n \\"UsedSize\\": 605089,\\n \\"TotalSize\\": 6050416754750,\\n \\"DomainId\\": \\"h****\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]', - 'title' => '获取企业网盘登录凭证', + 'ramActions' => [], ], - 'VerifyCredential' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SendTokenCode' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ - 'name' => 'ClientId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-2925105532'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-227468****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ - 'name' => 'LoginToken', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****', - ], + 'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice'], ], [ - 'name' => 'CredentialType', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '指定要清除的登录凭据类型。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'MfaPasscode' => '多因子认证', - 'FingerPrint' => '指纹', - 'Password' => '密码', - ], - 'example' => 'Password', - ], + 'schema' => ['description' => '客户端运行的操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ - 'name' => 'Credential', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '认证信息。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456789cyG', - ], + 'schema' => ['description' => '客户端版本。若使用无影客户端，可在客户端登录界面的“关于”面板上查看该参数。', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756'], ], [ - 'name' => 'EncryptedKey', + 'name' => 'TokenCode', 'in' => 'query', - 'schema' => [ - 'description' => '待加密的密钥ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'drjfs****', - ], + 'schema' => ['description' => '若已在无影云电脑企业版控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当`CurrentStage`为`TokenVerify`时必填。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63****'], ], ], 'responses' => [ @@ -4175,540 +2832,155 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n"], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]', - 'title' => '验证客户端本地会话解锁的凭证', - 'summary' => '验证客户端本地会话解锁的凭证。', - ], - 'GetLoginToken' => [ - 'summary' => '获取登录凭证。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]', + 'title' => '发送登录验证码信息', + 'summary' => '发送登录验证码信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendTokenCode'], + ], ], + 'ramActions' => [], + ], + 'SetFingerPrintTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID，与`OfficeSiteId`含义相同。建议停止使用`DirectoryId`，改为使用`OfficeSiteId`。`DirectoryId`和`OfficeSiteId`只能填写一个，不可同时填写。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-885351****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-885351****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '347431a9-90f6-448e-82c4-42bc84a9****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '登录的会话ID。'."\n" - ."\n" - .'- 若未绑定虚拟MFA设备或者未开启客户端二次认证，则不需要填写`SessionId`。'."\n" - .'- 若已绑定虚拟MFA设备或者已开启客户端二次认证，则`ADPassword`之后的登录认证阶段需要填写`SessionId`。可从便捷账号验证（即`GetLoginToken`请求处于`ADPassword`阶段）的返回结果中获取`SessionId`。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], - ], - [ - 'name' => 'CurrentStage', - 'in' => 'query', - 'schema' => [ - 'description' => '当前登录认证阶段，依次为：'."\n" - ."\n" - .'- `ADPassword`：验证用户信息。当使用便捷账号或者AD账号的账密认证时填写此值。'."\n" - .'- `MFABind`：绑定虚拟MFA设备。'."\n" - .'- `MFAVerify`：验证虚拟MFA设备生成的安全码。'."\n" - .'- `TokenVerify`：客户端二次认证。'."\n" - .'- `ChangePassword`：修改用户密码。'."\n" - .'- `KeepAliveVerify`: KeepAliveToken有效时，可用于换取LoginToken。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ADPassword', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => '便捷用户或AD用户的用户名。当`CurrentStage`为`ADPassword`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'alice', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => '便捷用户或AD用户的密码。当`CurrentStage`为`ADPassword`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Password1234', - ], - ], - [ - 'name' => 'OldPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '旧密码。当`CurrentStage`为`ChangePassword`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'OldPassword', - ], - ], - [ - 'name' => 'NewPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '新密码。当`CurrentStage`为`ChangePassword`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'NewPassword', - ], - ], - [ - 'name' => 'AuthenticationCode', - 'in' => 'query', - 'schema' => [ - 'description' => '虚拟MFA设备生成的安全码。当`CurrentStage`为`MFAVerify`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '47****', - ], - ], - [ - 'name' => 'ClientOS', - 'in' => 'query', - 'schema' => [ - 'description' => '运行客户端的设备的操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****'], ], [ - 'name' => 'ClientVersion', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****'], ], [ - 'name' => 'TokenCode', + 'name' => 'FingerPrintTemplate', 'in' => 'query', - 'schema' => [ - 'description' => '若已在无影云电脑控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当`CurrentStage`为`TokenVerify`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '63****', - ], + 'schema' => ['description' => '指纹模板。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'goG3gG8AAABhujtscn'], ], [ - 'name' => 'KeepAlive', + 'name' => 'EncryptedFingerPrintTemplate', 'in' => 'query', - 'schema' => [ - 'description' => '是否保持登录。', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'null' => '不保持登录 [默认值]', - 'true' => '保持登录', - 'false' => '不保持登录', - ], - 'example' => 'false', - ], + 'schema' => ['description' => '已加密的指纹模板。', 'type' => 'string', 'required' => false, 'example' => 'AAAAAAAAAAAAAA'], ], [ - 'name' => 'KeepAliveToken', + 'name' => 'EncryptedKey', 'in' => 'query', - 'schema' => [ - 'description' => '用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回`KeepAliveToken`，在`KeepAliveToken`有效期内可以调用`GetLoginToken`接口并将`CurrentStage`设为`KeepAliveVerify`来换取登录凭证（LoginToken）。当`CurrentStage`为`KeepAliveVerify`时，`KeepAliveToken`必填。', - 'type' => 'string', - 'required' => false, - 'example' => 'hide', - ], + 'schema' => ['description' => '加密密钥。', 'type' => 'string', 'required' => false, 'example' => 'drjfspchj'], ], [ - 'name' => 'Uuid', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '客户端唯一标识。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => 'C78CA9E99315687575DD2844C1F3****', - ], + 'schema' => ['description' => '密码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'As53328794'], ], [ - 'name' => 'ClientType', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '无影软件客户端类型。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HTML5' => 'Web客户端', - 'WINDOWS' => 'Windows客户端', - 'MACOS' => 'macOS客户端', - 'IOS' => 'iOS客户端', - 'ANDROID' => 'Android客户端', - ], - 'example' => 'WINDOWS', - ], + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription'], ], [ - 'name' => 'AvailableFeatures', + 'name' => 'ClientToken', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - ], - ], - ], - [ - 'name' => 'ClientName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123e4567-e89b-12d3-a456-42665544****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'Email' => [ - 'description' => '用户邮箱。在登录后随LoginToken返回。 '."\n" - ."\n" - .'- 如果是便捷用户，返回创建便捷用户时设置的邮箱。'."\n" - .'- 如果是AD用户，返回以下形式：`用户名@AD域名`。', - 'type' => 'string', - 'example' => 'alice', - ], - 'Secret' => [ - 'description' => '绑定虚拟MFA设备时的密钥。用于`MFABind`阶段。'."\n" - ."\n" - .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', - 'type' => 'string', - 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'EndUserId' => [ - 'description' => '便捷账号用户名或AD用户名。', - 'type' => 'string', - 'example' => 'alice', - ], - 'LoginToken' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - 'NextStage' => [ - 'description' => '预期的下一阶段。例如，若管理员在无影云电脑控制台开启了MFA认证，则当用户名密码认证通过后（即`ADPassword`阶段后），该参数会返回`MFAVerify`，表示此时需要做MFA认证。'."\n" - ."\n" - .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', - 'type' => 'string', - 'example' => 'MFAVerify', - ], - 'QrCodePng' => [ - 'description' => '绑定虚拟MFA设备时的密钥二维码。使用Base64编码。可以为空，用于`MFABind`阶段。'."\n" - ."\n" - .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', - 'type' => 'string', - 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******', - ], - 'Label' => [ - 'description' => '便捷用户属性。如果是AD用户，则返回空值。', - 'type' => 'string', - 'example' => 'test:wuying', - ], - 'SessionId' => [ - 'description' => '会话ID。 仅在同一会话第一次调用`GetLoginToken`时返回。需要多次认证时，后续的阶段需要传入该参数。'."\n" - ."\n" - .'> 关于各认证阶段的详细信息，参见本接口请求参数`CurrentStage`的参数说明。', - 'type' => 'string', - 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****', - ], - 'Phone' => [ - 'description' => '便捷用户的手机号。如果是AD用户，则返回空值。', - 'type' => 'string', - 'example' => '1381111****', - ], - 'TenantId' => [ - 'description' => '阿里云账号ID。硬件终端识别使用。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '166353906220****', - ], - 'KeepAliveToken' => [ - 'description' => '用于保持登录的凭证（Token），在登录成功且用户开启了保持登录选项后，接口会返回`KeepAliveToken`。若未开启保持登录选项，则返回空值。', - 'type' => 'string', - 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW', - ], - 'Industry' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'string', - 'example' => 'edu', - ], - 'Props' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '> 内部专用字段，不对外开放使用。', - 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}', - ], - ], - 'WindowDisplayMode' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'string', - 'example' => 'mode', - ], - 'RiskVerifyInfo' => [ - 'description' => '登录风险识别相关信息。', - 'type' => 'object', - 'properties' => [ - 'Email' => [ - 'description' => '触发核身时，通过该邮箱进行验证。', - 'type' => 'string', - 'example' => 'user@example.com', - ], - 'LastLockDuration' => [ - 'description' => '账号锁定时间。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1713749778', - ], - 'Locked' => [ - 'description' => '账号是否已锁定。', - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '是', - 'false' => '否', - ], - 'example' => 'true', - ], - 'Phone' => [ - 'description' => '触发核身时，通过该手机号进行验证。', - 'type' => 'string', - 'example' => '1381111****', - ], - ], - ], - 'Reason' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'string', - 'example' => 'null', - ], - 'PasswordStrategy' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'object', - 'properties' => [ - 'TenantPasswordLength' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'string', - 'example' => 'null', - ], - 'TenantAlternativeChars' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'array', - 'items' => [ - 'description' => '> 内部专用字段，不对外开放使用。', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - 'NickName' => [ - 'type' => 'string', - ], - 'WyId' => [ - 'type' => 'string', - ], + 'Index' => ['description' => '索引。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****'], + 'EncryptedPassword' => ['description' => '已加密密码。', 'type' => 'string', 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ=='], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"alice\\",\\n \\"Secret\\": \\"5OCLLKKOJU5HPBX66H3QCTWYI7MH****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\",\\n \\"NextStage\\": \\"MFAVerify\\",\\n \\"QrCodePng\\": \\"5OCLLKKOJU5HPBX66H3QCTWY******\\",\\n \\"Label\\": \\"test:wuying\\",\\n \\"SessionId\\": \\"d6ec166d-ab93-4286-bf7f-a18bb929****\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"TenantId\\": 0,\\n \\"KeepAliveToken\\": \\"006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW\\",\\n \\"Industry\\": \\"edu\\",\\n \\"Props\\": {\\n \\"key\\": \\"{\'dingUserName\': u\'\\\\\\\\u674e\\\\\\\\u66fc\', \'role\': \'student\'}\\"\\n },\\n \\"WindowDisplayMode\\": \\"mode\\",\\n \\"RiskVerifyInfo\\": {\\n \\"Email\\": \\"user@example.com\\",\\n \\"LastLockDuration\\": 1713749778,\\n \\"Locked\\": \\"true\\",\\n \\"Phone\\": \\"1381111****\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"PasswordStrategy\\": {\\n \\"TenantPasswordLength\\": \\"null\\",\\n \\"TenantAlternativeChars\\": [\\n \\"null\\"\\n ]\\n },\\n \\"NickName\\": \\"\\",\\n \\"WyId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetLoginTokenResponse>\\n <Email>alice</Email>\\n <Secret>5OCLLKKOJU5HPBX66H3QCTWYI7MH****</Secret>\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>\\n <EndUserId>alice</EndUserId>\\n <LoginToken>v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****</LoginToken>\\n <NextStage>MFAVerify</NextStage>\\n <QrCodePng>5OCLLKKOJU5HPBX66H3QCTWY******</QrCodePng>\\n <Label>test:wuying</Label>\\n <SessionId>d6ec166d-ab93-4286-bf7f-a18bb929****</SessionId>\\n <Phone>1381111****</Phone>\\n <KeepAliveToken>006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW</KeepAliveToken>\\n <Industry>edu</Industry>\\n <Props>\\n <key>{\'dingUserName\': u\'\\\\u674e\\\\u66fc\', \'role\': \'student\'}</key>\\n </Props>\\n</GetLoginTokenResponse>","errorExample":""}]', - 'title' => '获取登录凭证', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RefreshLoginToken' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Index\\": 1,\\n \\"RequestId\\": \\"CDE666EA-4FCD-5024-895C-8698E3D3****\\",\\n \\"EncryptedPassword\\": \\"0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==\\"\\n}","type":"json"}]', + 'title' => '设置指纹模板', + 'changeSet' => [ + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI 下线'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplate'], + ], ], + 'ramActions' => [], + ], + 'SetFingerPrintTemplateDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID，参考UUID。该参数非敏感字段，无需加密。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****'], ], [ - 'name' => 'DirectoryId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '> 此参数不开放使用。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'd28520d4-da0b-4a97-981d-683db865****'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-238191****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****'], ], [ - 'name' => 'SessionId', + 'name' => 'Index', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '索引。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'EndUserId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alice', - ], + 'schema' => ['description' => '描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Finger 1'], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['title' => '', 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****'], ], ], 'responses' => [ @@ -4717,371 +2989,186 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'LoginToken' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshLoginTokenResponse>\\r\\n <RequestId>FE379906-08A4-5893-9C18-77C32566D944</RequestId>\\r\\n</RefreshLoginTokenResponse>","errorExample":""}]', - 'title' => '刷新登录凭证', - 'summary' => '刷新登录凭证。', - 'description' => '登录凭证（LoginToken）的有效期为8小时。如果在8小时内，终端用户没有退出客户端，客户端需要重新刷新登录凭证。', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SendTokenCode' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]', + 'title' => '设置指纹模板描述', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplateDescription'], + ], ], + 'ramActions' => [], + ], + 'StartDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], + ], + [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-2925105532', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], [ - 'name' => 'SessionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => '运行客户端的设备的操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ - 'name' => 'EndUserId', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '用户名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'alice', - ], + 'schema' => ['description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => ' 2.1.0-R-20210731.151756'], ], [ - 'name' => 'ClientOS', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '客户端运行的操作系统。', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', + 'description' => '云电脑ID列表。可设置1\\~20个。', + 'type' => 'array', + 'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-cg27ufmapab08****'], + 'required' => true, + 'example' => 'ecd-cg27ufmapab08****', + 'maxItems' => 100, ], ], [ - 'name' => 'ClientVersion', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '客户端版本。若使用无影客户端，可在客户端登录界面的“关于”面板上查看该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****'], ], [ - 'name' => 'TokenCode', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '若已在无影云电脑企业版控制台开启客户端二次认证，且识别到当前登录用户有风险时，会发送该二次认证验证码到终端用户邮箱。当`CurrentStage`为`TokenVerify`时必填。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '63****', - ], + 'schema' => ['description' => '客户端唯一标识符。', 'type' => 'string', 'required' => false, 'example' => '71F6A700735E74A61161A53F0C47****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n", - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]', - 'title' => '发送登录验证码信息', - 'summary' => '发送登录验证码信息。', - ], - 'ChangePassword' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","errorExample":""}]', + 'title' => '启动云电脑', + 'summary' => '启动一台或者多台云电脑。', + 'description' => '云电脑的状态必须为已停止（Stopped），接口调用成功后，云电脑的状态将变更为运行中（Running）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-25T06:05:27.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => '请求参数发生变更'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDesktops'], + ], ], + 'ramActions' => [], + ], + 'StopDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-227468****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => '用户。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alice', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - ], - [ - 'name' => 'OldPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '旧密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '12345678', - ], - ], - [ - 'name' => 'NewPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '新密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '67436290', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息集合。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****', - ], - 'LoginToken' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]', - 'title' => '修改密码', - 'summary' => '修改用户密码。', - ], - 'ResetPassword' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****'], ], - ], - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '运行客户端的设备的操作系统。', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64'], ], [ - 'name' => 'ClientId', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '95e41934-383e-4c9f-824f-3b93b19b****', - ], + 'schema' => ['description' => '客户端版本。若使用无影客户端，可在客户端登录界面的**关于**对话框中查看该参数。', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', + 'description' => '云电脑ID列表。可设置1\\~20个。', + 'type' => 'array', + 'items' => ['description' => '云电脑ID。', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u**** '], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-899235****', + 'example' => 'ecd-7w78ozhjcwa3u**** ', + 'maxItems' => 100, ], ], [ - 'name' => 'EndUserId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '用户。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alice', - ], + 'schema' => ['title' => '', 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '6ce412a8-399f-49f9-9518-66ee028a****'], ], [ - 'name' => 'Email', + 'name' => 'SessionToken', 'in' => 'query', - 'schema' => [ - 'description' => '邮箱。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'a***@example.edu', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => false, 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40'], ], [ - 'name' => 'phone', + 'name' => 'OsUpdate', 'in' => 'query', - 'schema' => [ - 'description' => '电话。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '138****1111', - ], + 'schema' => ['type' => 'boolean', 'required' => false, 'description' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => ''], ], ], 'responses' => [ @@ -5090,272 +3177,111 @@ 'description' => '返回信息集合。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]', - 'title' => '重置密码', - 'summary' => '重置用户密码。', - ], - 'EncryptPassword' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","errorExample":""}]', + 'title' => '停止云电脑', + 'summary' => '停止一台或者多台云电脑。', + 'description' => '云电脑的状态必须为运行中（Running）。接口调用成功后，云电脑的状态将变更为已停止（Stopped）。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDesktops'], + ], ], + 'ramActions' => [], + ], + 'UnbindUserDesktop' => [ + 'summary' => '将用户与云电脑解绑。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClientId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'example' => 'v12307f5e0****'], ], [ - 'name' => 'DirectoryId', + 'name' => 'ClientType', 'in' => 'query', - 'schema' => [ - 'description' => '目录 ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-beijing+dir-131196****', - ], + 'schema' => ['description' => '客户端的类型。', 'type' => 'string', 'required' => false, 'example' => 'windows'], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-beijing+dir-131196****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'example' => '58f96f67-7944-4f97-9342-****'], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '3b053331-dc98-43d8-b247-****'], ], [ - 'name' => 'LoginToken', + 'name' => 'UserDesktopId', 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****', - ], + 'schema' => ['description' => '用户云电脑ID。', 'type' => 'string', 'required' => true, 'example' => 'ud-sdfs****'], ], [ - 'name' => 'Password', + 'name' => 'Force', 'in' => 'query', 'schema' => [ - 'description' => '密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Ab123456', + 'description' => '是否强制解绑。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '即使在连接状态下也会解绑', 'false' => '只有在未连接的状态下才解绑'], + 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回对象。', + 'title' => 'Schema of Response', + 'description' => '返回信息合集。', 'type' => 'object', 'properties' => [ - 'EncryptedPassword' => [ - 'description' => '已加密密码。', - 'type' => 'string', - 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D5B7CF35-E078-5EBF-A010-****'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]', - 'title' => '加密密码', - 'summary' => '加密用户密码。', - ], - 'DescribeFingerPrintTemplates' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '61e39dc6-0450-45f6-a372-2a09e938****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息集合。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****', - ], - 'FingerPrintTemplates' => [ - 'description' => '指纹模板对象。', - 'type' => 'array', - 'items' => [ - 'description' => '指纹模板对象。', - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => '索引。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreationTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-03-13T13:26:29Z', - ], - 'LoginTime' => [ - 'description' => '登录时间。', - 'type' => 'string', - 'example' => '2022-03-13T13:26:29Z', - ], - 'EndUserId' => [ - 'description' => '用户。', - 'type' => 'string', - 'example' => 'alice', - ], - 'Description' => [ - 'description' => '描述信息。', - 'type' => 'string', - 'example' => 'Finger 1', - ], - 'OfficeSiteId' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-074949****', - ], - 'ClientId' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****', - ], - ], - ], - ], - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]', + 'title' => '将用户与云电脑解绑', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindUserDesktop'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C1D3FBE-84E1-5ABB-AD98-2003AC71****\\",\\n \\"FingerPrintTemplates\\": [\\n {\\n \\"Index\\": 1,\\n \\"CreationTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"LoginTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"Description\\": \\"Finger 1\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-074949****\\",\\n \\"ClientId\\": \\"2258a3d5-b8f8-4d79-a221-eaecf211****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询指纹模板', - 'summary' => '查询指纹模板。', + 'ramActions' => [], ], - 'SetFingerPrintTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'VerifyCredential' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -5366,110 +3292,49 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '347431a9-90f6-448e-82c4-42bc84a9****', - ], + 'schema' => ['description' => '客户端生成的唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****'], ], [ - 'name' => 'SessionId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****', - ], + 'schema' => ['description' => '办公网络ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-227468****'], ], [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****', - ], - ], - [ - 'name' => 'FingerPrintTemplate', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '指纹模板。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'goG3gG8AAABhujtscn', - ], + 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****'], ], [ - 'name' => 'EncryptedFingerPrintTemplate', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '已加密的指纹模板。', - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAAAAAAAAAA', - ], + 'schema' => ['description' => '登录凭证。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****'], ], [ - 'name' => 'EncryptedKey', + 'name' => 'CredentialType', 'in' => 'query', 'schema' => [ - 'description' => '加密密钥。', + 'description' => '指定要清除的登录凭据类型。', 'type' => 'string', 'required' => false, - 'example' => 'drjfspchj', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => '密码。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'As53328794', + 'docRequired' => false, + 'enumValueTitles' => ['MfaPasscode' => '多因子认证', 'FingerPrint' => '指纹', 'Password' => '密码'], + 'example' => 'Password', ], ], [ - 'name' => 'Description', + 'name' => 'Credential', 'in' => 'query', - 'schema' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testDescription', - ], + 'schema' => ['description' => '认证信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456789cyG'], ], [ - 'name' => 'ClientToken', + 'name' => 'EncryptedKey', 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123e4567-e89b-12d3-a456-42665544****', - ], + 'schema' => ['description' => '待加密的密钥ID。', 'type' => 'string', 'required' => false, 'example' => 'drjfs****'], ], ], 'responses' => [ @@ -5477,425 +3342,591 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => '索引。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****', - ], - 'EncryptedPassword' => [ - 'description' => '已加密密码。', - 'type' => 'string', - 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Index\\": 1,\\n \\"RequestId\\": \\"CDE666EA-4FCD-5024-895C-8698E3D3****\\",\\n \\"EncryptedPassword\\": \\"0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==\\"\\n}","type":"json"}]', - 'title' => '设置指纹模板', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]', + 'title' => '验证客户端本地会话解锁的凭证', + 'summary' => '验证客户端本地会话解锁的凭证。', + 'changeSet' => [ + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCredential'], + ], + ], + 'ramActions' => [], ], - 'SetFingerPrintTemplateDescription' => [ - 'methods' => [ - 'post', - 'get', + ], + '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' => 'DescribeOfficeSites'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-10-24T07:30:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetConnectionTicket'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2025-10-17T09:12:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RebootDesktops'], + ['description' => '请求参数发生变更', 'api' => 'StopDesktops'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'd28520d4-da0b-4a97-981d-683db865****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****', - ], - ], - [ - 'name' => 'Index', - 'in' => 'query', - 'schema' => [ - 'description' => '索引。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '描述。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Finger 1', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], - ], + 'createdAt' => '2025-03-18T03:52:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ApproveFotaUpdate'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息集合。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****', - ], - ], - ], - ], + 'createdAt' => '2025-02-26T08:11:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeUserResources'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]', - 'title' => '设置指纹模板描述', + 'createdAt' => '2025-02-25T11:43:07.000Z', + 'description' => '', ], - 'DeleteFingerPrintTemplate' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeSnapshots'], + ['description' => '请求参数发生变更', 'api' => 'ResetSnapshot'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-01-15T01:27:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更、请求参数发生变更', 'api' => 'GetConnectionTicket'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2024-11-24T01:49:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '会话ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6df06330-3b75-4768-b334-41a73a64****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '登录凭证。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****', - ], - ], - [ - 'name' => 'Index', - 'in' => 'query', - 'schema' => [ - 'description' => '索引。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '4', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], - ], + 'createdAt' => '2024-11-09T02:21:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ResetSnapshot'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '返回信息集合。', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****', - ], - ], - ], - ], + 'createdAt' => '2024-10-30T09:25:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]', - 'title' => '删除指纹模板', + 'createdAt' => '2024-09-27T07:36:48.000Z', + 'description' => '', ], - 'IsKeepAlive' => [ - 'summary' => '判断客户端是否保持登录状态。', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-08-13T06:27:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetLoginToken'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2024-06-04T02:16:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RebootDesktops'], + ['description' => '请求参数发生变更', 'api' => 'StartDesktops'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '客户端生成的唯一ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-885351****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。可以调用[DescribeRegions](~~196646~~)获取无影云电脑支持的地域列表。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], + 'createdAt' => '2024-04-25T06:05:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetLoginToken'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'."\n", - ], - 'OfficeSiteId' => [ - 'description' => '办公网络ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-885351****'."\n", - ], - 'TenantId' => [ - 'description' => '阿里云账号UID。', - 'type' => 'string', - 'example' => '141631846826****', - ], - 'IsKeepAlive' => [ - 'description' => '是否保持登录。', - 'type' => 'boolean', - 'example' => 'True', - ], - ], - ], - ], + 'createdAt' => '2024-04-23T02:40:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更', 'api' => 'GetLoginToken'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\\\n\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-885351****\\\\n\\",\\n \\"TenantId\\": \\"141631846826****\\",\\n \\"IsKeepAlive\\": true\\n}","type":"json"}]', - 'title' => '判断是否已开启保持登录', + 'createdAt' => '2024-04-10T13:31:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-12-13T06:22:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-12-11T04:08:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ApproveFotaUpdate'], + ], + 'createdAt' => '2023-09-21T08:18:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-08-02T09:43:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'RebootDesktops'], + ['description' => '请求参数发生变更', 'api' => 'StopDesktops'], + ], + 'createdAt' => '2023-05-18T06:48:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-05-18T06:08:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ApproveFotaUpdate'], + ], + 'createdAt' => '2023-03-24T08:22:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-03-24T08:20:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2023-01-09T11:54:49.000Z', + 'description' => '匿名接口返回私网网关地址', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-12-26T02:25:44.000Z', + 'description' => '返回续费活动通知', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeDesktops'], + ['description' => '请求参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-11-29T11:36:18.000Z', + 'description' => '查询桌面接口增加orderby字段，支持按分配时间排序', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'UnbindUserDesktop'], + ], + 'createdAt' => '2022-11-02T14:29:58.000Z', + 'description' => '增加入参：是否强制解绑，默认不强制', ], - ], - 'endpoints' => [ [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-10-27T10:48:58.000Z', + 'description' => '增加返回值realDesktopId', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-10-25T14:54:13.000Z', + 'description' => '新增status字段，标志用户当前是否被禁用', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-10-18T15:11:17.000Z', + 'description' => '桌面查询全局搜索接口增加fota查询字段', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ['description' => 'OpenAPI 下线', 'api' => 'ModifyEndUserAttribute'], + ], + 'createdAt' => '2022-10-17T02:12:02.000Z', + 'description' => '新增功能：1.端侧用户可以自定义自己拥有的桌面名称；2.自定义桌面名称将会在端侧展示', ], [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'GetLoginToken'], + ['description' => '响应参数发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-09-13T10:33:37.000Z', + 'description' => '内部参数调用', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-08-17T02:10:31.000Z', + 'description' => '无影云盘支持登录AD账户登录', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-07-07T06:16:44.000Z', + 'description' => '隐藏不对外的参数', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-06-22T12:51:50.000Z', + 'description' => '增加字段供企业标识符使用', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-06-10T05:54:18.000Z', + 'description' => '匿名接口增加桌面私网IP透出', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDesktopSearchFields'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeGlobalBundles'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeGlobalDesktops'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeGlobalDesktopTypes'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeGlobalOfficeSites'], + ], + 'createdAt' => '2022-06-06T03:17:33.000Z', + 'description' => 'Meta搜索服务接口', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetConnectionTicket'], + ], + 'createdAt' => '2022-05-26T08:24:41.000Z', + 'description' => 'DoAfterGetTicketParam因为命名规范要求更改成ComandContent', ], [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-05-13T04:04:21.000Z', + 'description' => '修改文档必填参数', ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'CreateOrUpdateInternetPolicy'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeDirectoryInternetPolicy'], + ['description' => 'OpenAPI 下线', 'api' => 'SetStudentsDesktopGroupPolicy'], + ], + 'createdAt' => '2022-04-29T08:17:38.000Z', + 'description' => '【少年云】新增学生桌面组黑白名单配置', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'ResetPassword'], + ], + 'createdAt' => '2022-04-27T09:07:17.000Z', + 'description' => '客户端忘记密码去掉邮件必填的限制', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-04-25T08:57:10.000Z', + 'description' => '去除无用参数', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DeleteFingerPrintTemplate'], + ['description' => '请求参数发生变更', 'api' => 'RebootDesktops'], + ['description' => '请求参数发生变更', 'api' => 'ResetPassword'], + ['description' => '请求参数发生变更', 'api' => 'SetFingerPrintTemplate'], + ['description' => '请求参数发生变更', 'api' => 'SetFingerPrintTemplateDescription'], + ['description' => '请求参数发生变更', 'api' => 'StartDesktops'], + ], + 'createdAt' => '2022-04-13T08:46:21.000Z', + 'description' => '增加clientToken字段，支持幂等调用。', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-03-29T08:28:02.000Z', + 'description' => '客户端支持访问pds', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'ecd.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'ApproveFotaUpdate'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-03-21T13:00:36.000Z', + 'description' => '支持镜像升级API', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'StopDesktops'], + ], + 'createdAt' => '2022-03-17T08:44:28.000Z', + 'description' => '修改stopDesktops接口，增加clientToken字段，支持幂等。', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeOfficeSiteInternetStatus'], + ['description' => 'OpenAPI 下线', 'api' => 'SetOfficeSiteInternetStatus'], + ], + 'createdAt' => '2022-03-14T10:49:36.000Z', + 'description' => '增加查询桌面组网络状态和修改桌面组网络状态。', ], [ - 'regionId' => 'me-central-1', - 'endpoint' => 'ecd.me-central-1.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-02-16T03:21:48.000Z', + 'description' => '客户端匿名接口GetLoginToken增加sso相关信息修改', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'BatchGetLiteConnectionTicket'], + ], + 'createdAt' => '2022-01-19T15:24:34.000Z', + 'description' => 'lite版getConnectionTicket接口支持客户端重连', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-01-13T08:09:33.000Z', + 'description' => '客户端匿名接口增加clientType', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'ecd.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-01-11T08:11:27.000Z', + 'description' => '增加gpu显存参数', ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'ChangePassword'], + ['description' => '响应参数发生变更', 'api' => 'RefreshLoginToken'], + ], + 'createdAt' => '2021-12-14T04:01:48.000Z', + 'description' => 'RefreshLoginToken和ChangePassword返回LoginToken', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2021-12-08T05:40:52.000Z', + 'description' => 'DescribeDesktops返回参数增加GpuCount', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DescribeSnapshots'], + ['description' => 'OpenAPI 下线', 'api' => 'ResetSnapshot'], + ], + 'createdAt' => '2021-11-18T05:40:11.000Z', + 'description' => '增加客户端快照接口', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetLoginToken'], + ['description' => '请求参数发生变更', 'api' => 'SetFingerPrintTemplate'], + ['description' => '请求参数发生变更', 'api' => 'VerifyCredential'], + ], + 'createdAt' => '2021-10-23T01:17:39.000Z', + 'description' => '指纹数据加密传输', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'GetLoginToken'], + ['description' => 'OpenAPI 下线', 'api' => 'IsKeepAlive'], + ], + 'createdAt' => '2021-09-10T12:50:31.000Z', + 'description' => '增加保持登录参数', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2021-08-19T02:52:32.000Z', + 'description' => 'GetLoginToken新增参数支持指纹登录', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI 下线', 'api' => 'DeleteFingerPrintTemplate'], + ['description' => 'OpenAPI 下线', 'api' => 'DescribeFingerPrintTemplates'], + ['description' => 'OpenAPI 下线', 'api' => 'SetFingerPrintTemplate'], + ['description' => 'OpenAPI 下线', 'api' => 'SetFingerPrintTemplateDescription'], + ], + 'createdAt' => '2021-08-18T07:13:29.000Z', + 'description' => '指纹登录相关API', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangePassword'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetPassword'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebootDesktops'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplate'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplateDescription'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetSnapshot'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOfficeSites'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSnapshots'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserResources'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindUserDesktop'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCloudDriveServiceMountToken'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFingerPrintTemplates'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPassword'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCredential'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendTokenCode'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDesktops'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktops'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFingerPrintTemplate'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDesktops'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginToken'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RefreshLoginToken'], + ], + ], + 'ram' => [ + 'productCode' => 'ECD', + 'productName' => '无影云电脑', + 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'], + 'ramLevel' => '服务级', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |