diff options
Diffstat (limited to 'data/en_us/ecd/2020-10-02/api-docs.php')
| -rw-r--r-- | data/en_us/ecd/2020-10-02/api-docs.php | 6973 |
1 files changed, 2441 insertions, 4532 deletions
diff --git a/data/en_us/ecd/2020-10-02/api-docs.php b/data/en_us/ecd/2020-10-02/api-docs.php index 2463802..36521ac 100644 --- a/data/en_us/ecd/2020-10-02/api-docs.php +++ b/data/en_us/ecd/2020-10-02/api-docs.php @@ -1,174 +1,285 @@ <?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' => 'Cloud resource management', + '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' => 'Cloud resource management', ], [ - 'id' => 203310, + 'children' => ['GetLoginToken', 'RefreshLoginToken', 'SetFingerPrintTemplate', 'SetFingerPrintTemplateDescription', 'DeleteFingerPrintTemplate'], + 'type' => 'directory', 'title' => 'User logon', + ], + [ + 'children' => ['ApproveFotaUpdate', 'ChangePassword', 'DescribeDirectories', 'DescribeFingerPrintTemplates', 'DescribeGlobalDesktops', 'DescribeOfficeSites', 'DescribeRegions', 'DescribeSnapshots', 'EncryptPassword', 'GetConnectionTicket', 'RebootDesktops', 'ResetPassword', 'ResetSnapshot', 'SendTokenCode', 'StartDesktops', 'StopDesktops', 'UnbindUserDesktop'], + 'title' => 'Others', 'type' => 'directory', - 'children' => [ - 'GetLoginToken', - 'RefreshLoginToken', - 'SendTokenCode', - 'ChangePassword', - 'ResetPassword', - 'EncryptPassword', - 'DescribeFingerPrintTemplates', - 'SetFingerPrintTemplate', - 'SetFingerPrintTemplateDescription', - 'DeleteFingerPrintTemplate', - 'IsKeepAlive', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DescribeRegions' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ApproveFotaUpdate' => [ + 'summary' => 'Enables OTA updates for cloud computers.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd4452bd7-88df-4b90-a409-806da674****', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '4771b873-c757-4893-973c-7f5beejh****', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-138dsptkrt00u****', 'title' => ''], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => ['description' => 'The application version.'."\n", 'type' => 'string', 'required' => true, 'example' => '0.0.1-D-20220513.14****', 'title' => ''], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the client. To view the unique identifier of an Alibaba Cloud Workspace client, go to the client logon page and click on "About."'."\n", 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329c****', 'title' => ''], + ], + [ + 'name' => 'TargetStatus', + 'in' => 'query', 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'description' => 'The state of the cloud computer after the OTA update.'."\n" + ."\n" + .'> This parameter is not publicly available. After the OTA update is complete, the state of the cloud computer changes to `RUNNING`.'."\n" + ."\n" + .'* Set the value to running.'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****', + 'required' => false, + 'enumValueTitles' => ['running' => ''], + 'example' => 'running', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'Regions' => [ - 'description' => 'The regions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The region.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionEndpoint' => [ - 'description' => 'The region endpoint.'."\n", - 'type' => 'string', - 'example' => 'ecd.cn-hangzhou.aliyuncs.com', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeRegions', - ], - 'DescribeDirectories' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ApproveFotaUpdate', + 'changeSet' => [ + ['createdAt' => '2025-02-26T08:10:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-21T08:17:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-14T02:07:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-21T12:59:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ApproveFotaUpdate'], + ], ], + 'ramActions' => [], + ], + 'ChangePassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-227468****', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], + ], + [ + 'name' => 'OldPassword', + 'in' => 'query', + 'schema' => ['description' => 'The current password.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12345678', 'title' => ''], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => ['description' => 'The new password.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '67436290', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****', 'title' => ''], + 'LoginToken' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ChangePassword', + 'summary' => 'Changes the password of a user account.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangePassword'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]', + ], + 'DeleteFingerPrintTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'ClientId', 'in' => 'query', + 'schema' => ['description' => 'Unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '6df06330-3b75-4768-b334-41a73a64****', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****', 'title' => ''], + ], + [ + 'name' => 'Index', + 'in' => 'query', + 'schema' => ['description' => 'Index.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '4', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII characters and must not exceed 64 characters. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', + 'description' => 'Response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]', + 'title' => 'DeleteFingerPrintTemplate', + 'changeSet' => [ + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFingerPrintTemplate'], + ], + ], + 'ramActions' => [], + 'summary' => '', + ], + 'DescribeDirectories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', 'title' => ''], + ], [ 'name' => 'DirectoryId', 'in' => 'query', @@ -176,14 +287,11 @@ 'schema' => [ 'description' => 'The directory IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The directory ID, which is the same as the office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], + 'items' => ['description' => 'The directory ID, which is the same as the office network ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], @@ -193,11 +301,7 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F369A091-002F-49C8-AD55-02A77629****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F369A091-002F-49C8-AD55-02A77629****', 'title' => ''], 'Directories' => [ 'description' => 'The directories.'."\n", 'type' => 'array', @@ -205,16 +309,8 @@ 'description' => 'The directory.'."\n", 'type' => 'object', 'properties' => [ - 'DirectoryType' => [ - 'description' => 'The directory type.'."\n", - 'type' => 'string', - 'example' => 'AD_CONNECTOR', - ], - 'SsoServiceUrl' => [ - 'description' => 'The URL of the SSO service.'."\n", - 'type' => 'string', - 'example' => 'https://eds-cn-shanghai-67726****', - ], + 'DirectoryType' => ['description' => 'The directory type.'."\n", 'type' => 'string', 'example' => 'AD_CONNECTOR', 'title' => ''], + 'SsoServiceUrl' => ['description' => 'The URL of the SSO service.'."\n", 'type' => 'string', 'example' => 'https://eds-cn-shanghai-67726****', 'title' => ''], 'DesktopAccessType' => [ 'description' => 'The connection method.'."\n" ."\n" @@ -224,105 +320,65 @@ .'* INTERNET: End users connect to cloud computers over the Internet.'."\n" .'* ANY: End users connect to cloud computers over the Internet or an enterprise VPC.'."\n", 'type' => 'string', - 'enumValueTitles' => [ - 'VPC连接' => '', - 'INTERNET' => '', - 'ANY' => '', - ], + 'enumValueTitles' => ['VPC连接' => '', 'INTERNET' => '', 'ANY' => ''], 'example' => 'INTERNET', + 'title' => '', ], - 'DirectoryId' => [ - 'description' => 'The directory ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', - ], - 'ProviderId' => [ - 'description' => 'The provider ID.'."\n", - 'type' => 'string', - 'example' => '26842', - ], + 'DirectoryId' => ['description' => 'The directory ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', 'title' => ''], + 'ProviderId' => ['description' => 'The provider ID.'."\n", 'type' => 'string', 'example' => '26842', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A77629****\\",\\n \\"Directories\\": [\\n {\\n \\"DirectoryType\\": \\"AD_CONNECTOR\\",\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67726****\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ProviderId\\": \\"26842\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'DescribeDirectories', 'summary' => 'Queries directory details.', - ], - 'DescribeOfficeSites' => [ - 'summary' => 'Queries office networks.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDirectories'], + ], ], + 'ramActions' => [], + '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"}]', + ], + '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', - ], + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '61e39dc6-0450-45f6-a372-2a09e938****', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'SessionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'title' => 'uuid', - 'description' => 'uuid'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASDASD', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****', 'title' => ''], ], ], 'responses' => [ @@ -331,90 +387,50 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'OfficeSites' => [ - 'description' => 'The office networks.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****', 'title' => ''], + 'FingerPrintTemplates' => [ + 'description' => 'The fingerprint templates.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about the office network.'."\n", + 'description' => 'The fingerprint template.'."\n", 'type' => 'object', 'properties' => [ - 'SsoServiceUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://eds-cn-shanghai-67****', - ], - 'DesktopAccessType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - 'Any' => '', - ], - 'example' => 'VPC', - ], - 'DesktopVpcEndpoint' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', - ], - 'OfficeSiteType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ad_connector' => '', - 'simple' => '', - ], - 'example' => 'SIMPLE', - ], - 'ProviderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '268****', - ], - 'OfficeSiteId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'BizType' => [ - 'title' => 'biztype', - 'description' => 'biztype'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'ENTERPRISE', - ], - 'AliUid' => [ - 'title' => 'aliuid', - 'description' => 'aliuid'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '125552', - ], + 'Index' => ['description' => 'The index.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CreationTime' => ['description' => 'The time when the template was created.'."\n", 'type' => 'string', 'example' => '2022-03-13T13:26:29Z', 'title' => ''], + 'LoginTime' => ['description' => 'The logon time.'."\n", 'type' => 'string', 'example' => '2022-03-13T13:26:29Z', 'title' => ''], + 'EndUserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'Description' => ['description' => 'The description of the template.'."\n", 'type' => 'string', 'example' => 'Finger 1', 'title' => ''], + 'OfficeSiteId' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou+dir-074949****', 'title' => ''], + 'ClientId' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSites\\": [\\n {\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67****\\",\\n \\"DesktopAccessType\\": \\"VPC\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"ProviderId\\": \\"268****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"BizType\\": 0,\\n \\"AliUid\\": 125552\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeOfficeSites', - ], - 'DescribeGlobalDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'DescribeFingerPrintTemplates', + 'summary' => 'Queries fingerprint templates.', + 'changeSet' => [ + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeFingerPrintTemplates'], + ], ], + 'ramActions' => [], + '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"}]', + ], + 'DescribeGlobalDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -423,291 +439,167 @@ 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '121369', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* cn-shanghai: China (Shanghai)'."\n", + 'description' => 'Region ID.', + 'enumValueTitles' => ['cn-shanghai' => 'China (Shanghai)'], 'type' => 'string', 'required' => false, 'docRequired' => true, - 'enumValueTitles' => [ - 'cn-shanghai' => '', - ], 'example' => 'cn-shanghai', + 'title' => '', ], ], [ 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network IDs.'."\n" - ."\n" - .'> This parameter is about to be disabled. Use `OfficeSiteId`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-880841****', - ], + 'schema' => ['description' => 'Office site ID.'."\n" + ."\n" + .'> This parameter is deprecated. Use `OfficeSiteId` instead.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-880841****', 'title' => ''], ], [ 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network IDs.'."\n" - ."\n" - .'> `DirectoryId` the parameter is about to be retired, use this field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-880841****', - ], + 'schema' => ['description' => 'Office site ID.'."\n" + ."\n" + .'> Use this field instead of `DirectoryId`, which is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-880841****', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID generated by the client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****', - ], + 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID. You can call the GetLoginToken operation to query the value of the SessionId parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****', - ], + 'schema' => ['description' => 'Session ID. Get it by calling the GetLoginToken operation. The response includes the SessionId parameter.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token. You can call the GetLoginToken operation to obtain the token. You can also call the UpdateToken operation to obtain the token RefreshLoginToken. Response parameter: LoginToken.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v147c9114a180489f89691663893169****', - ], + 'schema' => ['description' => 'Login token. Get it by calling GetLoginToken, or refresh it by calling RefreshLoginToken. The response includes the LoginToken parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v147c9114a180489f89691663893169****', 'title' => ''], ], [ 'name' => 'DesktopStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The cloud computer status.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Stopped'."\n" - .'* Starting.'."\n" - .'* Rebuilding'."\n" - .'* Running:.'."\n" - .'* Stopping:.'."\n" - .'* Expired'."\n" - .'* Deleted'."\n" - .'* Pending: The resource is still being prepared.'."\n", + 'description' => 'Cloud desktop status.', + 'enumValueTitles' => ['Stopped' => 'Stopped', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Expired' => 'Expired', 'Deleted' => 'Deleted', 'Pending' => 'Pending'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Stopped' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'Expired' => '', - 'Deleted' => '', - 'Pending' => '', - ], 'example' => 'Running', + 'title' => '', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n" - ."\n" - .'* Maximum value: 500.'."\n" - .'* and the default value is 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '500', - ], + 'schema' => ['description' => 'Number of entries per page for paged queries.'."\n" + ."\n" + .'- Maximum: 500'."\n" + ."\n" + .'- Default: 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****', - ], + 'schema' => ['description' => 'Token that marks the start of the next query. If NextToken is empty, no more results are available.', 'type' => 'string', 'required' => false, 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****', 'title' => ''], ], [ 'name' => 'DesktopName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DesktopTest', - ], + 'schema' => ['description' => 'Cloud desktop name.', 'type' => 'string', 'required' => false, 'example' => 'DesktopTest', 'title' => ''], ], [ 'name' => 'DesktopId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The cloud computer ID. You can specify one or more cloud computer IDs. Valid values: 1 to 20.'."\n", + 'description' => 'Cloud desktop ID. You can specify one or more IDs. Valid values: 1 to 20.', 'type' => 'array', - 'items' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-hkbl45il187d6****', - ], + 'items' => ['description' => 'Cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-hkbl45il187d6****', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai', - ], + 'schema' => ['description' => 'Region ID used to filter cloud desktops by region.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', 'title' => ''], ], [ 'name' => 'DesktopAccessType', 'in' => 'query', 'schema' => [ - 'description' => 'The method that is used to connect cloud computers that reside in the office network from WUYING clients.'."\n" + 'description' => 'Connection type allowed when connecting to the cloud desktop.'."\n" ."\n" - .'> The VPC connection method depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. If you set this parameter to VPC or Any, the system automatically enables PrivateLink.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INTERNET (default): End users connect to cloud computers from clients over the Internet.'."\n" - .'* VPC: End users connect to cloud computers from clients over a virtual private cloud (VPC).'."\n" - .'* Any: End users connect to cloud computers from clients over the Internet or a VPC.'."\n", + .'> VPC connections depend on Alibaba Cloud PrivateLink, which incurs no additional charges. When you set this parameter to VPC or Any, PrivateLink is automatically enabled for you.', + 'enumValueTitles' => ['INTERNET' => 'Allow only public network connections \\[default]', 'VPC' => 'Allow only connections from clients within a VPC', 'Any' => 'Let the client choose the connection type'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - 'Any' => '', - ], 'example' => 'INTERNET', + 'title' => '', ], ], [ 'name' => 'QueryFotaUpdate', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query information about the image update.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'Whether to query image update information.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'WithoutLatency', 'in' => 'query', - 'schema' => [ - 'description' => 'Whether to query real-time cloud computer information. The cloud computer status information in the current interface has a delay of 1 to 3 seconds. If you need accurate information, set this value to `true`.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'schema' => ['description' => 'Whether to query real-time cloud desktop information. Because cloud desktop status has a 1–3 second delay, set this value to `true` for accurate information.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => 'The field used for sorting. If you do not specify this option, the system is sorted in descending order of creation time.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AssignTime: sort by allocation time.'."\n", + 'description' => 'Field to sort by. If not specified, results are sorted by creation time in descending order.', + 'enumValueTitles' => ['AssignTime' => 'Sort by assignment time'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'AssignTime' => '', - ], 'example' => 'AssignTime', + 'title' => '', ], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ASC (default): the ascending order.'."\n" - .'* DESC: the descending order.'."\n", + 'description' => 'Sorting order.', + 'enumValueTitles' => ['ASC' => 'Ascending \\[default]', 'DESC' => 'Descending'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], 'example' => 'ASC', + 'title' => '', ], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword. Fuzzy search is supported for cloud computer IDs, cloud computer names, and end user custom cloud computer names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd', - ], + 'schema' => ['description' => 'Keyword. Supports fuzzy search on cloud desktop ID, cloud desktop name, and end-user-defined cloud desktop names.', 'type' => 'string', 'required' => false, 'example' => 'ecd', 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region where the office network resides. This parameter is left empty when you log on with an organization ID.'."\n" - ."\n" - .'* This parameter is required when you log on by using the office network ID.'."\n" - .'* If you log on by using an organization ID, this parameter can be left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID of the office site. Leave this blank if you log on using an organization ID.'."\n" + ."\n" + .'- Required if you log on using an office site ID.'."\n" + ."\n" + .'- Optional if you log on using an organization ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -715,577 +607,594 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n", - 'type' => 'string', - 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4686A731-D601-548C-83E2-4CB6371E****', - ], + 'NextToken' => ['description' => 'Token that marks the start of the next query. If NextToken is empty, no more results are available.', 'type' => 'string', 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4686A731-D601-548C-83E2-4CB6371E****', 'title' => ''], 'Desktops' => [ - 'description' => 'The details about the cloud computer.'."\n", + 'description' => 'Detailed cloud desktop information.', 'type' => 'array', 'items' => [ - 'description' => 'The details about the cloud computer.'."\n", + 'description' => 'Detailed cloud desktop information.', 'type' => 'object', 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the cloud computer was created.'."\n", - 'type' => 'string', - 'example' => '2020-11-06T08:28Z', - ], + 'CreationTime' => ['description' => 'Time when the cloud desktop was created.', 'type' => 'string', 'example' => '2020-11-06T08:28Z', 'title' => ''], 'ChargeType' => [ - 'description' => 'The billing method of the cloud computer pool.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* PostPaid: pay-as-you-go'."\n" - .'* PrePaid: subscription'."\n", + 'description' => 'Billing method.', + 'enumValueTitles' => ['PostPaid' => 'Pay-as-you-go', 'PrePaid' => 'Subscription'], 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], 'example' => 'PostPaid', + 'title' => '', ], - 'DesktopName' => [ - 'description' => 'The cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'testDesktopName', - ], - 'HostName' => [ - 'description' => 'The hostname of the cloud desktop.'."\n", - 'type' => 'string', - 'example' => 'testName', - ], - 'DesktopGroupId' => [ - 'description' => 'The ID of the cloud computer share.'."\n", - 'type' => 'string', - 'example' => 'dg-3uiojcc0j4kh7****', - ], - 'DesktopId' => [ - 'description' => 'The cloud compute ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsmucyy****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'LastStartTime' => [ - 'description' => 'The time when the cloud desktop was last started.'."\n", - 'type' => 'string', - 'example' => '2021-07-13T15:59Z', - ], - 'Cpu' => [ - 'description' => 'The number of vCPUs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'EndUserId' => [ - 'description' => 'The names of end users.'."\n", - 'type' => 'string', - 'example' => 'User1', - ], - 'ExpiredTime' => [ - 'description' => 'The expiration time of the cloud computer.'."\n" - ."\n" - .'* For a cloud computer that is a package year or month, the return value is meaningful.'."\n" - .'* For pay-as-you-go cloud computers, the `2099-12-31T15:59Z` is returned.'."\n", - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], - 'DesktopStatus' => [ - 'description' => 'The cloud computer status.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'DesktopType' => [ - 'description' => 'The cloud computer type.'."\n", - 'type' => 'string', - 'example' => 'ecd.basic.large', - ], + 'DesktopName' => ['description' => 'Cloud desktop name.', 'type' => 'string', 'example' => 'testDesktopName', 'title' => ''], + 'HostName' => ['description' => 'Host name.', 'type' => 'string', 'example' => 'testName', 'title' => ''], + 'DesktopGroupId' => ['description' => 'Shared cloud desktop ID.', 'type' => 'string', 'example' => 'dg-3uiojcc0j4kh7****', 'title' => ''], + 'DesktopId' => ['description' => 'Cloud desktop ID.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + 'RegionId' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'LastStartTime' => ['description' => 'Last startup time — the most recent time the cloud desktop started.', 'type' => 'string', 'example' => '2021-07-13T15:59Z', 'title' => ''], + 'Cpu' => ['description' => 'Number of CPUs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'EndUserId' => ['description' => 'End user name.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'ExpiredTime' => ['description' => 'Time when the cloud desktop expires.'."\n" + ."\n" + .'- Valid for subscription cloud desktops.'."\n" + ."\n" + .'- For pay-as-you-go cloud desktops, always returns `2099-12-31T15:59Z`.', 'type' => 'string', 'example' => '2021-12-31T15:59Z', 'title' => ''], + 'DesktopStatus' => ['description' => 'Cloud desktop status.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DesktopType' => ['description' => 'Cloud desktop specification.', 'type' => 'string', 'example' => 'ecd.basic.large', 'title' => ''], 'ConnectionStatus' => [ - 'description' => 'The state of the endpoint connection.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Connected'."\n" - .'* Disconnecting'."\n" - .'* Pending.'."\n" - .'* Connecting.'."\n" - .'* Disconnected.'."\n" - .'* Deleting'."\n", + 'description' => 'Endpoint connection status.', + 'enumValueTitles' => ['Connected' => 'Connected', 'Disconnecting' => 'Disconnecting', 'Pending' => 'Updating', 'Connecting' => 'Connecting', 'Disconnected' => 'Disconnected', 'Deleting' => 'Deleting'], 'type' => 'string', - 'enumValueTitles' => [ - 'Connected' => '', - 'Disconnecting' => '', - 'Pending' => '', - 'Connecting' => '', - 'Disconnected' => '', - 'Deleting' => '', - ], 'example' => 'Disconnected', + 'title' => '', ], - 'Memory' => [ - 'description' => 'The memory of the cloud computer. Unit: MiB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - ], - 'ImageId' => [ - 'description' => 'The image ID.'."\n", - 'type' => 'string', - 'example' => 'm-4zfb6zj728hhr****', - ], - 'DirectoryId' => [ - 'description' => 'The network ID of the office. Same as `OfficeSiteId`.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** ', - ], + 'Memory' => ['description' => 'Cloud desktop memory size, in MiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'title' => ''], + 'ImageId' => ['description' => 'Image ID.', 'type' => 'string', 'example' => 'm-4zfb6zj728hhr****', 'title' => ''], + 'DirectoryId' => ['description' => 'Office site ID. Same as `OfficeSiteId`.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** ', 'title' => ''], 'Disks' => [ - 'description' => 'The disks.'."\n", + 'description' => 'Disk information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the disk.'."\n", + 'description' => 'Disk information.', 'type' => 'object', 'properties' => [ 'DiskType' => [ - 'description' => 'The disk type.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* SYSTEM: a system disk.'."\n" - .'* DATA: a data disk.'."\n", + 'description' => 'Disk type.', + 'enumValueTitles' => ['SYSTEM' => 'System disk', 'DATA' => 'Data disk'], 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], 'example' => 'SYSTEM', + 'title' => '', ], - 'DiskId' => [ - 'description' => 'The disk ID.'."\n", - 'type' => 'string', - 'example' => 'd-jedbpr4sl9l37****', - ], - 'DiskSize' => [ - 'description' => 'The disk size. Unit: GiB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '80', - ], + 'DiskId' => ['description' => 'Disk ID.', 'type' => 'string', 'example' => 'd-jedbpr4sl9l37****', 'title' => ''], + 'DiskSize' => ['description' => 'Disk size, in GiB.', 'type' => 'integer', 'format' => 'int32', 'example' => '80', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'OsType' => [ - 'description' => 'The operating system.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Linux'."\n" - .'* Windows'."\n", + 'description' => 'Operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows'], 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - ], 'example' => 'Windows', + 'title' => '', ], 'Sessions' => [ - 'description' => 'The list of session information.'."\n", + 'description' => 'List of session information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the session.'."\n", + 'description' => 'Session information.', 'type' => 'object', 'properties' => [ - 'EndUserId' => [ - 'description' => 'End user information.'."\n", - 'type' => 'string', - 'example' => 'User1', - ], - 'EstablishmentTime' => [ - 'description' => 'The time when the session was created.'."\n", - 'type' => 'string', - 'example' => '2021-03-07T08:23Z', - ], + 'EndUserId' => ['description' => 'End user information.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'EstablishmentTime' => ['description' => 'Time when the session was created.', 'type' => 'string', 'example' => '2021-03-07T08:23Z', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'PolicyGroupId' => [ - 'description' => 'The cloud computer policy ID.'."\n", - 'type' => 'string', - 'example' => 'pg-9cktlowtxfl6****', - ], + 'PolicyGroupId' => ['description' => 'Cloud desktop policy ID.', 'type' => 'string', 'example' => 'pg-9cktlowtxfl6****', 'title' => ''], 'EndUserIds' => [ - 'description' => 'The list of end user.'."\n", + 'description' => 'List of end users.', 'type' => 'array', - 'items' => [ - 'description' => 'The names of end users.'."\n", - 'type' => 'string', - 'example' => 'User1', - ], - ], - 'GpuMemory' => [ - 'description' => 'The GPU memory size. For GPU-accelerated cloud computers, this return value is significant. Unit: MB.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2048', + 'items' => ['description' => 'End user name.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'GpuMemory' => ['description' => 'GPU memory size. Valid for GPU cloud desktops. Unit: MB.', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', 'title' => ''], 'FotaUpdate' => [ - 'description' => 'The information about image update.'."\n", + 'description' => 'Image update information.', 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => 'The name of the project.'."\n", - 'type' => 'string', - 'example' => 'testProject', - ], - 'Channel' => [ - 'description' => 'Subscription Channel'."\n", - 'type' => 'string', - 'example' => 'Enterprise', - ], - 'CurrentAppVersion' => [ - 'description' => 'The current version number of the cloud computer.'."\n", - 'type' => 'string', - 'example' => '0.0.0-D-20220102.xxxx', - ], - 'NewAppVersion' => [ - 'description' => 'The version number of the application after the update.'."\n", - 'type' => 'string', - 'example' => '0.0.0-R-20220307.xxxx', - ], - 'Force' => [ - 'description' => 'Whether to force upgrade.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReleaseNote' => [ - 'description' => 'The description of the version that can be upgraded.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Size' => [ - 'description' => 'The size of the update package for the cloud computer image. Unit: MiB.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'ReleaseNoteEn' => [ - 'description' => 'The English release note for the new image version.'."\n", - 'type' => 'string', - 'example' => 'Release note', - ], - 'ReleaseNoteJp' => [ - 'description' => 'The Japanese release note for the new image version.'."\n", - 'type' => 'string', - 'example' => 'リリースノート', - ], - 'NewDcdVersion' => [ - 'type' => 'string', - ], + 'Project' => ['description' => 'Project name.', 'type' => 'string', 'example' => 'testProject', 'title' => ''], + 'Channel' => ['description' => 'Subscription channel.', 'type' => 'string', 'example' => 'Enterprise', 'title' => ''], + 'CurrentAppVersion' => ['description' => 'Current version number of the cloud desktop.', 'type' => 'string', 'example' => '0.0.0-D-20220102.xxxx', 'title' => ''], + 'NewAppVersion' => ['description' => 'New application version number after the update.', 'type' => 'string', 'example' => '0.0.0-R-20220307.xxxx', 'title' => ''], + 'Force' => ['description' => 'Whether the upgrade is forced.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ReleaseNote' => ['description' => 'Description of the upgradable version.', 'type' => 'string', 'example' => 'Test upgrade package 03-07', 'title' => ''], + 'Size' => ['description' => 'Size of the upgradable version package, in MiB.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'ReleaseNoteEn' => ['description' => 'English description of the upgradable version.', 'type' => 'string', 'example' => 'Release note', 'title' => ''], + 'ReleaseNoteJp' => ['description' => 'Japanese description of the upgradable version.', 'type' => 'string', 'example' => 'リリースノート', 'title' => ''], + 'NewDcdVersion' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], 'ProtocolType' => [ - 'description' => 'The type of the protocol.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* High-definition Experience (HDX)'."\n" - .'* ASP'."\n", + 'description' => 'Protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud proprietary ASP protocol'], 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], 'example' => 'ASP', + 'title' => '', ], - 'OfficeSiteId' => [ - 'description' => 'The IDs of the office networks.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-363353****', - ], - 'NetworkInterfaceIp' => [ - 'description' => 'The IP address of the ENI.'."\n", - 'type' => 'string', - 'example' => '192.168.xx.xx', - ], - 'UserCustomName' => [ - 'description' => 'The custom cloud computer name.'."\n", - 'type' => 'string', - 'example' => 'testDesktop', - ], + 'OfficeSiteId' => ['description' => 'Office site ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'NetworkInterfaceIp' => ['description' => 'Network interface IP address.', 'type' => 'string', 'example' => '192.168.XX.XX', 'title' => ''], + 'UserCustomName' => ['description' => 'User-defined cloud desktop name.', 'type' => 'string', 'example' => 'testDesktop', 'title' => ''], 'ManagementFlags' => [ - 'description' => 'The list of cloud computer status.'."\n", + 'description' => 'List of cloud desktop management statuses.', 'type' => 'array', 'items' => [ - 'description' => 'The management status of the cloud computer.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* UNDER_MAINTENANCE: in maintenance mode.'."\n" - .'* MIGRATING.'."\n" - .'* ASSIGNING: in the assigned user.'."\n" - .'* MIGRATING_PROTOCOL .'."\n" - .'* NO_FLAG: stateless.'."\n" - .'* ENTER_MAINTENANCE: in maintenance mode.'."\n" - .'* UPDATING.'."\n", + 'description' => 'Cloud desktop management status.', + 'enumValueTitles' => ['UNDER_MAINTENANCE' => 'Maintenance mode', 'MIGRATING' => 'Migrating office site', 'ASSIGNING' => 'Assigning users', 'MIGRATING_PROTOCOL' => 'Migrating protocol', 'NO_FLAG' => 'Stateless', 'ENTER_MAINTENANCE' => 'Entering maintenance mode', 'UPDATING' => 'Upgrading'], 'type' => 'string', - 'enumValueTitles' => [ - 'UNDER_MAINTENANCE' => '', - 'MIGRATING' => '', - 'ASSIGNING' => '', - 'MIGRATING_PROTOCOL' => '', - 'NO_FLAG' => '', - 'ENTER_MAINTENANCE' => '', - 'UPDATING' => '', - ], 'example' => 'UPDATING', + 'title' => '', ], - ], - 'LocalName' => [ - 'description' => 'The region name.'."\n", - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'RealDesktopId' => [ - 'description' => 'If a shared cloud computer is assigned a real cloud computer, the ID of the cloud computer is displayed.'."\n", - 'type' => 'string', - 'example' => 'ecd-gx2x1dhsm****', - ], + 'LocalName' => ['description' => 'Region name.', 'type' => 'string', 'example' => 'China (Shanghai)', 'title' => ''], + 'RealDesktopId' => ['description' => 'If this is a shared cloud desktop and a real cloud desktop has been assigned, this field shows the cloud desktop ID.', 'type' => 'string', 'example' => 'ecd-gx2x1dhsm****', 'title' => ''], 'DesktopTimers' => [ - 'description' => 'The cloud computer timer object.'."\n", + 'description' => 'Cloud desktop timer object.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TimerType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" - .'* NoConnectShutdown: connectionless shutdown.'."\n" - .'* TimerBoot: scheduled start.'."\n" - .'* TimerReset: scheduled reset.'."\n" - .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" - .'* TimerShutdown: Stops the cloud computers on schedule.'."\n" - .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" - .'* TimerReboot: scheduled restart.'."\n", + 'description' => 'Scheduled task type.', + 'enumValueTitles' => ['NoOperationDisconnect' => 'Disconnect after inactivity', 'NoConnectShutdown' => 'Shut down after no connection', 'TimerBoot' => 'Start at scheduled time', 'TimerReset' => 'Reset at scheduled time', 'NoOperationShutdown' => 'Shut down after inactivity', 'TimerShutdown' => 'Shut down at scheduled time', 'NoOperationReboot' => 'Restart after inactivity', 'TimerReboot' => 'Restart at scheduled time'], 'type' => 'string', - 'enumValueTitles' => [ - 'NoOperationDisconnect' => '', - 'NoConnectShutdown' => '', - 'TimerBoot' => '', - 'TimerReset' => '', - 'NoOperationShutdown' => '', - 'TimerShutdown' => '', - 'NoOperationReboot' => '', - 'TimerReboot' => '', - ], 'example' => 'NoConnectShutdown', + 'title' => '', ], - 'CronExpression' => [ - 'description' => 'The CRON expression for the scheduled task.'."\n" - ."\n" - .'For example, a `0 0 4 1/1 * ?` indicates that the operation is executed every day from 4:00 a.m. on the first day of each month.'."\n", - 'type' => 'string', - 'example' => '0 0 0 ? * 1', - ], - 'Interval' => [ - 'description' => 'The interval at which the monitoring data was queried. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Enforce' => [ - 'description' => 'Indicates whether to forcibly execute the scheduled task. To `true` indicates that cloud computer and connection status detection are ignored, and scheduled tasks are forcibly executed.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'CronExpression' => ['description' => 'Cron expression for the scheduled task.'."\n" + ."\n" + .'Example: `0 0 4 1/1 * ?` means run daily starting at 4:00 AM on the first day of each month.', 'type' => 'string', 'example' => '0 0 0 ? * 1', 'title' => ''], + 'Interval' => ['description' => 'Time interval, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Enforce' => ['description' => 'Whether to enforce execution. If `true`, the scheduled task runs regardless of cloud desktop or connection status.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ResetType' => [ - 'description' => 'For a reset task, you must set the reset type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* RESET_TYPE_SYSTEM: resets the system disk.'."\n" - .'* RESET_TYPE_USER_DISK: resets the data disk.'."\n" - .'* RESET_TYPE_BOTH: resets the system disk and data disk.'."\n", + 'description' => 'Reset type for reset tasks.', + 'enumValueTitles' => ['RESET_TYPE_SYSTEM' => 'Reset system disk', 'RESET_TYPE_USER_DISK' => 'Reset data disk', 'RESET_TYPE_BOTH' => 'Reset both system and data disks'], 'type' => 'string', - 'enumValueTitles' => [ - 'RESET_TYPE_SYSTEM' => '', - 'RESET_TYPE_USER_DISK' => '', - 'RESET_TYPE_BOTH' => '', - ], 'example' => 'RESET_TYPE_BOTH', + 'title' => '', ], - 'AllowClientSetting' => [ - 'description' => 'Whether to allow clients to set policies.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'AllowClientSetting' => ['description' => 'Whether clients can set policies.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'OperationType' => [ - 'description' => 'The type of the scheduled task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HIBERNATE'."\n" - .'* SHUTDOWN'."\n", + 'description' => 'Scheduled task type.', + 'enumValueTitles' => ['HIBERNATE' => 'Hibernate', 'SHUTDOWN' => 'Shut down'], 'type' => 'string', - 'enumValueTitles' => [ - 'HIBERNATE' => '', - 'SHUTDOWN' => '', - ], 'example' => 'SHUTDOWN', + 'title' => '', ], - 'ExecutionTime' => [ - 'description' => 'The task duration.'."\n", - 'type' => 'string', - 'example' => '2021-12-31T15:59Z', - ], + 'ExecutionTime' => ['description' => 'Task execution time.', 'type' => 'string', 'example' => '2021-12-31T15:59Z', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'Clients' => [ - 'description' => 'The information about the supported clients.'."\n", + 'description' => 'Supported client information.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the supported clients.'."\n", + 'description' => 'Supported client information.', 'type' => 'object', 'properties' => [ 'Status' => [ - 'description' => 'The status of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF: does not allow logon.'."\n" - .'* ON: allows logon.'."\n", + 'description' => 'Client status.', + 'enumValueTitles' => ['OFF' => 'Logon disabled', 'ON' => 'Logon enabled'], 'type' => 'string', - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], 'example' => 'ON', + 'title' => '', ], 'ClientType' => [ - 'description' => 'The client type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: the web client.'."\n" - .'* android: the Android client.'."\n" - .'* linux: Linux client.'."\n" - .'* ios: the iOS client.'."\n" - .'* windows: the Windows client.'."\n" - .'* macos: the macOS client.'."\n", + 'description' => 'Client type.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'linux' => 'Linux client', 'ios' => 'iOS client', 'windows' => 'Windows client', 'macos' => 'macOS client'], 'type' => 'string', - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'linux' => '', - 'ios' => '', - 'windows' => '', - 'macos' => '', - ], 'example' => 'windows', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'SupportHibernation' => [ - 'description' => 'Indicates whether hibernation is supported.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: supported'."\n" - .'* false: not supported'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'HibernationBeta' => [ - 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n", + 'description' => 'Whether hibernation is supported.', + 'enumValueTitles' => ['true' => 'Supported', 'false' => 'Not supported'], 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], + 'HibernationBeta' => ['description' => 'Whether this is a hibernation beta version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SessionType' => [ - 'description' => 'The type of the session.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* SINGLE_SESSION'."\n" - .'* MULTIPLE_SESSION'."\n", + 'description' => 'Session type.', + 'enumValueTitles' => ['SINGLE_SESSION' => 'Single session', 'MULTIPLE_SESSION' => 'Multiple sessions'], 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '', - 'MULTIPLE_SESSION' => '', - ], 'example' => 'SINGLE_SESSION', + 'title' => '', ], 'Platform' => [ - 'description' => 'The OS platform.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* Ubuntu'."\n" - .'* UOS'."\n" - .'* CentOS'."\n" - .'* Windows Server 2019'."\n" - .'* Windows Server 2016'."\n", + 'description' => 'Operating system platform.', + 'enumValueTitles' => ['Ubuntu' => 'Ubuntu', 'UOS' => 'UOS', 'CentOS' => 'CentOS', 'Windows Server 2019' => 'Windows Server 2019', 'Windows Server 2016' => 'Windows Server 2016'], 'type' => 'string', - 'enumValueTitles' => [ - 'Ubuntu' => 'Ubuntu', - 'UOS' => 'UOS', - 'CentOS' => 'CentOS', - 'Windows Server 2019' => 'Windows Server 2019', - 'Windows Server 2016' => 'Windows Server 2016', - ], 'example' => 'Ubuntu', + 'title' => '', ], - 'Os' => [ - 'description' => 'OS Type'."\n", + 'Os' => ['description' => 'Operating system type', 'type' => 'string', 'example' => 'Windows', 'title' => ''], + 'RegionLocation' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OsDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'DescribeGlobalDesktops', + 'summary' => 'Query detailed information about cloud desktops across multiple regions. You can query only regions in the Chinese mainland (excluding Nanjing – Local Region – Shutting Down).', + 'description' => '- This API uses a centralized domain name with its endpoint in Shanghai. You cannot call this API from other regions.'."\n" + ."\n" + .'- The cloud desktop status returned by this API may be delayed by 1 to 3 seconds.', + 'changeSet' => [ + ['createdAt' => '2024-11-09T02:21:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-09-27T07:36:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-13T06:27:02.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-13T06:21:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-11T04:08:14.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-02T09:43:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-18T06:08:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-22T07:33:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-29T11:34:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-27T10:48:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-10-18T15:10:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-22T12:51:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-06T03:16:47.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGlobalDesktops'], + ], + ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'DescribeOfficeSites' => [ + 'summary' => 'Query the details of an office network.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'Region ID. You can invoke [DescribeRegions](~~196646~~) to obtain the list of regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'Office network ID. You can specify 1 to 100 IDs.', + 'type' => 'array', + 'items' => ['description' => 'Office network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['title' => 'uuid', 'description' => 'uuid', 'type' => 'string', 'example' => 'ASDASD', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'OfficeSites' => [ + 'description' => 'The office networks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the office network.', + 'type' => 'object', + 'properties' => [ + 'SsoServiceUrl' => ['description' => 'SSO connection.', 'type' => 'string', 'example' => 'https://eds-cn-shanghai-67****', 'title' => ''], + 'DesktopAccessType' => [ + 'description' => 'The allowed connection types for accessing the office network.'."\n" + ."\n" + .'> The VPC connection type depends on the Alibaba Cloud PrivateLink service, which incurs no fee. When this parameter is set to VPC or Any, the system automatically enables the PrivateLink service for you.', + 'enumValueTitles' => ['INTERNET' => '', 'VPC' => '', 'Any' => ''], 'type' => 'string', - 'example' => 'Windows', + 'example' => 'VPC', + 'title' => '', ], - 'RegionLocation' => [ + 'DesktopVpcEndpoint' => ['description' => 'The endpoint used when connecting to cloud desktops through a VPC.', 'type' => 'string', 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', 'title' => ''], + 'OfficeSiteType' => [ + 'description' => 'The type of account system used by the office network.', + 'enumValueTitles' => ['ad_connector' => '', 'simple' => ''], + 'type' => 'string', + 'example' => 'SIMPLE', + 'title' => '', + ], + 'ProviderId' => ['description' => 'User Account BID.', 'type' => 'string', 'example' => '268****', 'title' => ''], + 'OfficeSiteId' => ['description' => 'Office network ID.', 'type' => 'string', 'example' => 'cn-hangzhou+dir-363353****', 'title' => ''], + 'BizType' => ['title' => 'biztype', 'description' => 'biztype', 'type' => 'integer', 'format' => 'int32', 'example' => 'ENTERPRISE'], + 'AliUid' => ['title' => 'aliuid', 'description' => 'aliuid', 'type' => 'integer', 'format' => 'int64', 'example' => '125552'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + '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' => 'Query office network details', + 'changeSet' => [ + ['createdAt' => '2025-10-24T07:30:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-09T11:54:21.000Z', 'description' => 'Response parameters changed'], + ], + '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' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'A unique ID that is generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The collection of returned information.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'Regions' => [ + 'description' => 'The region object.', + 'type' => 'array', + 'items' => [ + 'description' => 'The region object.', + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['description' => 'The endpoint of the region.', 'type' => 'string', 'example' => 'ecd.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeRegions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + ], + 'ramActions' => [], + 'summary' => '', + ], + 'DescribeSnapshots' => [ + 'summary' => 'Queries the snapshots that are created based on a cloud computer and the details of the snapshots.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => ['description' => 'The snapshot ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 's-2ze81owrnv9pity4****', 'title' => ''], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.'."\n", 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', 'title' => ''], + 'Snapshots' => [ + 'description' => 'The snapshots.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => ['description' => 'The time when the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", 'type' => 'string', 'example' => '2020-12-20T14:52:28Z', 'title' => ''], + 'Status' => [ + 'description' => 'The snapshot status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PROGRESSING: The snapshot is being created.'."\n" + .'* FAILED: The snapshot failed to be created.'."\n" + .'* ACCOMPLISHED: The snapshot is created.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['PROGRESSING' => '', 'FAILED' => '', 'ACCOMPLISHED' => ''], + 'example' => 'ACCOMPLISHED', + 'title' => '', + ], + 'SnapshotType' => [ + 'description' => 'The snapshot type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AUTO: an automatic snapshot.'."\n" + .'* USER: a manual snapshot.'."\n", 'type' => 'string', + 'enumValueTitles' => ['AUTO' => '', 'USER' => ''], + 'example' => 'USER', + 'title' => '', ], - 'OsDescription' => [ + 'SnapshotName' => ['description' => 'The snapshot name.'."\n", 'type' => 'string', 'example' => 'testSnapshotName', 'title' => ''], + 'Progress' => ['description' => 'The progress of creating the cloud computer.'."\n", 'type' => 'string', 'example' => '100%', 'title' => ''], + 'Description' => ['description' => 'The snapshot description.'."\n", 'type' => 'string', 'example' => 'testDescription', 'title' => ''], + 'SnapshotId' => ['description' => 'The snapshot ID.'."\n", 'type' => 'string', 'example' => 's-2zeipxmnhej803x7****', 'title' => ''], + 'RemainTime' => ['description' => 'The remaining time required to complete snapshot creation. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SourceDiskSize' => ['description' => 'The size of the source disk. Unit: GiB.'."\n", 'type' => 'string', 'example' => '150', 'title' => ''], + 'SourceDiskType' => [ + 'description' => 'The type of the source disk.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SYSTEM: a system disk.'."\n" + .'* DATA: a data disk.'."\n", 'type' => 'string', + 'enumValueTitles' => ['SYSTEM' => '', 'DATA' => ''], + 'example' => 'SYSTEM', + 'title' => '', ], + 'DesktopId' => ['description' => 'The ID of the cloud computer to which the snapshot belongs.'."\n", 'type' => 'string', 'example' => 'ecd-g03l3tlm8djoj****', 'title' => ''], + 'RestorePointId' => ['description' => 'The ID of the restore point.'."\n", 'type' => 'string', 'example' => 'rp-btgmaa20wkcju****', 'title' => ''], + 'RestorePointName' => ['description' => 'The name of the restore point.'."\n", 'type' => 'string', 'example' => 'Data disk backup', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****\\",\\n \\"RequestId\\": \\"4686A731-D601-548C-83E2-4CB6371E****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"HostName\\": \\"testName\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastStartTime\\": \\"2021-07-13T15:59Z\\",\\n \\"Cpu\\": 2,\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"Memory\\": 4096,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\t\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80\\n }\\n ],\\n \\"OsType\\": \\"Windows\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\"\\n }\\n ],\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"GpuMemory\\": 2048,\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"testProject\\",\\n \\"Channel\\": \\"Enterprise\\",\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.xxxx\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.xxxx\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": \\"100\\",\\n \\"ReleaseNoteEn\\": \\"Release note\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\",\\n \\"NewDcdVersion\\": \\"\\"\\n },\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"UserCustomName\\": \\"testDesktop\\",\\n \\"ManagementFlags\\": [\\n \\"UPDATING\\"\\n ],\\n \\"LocalName\\": \\"华东2（上海）\\",\\n \\"RealDesktopId\\": \\"ecd-gx2x1dhsm****\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"NoConnectShutdown\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1\\",\\n \\"Interval\\": 60,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_BOTH\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"SHUTDOWN\\",\\n \\"ExecutionTime\\": \\"2021-12-31T15:59Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"Os\\": \\"Windows\\",\\n \\"RegionLocation\\": \\"\\",\\n \\"OsDescription\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeGlobalDesktops', - 'summary' => 'Queries the details of cloud computers. Currently, only the region corresponding to the Chinese mainland can be queried (excluding: Nanjing-local region-shutting down).', - 'description' => '* This API is a centralized domain name. The endpoint is in the China (Shanghai) region. You cannot call this API operation in other regions.'."\n" - .'* The cloud computer status information in this interface has a delay of 1 to 3 seconds from the actual value.'."\n", - ], - 'DescribeUserResources' => [ - 'summary' => 'Queries user resources.', - 'methods' => [ - 'post', - 'get', + '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' => 'DescribeSnapshots', + 'changeSet' => [ + ['createdAt' => '2025-01-15T01:27:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-18T00:29:27.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSnapshots'], + ], ], + 'ramActions' => [], + ], + 'DescribeUserResources' => [ + 'summary' => 'Queries a list of user resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -1298,9 +1207,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '169949', - 'abilityTreeNodes' => [ - 'FEATUREgwsENR35V', - ], + 'abilityTreeNodes' => ['FEATUREgwsENR35V'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1308,112 +1215,59 @@ [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client. This parameter is non-sensitive and does not need encryption.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', - ], + 'schema' => ['description' => 'A unique ID generated by the client, similar to a UUID. This parameter is not sensitive and does not require encryption.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', 'title' => ''], ], [ 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The client type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: the web client.'."\n" - .'* android: the Android client.'."\n" - .'* windows: the Windows client.'."\n" - .'* ios: the iOS client.'."\n" - .'* macos: the macOS client.'."\n", + 'description' => 'The type of the client.', + 'enumValueTitles' => ['html5' => 'Web client', 'android' => 'Android client', 'windows' => 'Windows client', 'ios' => 'iOS client', 'macos' => 'macOS client'], 'type' => 'string', 'required' => false, 'docRequired' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'android' => '', - 'windows' => '', - 'ios' => '', - 'macos' => '', - ], 'example' => 'windows', + 'title' => '', ], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'title' => '客户端版本', - 'description' => 'The client version.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '7.6.0-R-20241112.222305', - ], + 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '7.6.0-R-20241112.222305'], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token. You can call the `GetLoginToken` or `RefreshLoginToken` operation to retrieve the logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'The logon credential.'."\n" + .'Obtain this token by calling the `GetLoginToken` operation. After you log on, you can also call the `RefreshLoginToken` operation to get an updated token. The token is returned in the \\`LoginToken\\` parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID. You can call the `GetLoginToken` operation to retrieve the session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The session ID. Obtain this ID by calling the `GetLoginToken` operation.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'LoginRegionId', 'in' => 'query', - 'schema' => [ - 'title' => '登录的地域ID，用于工作区ID登录场景。', - 'description' => 'The ID of the region where end users log on to clients. This parameter applies to office network ID-based logons. For organization ID-based logons, you can leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region where you log on. This parameter is required when you log on using an office network ID. You do not need to specify this parameter when you log on using an organization ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'SearchRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud resources in specific regions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region to search. This parameter filters for cloud resource information in the specified region.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'OfficeSiteIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '工作区ID列表。', - 'description' => 'The office network IDs. This parameter is required for logons by using enterprise Active Directory (AD) accounts.'."\n", + 'title' => '', + 'description' => 'A list of office network IDs. Specify this parameter when you log on with an Active Directory (AD) account.', 'type' => 'array', - 'items' => [ - 'title' => '工作区ID。', - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-5440****', - ], + 'items' => ['description' => 'The office network ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cn-hangzhou+dir-5440****'], 'required' => false, 'maxItems' => 100, + 'example' => '', ], ], [ @@ -1421,36 +1275,20 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '资源类型列表，为空则查询所有资源类型。'."\n" - .'可选范围：'."\n" - .'云桌面：Desktop'."\n" - .'桌面组：DesktopGroup'."\n" - .'云应用：App '."\n" - .'云盘：CloudDrive', - 'description' => 'The resource types. If you leave this parameter empty, resources of all supported types will be queried.'."\n", + 'title' => '', + 'description' => 'A list of resource types. If you leave this empty, all resource types are queried.', 'type' => 'array', 'items' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" - .'* Desktop: cloud computers.'."\n" - .'* DesktopGroup: cloud computer shares.'."\n" - .'* CloudDrive: enterprise drives.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['App' => 'cloud application (including cloud apps, cloud phones, and cloud browsers)', 'Desktop' => 'cloud desktop', 'DesktopGroup' => 'shared cloud desktop', 'CloudDrive' => 'enterprise cloud drive'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'App' => '', - 'Desktop' => '', - 'DesktopGroup' => '', - 'CloudDrive' => '', - ], 'example' => 'Desktop', ], 'required' => false, 'maxItems' => 5, + 'example' => '', ], ], [ @@ -1458,38 +1296,20 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '产品类型列表，为空则查询所有产品类型。'."\n" - .'可选范围：'."\n" - .'CloudApp：云应用'."\n" - .'CloudBrowser：云浏览器'."\n" - ."\0".'AndroidCloud：云手机'."\n" - .'CloudDesktop：云电脑'."\n" - .'ImageBuilder：VHD Builder'."\n" - .'ImageValidate：VHD 验证', - 'description' => 'The service types. If you leave this parameter empty, services of all supported types will be queried.'."\n", + 'title' => '', + 'description' => 'A list of product types. If you leave this empty, all product types are queried.', 'type' => 'array', 'items' => [ - 'title' => '产品类型', - 'description' => 'The service type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" - .'* CloudApp: App Streaming.'."\n" - .'* CloudBrowser: Cloud Browser.'."\n" - .'* AndroidCloud: Cloud Phone.'."\n", + 'description' => 'The product type.', + 'enumValueTitles' => ['CloudDesktop' => 'cloud desktop (including standard and shared cloud desktops)', 'CloudApp' => 'cloud application', 'CloudBrowser' => 'cloud browser', 'AndroidCloud' => 'cloud phone'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], 'example' => 'CloudApp', ], 'required' => false, 'maxItems' => 5, + 'example' => '', ], ], [ @@ -1497,51 +1317,30 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'title' => '资源ID列表。'."\n" - .'可设置0~100个。', - 'description' => 'The resource IDs. You can specify up to 100 resource IDs.'."\n", + 'title' => '', + 'description' => 'A list of resource IDs.'."\n" + .'You can specify from 0 to 100 IDs.', 'type' => 'array', - 'items' => [ - 'title' => '资源ID', - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-00001', - ], + 'items' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ecd-00001'], 'required' => false, 'maxItems' => 100, + 'example' => '', ], ], [ 'name' => 'ResourceName', 'in' => 'query', - 'schema' => [ - 'title' => '资源名称，支持模糊搜索。', - 'description' => 'The resource name. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testName', - ], + 'schema' => ['description' => 'The name of the resource. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testName'], ], [ 'name' => 'ProtocolType', 'in' => 'query', 'schema' => [ - 'title' => '协议类型。该参数仅用于过滤云桌面。支持范围：'."\n" - .'- HDX(HDX协议)'."\n" - .'- ASP(阿里巴巴自研ASP协议 [推荐])', - 'description' => 'The protocol type. You can specify this parameter to filter cloud computers.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX: High-definition Experience (HDX).'."\n" - .'* ASP: Adaptive Streaming Protocol (ASP).'."\n", + 'description' => 'The protocol type. This parameter is used only to filter cloud desktops.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud in-house ASP protocol'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], 'example' => 'ASP', ], ], @@ -1549,22 +1348,11 @@ 'name' => 'AccessType', 'in' => 'query', 'schema' => [ - 'title' => '接入类型，不传表示两种都显示。'."\n" - .'取值范围：'."\n" - .'互联网：INTERNET'."\n" - .'专线：VPC', - 'description' => 'The access type. If you leave this parameter empty, both types will be displayed.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INTERNET: access over the Internet.'."\n" - .'* VPC: access over an enterprise virtual private cloud (VPC).'."\n", + 'description' => 'The access type. If you do not specify this parameter, resources of both access types are returned.', + 'enumValueTitles' => ['INTERNET' => 'Internet access', 'VPC' => 'VPC access'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - ], 'example' => 'INTERNET', ], ], @@ -1572,149 +1360,79 @@ 'name' => 'Language', 'in' => 'query', 'schema' => [ - 'title' => '客户端语言。', - 'description' => 'The client language.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en_US: English.'."\n" - .'* zh_CN: Simplified Chinese.'."\n" - .'* ja_JP: Japanese.'."\n", + 'description' => 'The client language.', + 'enumValueTitles' => ['en_US' => 'English', 'zh_CN' => 'Simplified Chinese', 'ja_JP' => 'Japanese'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'en_US' => '', - 'zh_CN' => '', - 'ja_JP' => '', - ], 'example' => 'zh-CN', ], ], [ 'name' => 'CategoryType', 'in' => 'query', - 'schema' => [ - 'title' => '资源一级类目。', - 'description' => 'The level-1 resource category.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The top-level resource category.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], [ 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'title' => '资源二级类目', - 'description' => 'The level-2 resource category.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The second-level resource category.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '0'], ], [ 'name' => 'QueryFotaUpdate', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return the image version information of cloud computers.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to query the image version information of the cloud desktop.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'RefreshFotaUpdate', 'in' => 'query', - 'schema' => [ - 'title' => '是否实时刷新OTA信息。', - 'description' => 'Specifies whether to refresh over-the-air (OTA) information in real time.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to refresh the over-the-air (OTA) information in real time.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], ], [ 'name' => 'OrderBy', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting field. If you do not specify this parameter, resources are sorted by creation time by default.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CreateTime: the time when resources are created.'."\n" - .'* AssignTime: the time when resources are assigned.'."\n", + 'description' => 'The field to use for sorting. If you do not specify this parameter, the results are sorted by creation time in descending order.', + 'enumValueTitles' => ['CreateTime' => 'resource creation time', 'AssignTime' => 'resource authorization time'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CreateTime' => '', - 'AssignTime' => '', - ], 'example' => 'AssignTime', + 'title' => '', ], ], [ 'name' => 'SortType', 'in' => 'query', 'schema' => [ - 'description' => 'The sorting method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ASC (default): the ascending order.'."\n" - .'* DESC: the descending order.'."\n", + 'description' => 'The sort order.', + 'enumValueTitles' => ['ASC' => 'ascending order \\[Default]', 'DESC' => 'descending order'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'ASC' => '', - 'DESC' => '', - ], 'example' => 'ASC', + 'title' => '', ], ], [ 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 500.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '500', - ], + 'schema' => ['description' => 'The number of entries to return on each page for a paged query. Default value: 500.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', - ], + 'schema' => ['description' => 'The token for the next page.', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', 'title' => ''], ], [ 'name' => 'AutoRefresh', 'in' => 'query', 'schema' => [ - 'title' => '是否主动刷新。主动刷新按钮则为true，定时刷新则为false。', - 'description' => 'Specifies whether to enable the immediate refresh feature.'."\n" - ."\n" - .'> To ensure the operation response speed, we recommend that you set the value to `false`.'."\n" - ."\n" - .'Valid values:'."\n" + 'description' => 'Specifies whether to refresh immediately.'."\n" ."\n" - .'* false'."\n" - .'* true'."\n", + .'> To ensure a fast response, set this parameter to `false`.', + 'enumValueTitles' => ['false' => 'Does not refresh immediately.', 'true' => 'Refreshes immediately.'], 'type' => 'boolean', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - 'true' => '', - ], 'example' => 'false', ], ], @@ -1722,17 +1440,11 @@ 'name' => 'Scene', 'in' => 'query', 'schema' => [ - 'title' => '客户端场景，用于标识排序。', - 'description' => 'The client usage scenario. Set the value to `desktop`.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* desktop: cloud computers.'."\n", + 'description' => 'The client scenario, used to identify the sort order. Set the value to `desktop`.', + 'enumValueTitles' => ['desktop' => 'cloud desktop'], 'type' => 'string', + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'desktop' => '', - ], 'example' => 'desktop', ], ], @@ -1740,18 +1452,12 @@ 'name' => 'DualCenterForward', 'in' => 'query', 'schema' => [ - 'title' => '是否双中心转发。', - 'description' => 'Specifies whether to enable geo-redundant forwarding. Set the value to `false`.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* false: disables geo-redundant forwarding.'."\n", + 'description' => 'Specifies whether to use dual-center forwarding. Set the value to `false`.', + 'enumValueTitles' => ['false' => 'Dual-center forwarding is not used.'], 'type' => 'boolean', 'deprecated' => true, + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'false' => '', - ], 'example' => 'false', ], ], @@ -1760,15 +1466,12 @@ 'in' => 'query', 'schema' => [ 'title' => '是否查询云电脑定时任务信息，默认为true。', - 'description' => '是否查询云电脑定时任务信息，默认为true。', + 'description' => 'Specifies whether to query information about scheduled tasks for the cloud desktop. The default value is true.', + 'enumValueTitles' => ['true' => 'Yes. This is the default value.', 'false' => 'No.'], 'type' => 'boolean', + 'default' => 'true', 'required' => false, - 'enumValueTitles' => [ - 'true' => '是，默认值', - 'false' => '否', - ], 'example' => 'true', - 'default' => 'true', ], ], [ @@ -1776,15 +1479,12 @@ 'in' => 'query', 'schema' => [ 'title' => '是否查询云桌面套餐包信息，默认为true。', - 'description' => '是否查询云桌面套餐包信息，默认为true。', + 'description' => 'Specifies whether to query information about cloud desktop plans. The default value is true.', + 'enumValueTitles' => ['true' => 'Yes. This is the default value.', 'false' => 'No.'], 'type' => 'boolean', + 'default' => 'true', 'required' => false, - 'enumValueTitles' => [ - 'true' => '是，默认值', - 'false' => '否', - ], 'example' => 'true', - 'default' => 'true', ], ], ], @@ -1793,1044 +1493,530 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'NextToken' => ['description' => 'The token that marks the start of the next page of a paged query. If this parameter is empty, no more data is returned.', 'type' => 'string', 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], 'QueryFailedResourceTypes' => [ - 'title' => '查询失败的资源类型列表。取值范围：'."\n" - .'CloudDesktop：云桌面（含云电脑和云电脑池）'."\n" - .'CloudApp：云应用'."\n" - .'CloudDrive：云盘', - 'description' => 'The resource types that failed to be queried.'."\n", + 'title' => '', + 'description' => 'A list of resource types for which the query failed.', 'type' => 'array', 'items' => [ - 'description' => 'The resource type that failed to be queried.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" - .'* CloudApp: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" - .'* CloudDrive: enterprise drives.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['CloudDesktop' => 'cloud desktop (including standard and shared cloud desktops)', 'CloudApp' => 'cloud application (including cloud apps, cloud phones, and cloud browsers)', 'CloudDrive' => 'enterprise cloud drive'], 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - 'CloudDrive' => '', - ], 'example' => 'CloudDesktop', + 'title' => '', ], 'enumValueTitles' => [], + 'example' => '', ], 'Resources' => [ - 'title' => '资源详细信息列表。', - 'description' => 'The resources.'."\n", + 'title' => '', + 'description' => 'A list of resource details.', 'type' => 'array', 'items' => [ - 'title' => '资源详细信息', - 'description' => 'The resource.'."\n", + 'title' => '', + 'description' => 'The resource details.', 'type' => 'object', 'properties' => [ - 'AliUid' => [ - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '194101959****', - ], + 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '194101959****', 'title' => ''], 'ResourceType' => [ - 'title' => '资源类型。取值范围：'."\n" - .'云桌面：Desktop'."\n" - .'桌面组：DesktopGroup'."\n" - .'云应用：App '."\n" - .'云盘：CloudDrive', - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" - .'* Desktop: cloud computers.'."\n" - .'* DesktopGroup: cloud computer shares.'."\n" - .'* CloudDrive: enterprise drives.'."\n", + 'description' => 'The resource type.', + 'enumValueTitles' => ['App' => 'cloud application (including cloud apps, cloud phones, and cloud browsers)', 'Desktop' => 'cloud desktop', 'DesktopGroup' => 'shared cloud desktop', 'CloudDrive' => 'enterprise cloud drive'], 'type' => 'string', - 'enumValueTitles' => [ - 'App' => '', - 'Desktop' => '', - 'DesktopGroup' => '', - 'CloudDrive' => '', - ], + 'title' => '', 'example' => 'Desktop', ], - 'RegionId' => [ - 'title' => '地域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], 'RegionLocation' => [ - 'title' => '地域位置。', - 'description' => 'The geographical location.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Mainland: regions in the Chinese mainland.'."\n" - .'* Overseas: regions outside the Chinese mainland, including China (Hong Kong).'."\n", + 'description' => 'The location of the region.', + 'enumValueTitles' => ['Mainland' => 'a region in the Chinese mainland', 'Overseas' => 'a region outside the Chinese mainland (including Hong Kong (China))'], 'type' => 'string', - 'enumValueTitles' => [ - 'Mainland' => '', - 'Overseas' => '', - ], + 'title' => '', 'example' => 'Mainland', ], - 'ResourceGroupId' => [ - 'title' => '资源组ID。', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'dg-0****', - ], - 'ResourceId' => [ - 'title' => '资源ID。', - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'ecd-d19tya8zi4****', - ], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'title' => '', 'example' => 'dg-0****'], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'ecd-d19tya8zi4****'], 'ResourceLevel' => [ - 'title' => '资源级别。'."\n" - .'取值范围：'."\n" - .'中心：Center'."\n" - .'单元：Region', - 'description' => 'The resource level.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Center: a centralized resource.'."\n" - .'* Region: a unit resource.'."\n", + 'description' => 'The resource level.', + 'enumValueTitles' => ['Center' => 'centralized resource', 'Region' => 'unitized resource'], 'type' => 'string', - 'enumValueTitles' => [ - 'Center' => '', - 'Region' => '', - ], + 'title' => '', 'example' => 'Center', ], - 'CenterResourceId' => [ - 'title' => '中心化资源ID。', - 'description' => 'The ID of the centralized resource.'."\n", - 'type' => 'string', - 'example' => 'ecds-0****', - ], - 'ResourceName' => [ - 'title' => '资源名称。', - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'testName01', - ], - 'CreateTime' => [ - 'title' => '资源创建时间。', - 'description' => 'The time when the resource was created.'."\n", - 'type' => 'string', - 'example' => '2024-12-11T07:12:12Z', - ], + 'CenterResourceId' => ['description' => 'The centralized resource ID.', 'type' => 'string', 'title' => '', 'example' => 'ecds-0****'], + 'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => 'testName01'], + 'CreateTime' => ['description' => 'The time the resource was created.', 'type' => 'string', 'title' => '', 'example' => '2024-12-11T07:12:12Z'], 'ProductType' => [ - 'title' => '产品类型。'."\n" - .'CloudDesktop - 云桌面'."\n" - .'CloudApp - 云应用'."\n" - .'AndroidCloud - 安卓云', - 'description' => 'The service type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" - .'* CloudApp: App Streaming'."\n" - .'* CloudBrowser: Cloud Browser.'."\n" - .'* AndroidCloud: Cloud Phone.'."\n", + 'description' => 'The product type.', + 'enumValueTitles' => ['CloudDesktop' => 'cloud desktop (including standard and shared cloud desktops)', 'CloudApp' => 'cloud application', 'CloudBrowser' => 'cloud browser', 'AndroidCloud' => 'cloud phone'], 'type' => 'string', - 'enumValueTitles' => [ - 'CloudDesktop' => '', - 'CloudApp' => '', - 'CloudBrowser' => '', - 'AndroidCloud' => '', - ], + 'title' => '', 'example' => 'AndroidCloud', ], - 'OfficeSiteId' => [ - 'title' => '工作区ID。', - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai+dir-3367****', - ], + 'OfficeSiteId' => ['description' => 'The office network ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai+dir-3367****'], 'AccessType' => [ - 'title' => '接入类型。'."\n" - .'取值范围：'."\n" - .'- INTERNET(互联网)'."\n" - .'- VPC(企业专网)'."\n" - .'- ANY(互联网和企业专网均可以)', - 'description' => 'The access type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* INTERNET: access over the Internet.'."\n" - .'* VPC: access over an enterprise VPC.'."\n" - .'* ANY: access over the Internet or an enterprise VPC.'."\n", + 'description' => 'The access type.', + 'enumValueTitles' => ['INTERNET' => 'Internet access', 'VPC' => 'VPC access', 'ANY' => 'Both Internet and VPC access are supported.'], 'type' => 'string', - 'enumValueTitles' => [ - 'INTERNET' => '', - 'VPC' => '', - 'ANY' => '', - ], + 'title' => '', 'example' => 'INTERNET', ], 'ProtocolType' => [ - 'title' => '协议类型。取值范围：'."\n" - .'- HDX(HDX协议)'."\n" - .'- ASP(阿里巴巴自研ASP协议)', - 'description' => 'The protocol type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HDX'."\n" - .'* ASP'."\n", + 'description' => 'The protocol type.', + 'enumValueTitles' => ['HDX' => 'HDX protocol', 'ASP' => 'Alibaba Cloud in-house ASP protocol'], 'type' => 'string', - 'enumValueTitles' => [ - 'HDX' => '', - 'ASP' => '', - ], + 'title' => '', 'example' => 'ASP', ], 'OsType' => [ - 'title' => '操作系统类型。取值范围：'."\n" - .'-Windows'."\n" - .'-Linux'."\n" - .'-Android', - 'description' => 'The OS type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Linux'."\n" - .'* Windows'."\n" - .'* Android'."\n", + 'description' => 'The operating system type.', + 'enumValueTitles' => ['Linux' => 'Linux', 'Windows' => 'Windows', 'Android' => 'Android'], 'type' => 'string', - 'enumValueTitles' => [ - 'Linux' => 'Linux', - 'Windows' => 'Windows', - 'Android' => 'Android', - ], + 'title' => '', 'example' => 'Windows', ], - 'Os' => [ - 'title' => '操作系统平台信息。', - 'description' => 'The OS platform.'."\n", - 'type' => 'string', - 'example' => 'Windows Server 2022', - ], - 'OsDescription' => [ - 'title' => '操作系统平台描述信息。', - 'description' => 'The description of the OS platform.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'Os' => ['description' => 'Information about the operating system platform.', 'type' => 'string', 'title' => '', 'example' => 'Windows Server 2022'], + 'OsDescription' => ['description' => 'A description of the operating system platform.', 'type' => 'string', 'title' => '', 'example' => 'Windows 正版授权'], 'SupportHibernation' => [ - 'title' => '是否支持休眠。', - 'description' => 'Indicates whether hibernation is supported.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", + 'description' => 'Indicates whether hibernation is supported.', + 'enumValueTitles' => ['true' => 'Hibernation is supported.', 'false' => 'Hibernation is not supported.'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], + 'title' => '', 'example' => 'true', ], 'HibernationBeta' => [ - 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", + 'description' => 'Indicates whether this is a beta version for hibernation testing.', + 'enumValueTitles' => ['true' => 'This is a beta version for hibernation testing.', 'false' => 'This is not a beta version for hibernation testing.'], 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], 'example' => 'false', + 'title' => '', ], 'SessionType' => [ - 'title' => '会话类型。SINGLE_SESSION代表单会话，MULTIPLE_SESSION代表多会话。', - 'description' => 'The session type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SINGLE_SESSION'."\n" - .'* MULTIPLE_SESSION'."\n", + 'description' => 'The session type.', + 'enumValueTitles' => ['SINGLE_SESSION' => 'single-session', 'MULTIPLE_SESSION' => 'multi-session'], 'type' => 'string', - 'enumValueTitles' => [ - 'SINGLE_SESSION' => '', - 'MULTIPLE_SESSION' => '', - ], + 'title' => '', 'example' => 'SINGLE_SESSION', ], 'ChargeType' => [ - 'title' => '计费方式。取值范围：'."\n" - .'- PostPaid(按量付费 [默认值])'."\n" - .'- PrePaid(包年包月)', - 'description' => 'The billing method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Postpaid (default): pay-as-you-go.'."\n" - .'* PrePaid: subscription.'."\n", + 'description' => 'The billing method.', + 'enumValueTitles' => ['PostPaid' => 'pay-as-you-go \\[Default]', 'PrePaid' => 'subscription'], 'type' => 'string', - 'enumValueTitles' => [ - 'PostPaid' => '', - 'PrePaid' => '', - ], + 'title' => '', 'example' => 'PrePaid', ], 'SubPayType' => [ - 'title' => '子计费方式。取值范围：'."\n" - .'- monthPackage(按月预付费模块)'."\n" - .'- PrePaid(时长包)', - 'description' => 'The sub-billing method.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* monthPackage: monthly subscription.'."\n" - .'* PrePaid: hourly plans.'."\n", + 'description' => 'The sub-billing method.', + 'enumValueTitles' => ['monthPackage' => 'monthly subscription', 'PrePaid' => 'duration plan'], 'type' => 'string', - 'enumValueTitles' => [ - 'monthPackage' => '', - 'PrePaid' => '', - ], + 'title' => '', 'example' => 'PrePaid', ], - 'ExpiredTime' => [ - 'title' => '包年包月付费类型资源的到期时间。', - 'description' => 'The expiration time of the subscription resource.'."\n", - 'type' => 'string', - 'example' => '2025-02-22T16:00:00Z', - ], + 'ExpiredTime' => ['description' => 'The expiration time for subscription resources.', 'type' => 'string', 'title' => '', 'example' => '2025-02-22T16:00:00Z'], 'AuthMode' => [ - 'title' => '云应用授权模式。取值范围：'."\n" - .'App：应用授权'."\n" - .'Session：会话授权'."\n" - .'AppInstanceGroup：交付组授权'."\n", - 'description' => 'The authorization mode of the cloud app.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* App: authorizes access to apps.'."\n" - .'* AppInstanceGroup: authorizes access to delivery groups.'."\n" - .'* Session: authorizes access to sessions.'."\n", + 'description' => 'The authorization mode for the cloud application.', + 'enumValueTitles' => ['App' => 'application authorization', 'AppInstanceGroup' => 'delivery group authorization', 'Session' => 'session authorization'], 'type' => 'string', - 'enumValueTitles' => [ - 'App' => '', - 'AppInstanceGroup' => '', - 'Session' => '', - ], + 'title' => '', 'example' => 'App', ], - 'AppId' => [ - 'title' => '应用ID。', - 'description' => 'The app ID. This parameter is for apps only.'."\n", - 'type' => 'string', - 'example' => 'app-0001', - ], - 'Version' => [ - 'title' => '资源版本。', - 'description' => 'The resource version. This parameter is for apps only.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'CategoryType' => [ - 'title' => '资源一级类目。', - 'description' => 'The level-1 resource category. This parameter is for apps only.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CategoryId' => [ - 'description' => 'The level-2 resource category. This parameter is for apps only.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Icon' => [ - 'title' => '资源图标链接。', - 'description' => 'The resource icon. This parameter is for apps only.'."\n", - 'type' => 'string', - 'example' => 'http://example.com/icon.png', - ], - 'ThemeColor' => [ - 'title' => '资源主题颜色。', - 'description' => 'The theme color of the resource. This parameter is for apps only.'."\n", - 'type' => 'string', - 'example' => '#FFFFFF', - ], - 'CdsName' => [ - 'title' => '网盘名称。', - 'description' => 'The drive name. This parameter is for enterprise drives only.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai+cds-695277****', - ], - 'ExternalDomainId' => [ - 'title' => '外部Domain ID。', - 'description' => 'The ID of the external domain. This parameter is for enterprise drives only.'."\n", - 'type' => 'string', - 'example' => 'stg114510', - ], - 'ExternalUserId' => [ - 'title' => '外部用户ID。', - 'description' => 'The ID of the external user. This parameter is for enterprise drives only.'."\n", - 'type' => 'string', - 'example' => 'test001', - ], - 'GlobalStatus' => [ - 'title' => '是否支持跨地域访问。', - 'description' => 'Indicates whether cross-region access is supported. This parameter is for enterprise drives only.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'LocalName' => [ - 'title' => '地域名称。', - 'description' => 'The region name.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'AppId' => ['description' => 'The application ID. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'string', 'title' => '', 'example' => 'app-0001'], + 'Version' => ['description' => 'The resource version. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'string', 'example' => 'Resource version.', 'title' => ''], + 'CategoryType' => ['description' => 'The top-level resource category. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'CategoryId' => ['description' => 'The second-level resource category. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Icon' => ['description' => 'The URL of the resource icon. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'string', 'title' => '', 'example' => 'http://example.com/icon.png'], + 'ThemeColor' => ['description' => 'The theme color of the resource. This parameter is specific to resources of the \\`App\\` type.', 'type' => 'string', 'title' => '', 'example' => '#FFFFFF'], + 'CdsName' => ['description' => 'The name of the cloud drive. This parameter is specific to resources of the \\`CloudDrive\\` type.', 'type' => 'string', 'title' => '', 'example' => 'cn-shanghai+cds-695277****'], + 'ExternalDomainId' => ['description' => 'The external domain ID. This parameter is specific to resources of the \\`CloudDrive\\` type.', 'type' => 'string', 'title' => '', 'example' => 'stg114510'], + 'ExternalUserId' => ['description' => 'The external user ID. This parameter is specific to resources of the \\`CloudDrive\\` type.', 'type' => 'string', 'title' => '', 'example' => 'test001'], + 'GlobalStatus' => ['description' => 'Indicates whether cross-region access is supported. This parameter is specific to resources of the \\`CloudDrive\\` type.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'LocalName' => ['description' => 'The region name.', 'type' => 'string', 'title' => '', 'example' => '华东1（杭州）'], 'DesktopTimers' => [ - 'title' => '桌面定时任务设置列表。', - 'description' => 'The scheduled tasks for cloud computers.'."\n", + 'title' => '', + 'description' => 'A list of scheduled task settings for the cloud desktop.', 'type' => 'array', 'items' => [ - 'title' => '桌面定时任务设置。', - 'description' => 'The scheduled task.'."\n", + 'title' => '', + 'description' => 'The scheduled task settings for the cloud desktop.', 'type' => 'object', 'properties' => [ - 'TimerType' => [ - 'title' => '任务类型。', - 'description' => 'The task type.'."\n", - 'type' => 'string', - 'example' => 'TimerBoot', - ], - 'CronExpression' => [ - 'title' => '定时任务的Cron表达式。', - 'description' => 'The cron expression specified in the scheduled task.'."\n", - 'type' => 'string', - 'example' => '0 30 13 ? * 1-7', - ], - 'Interval' => [ - 'title' => '定时任务间隔时间。', - 'description' => 'The interval at which the scheduled task is executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '15', - ], - 'Enforce' => [ - 'title' => '是否强制执行。', - 'description' => 'Indicates whether to forcibly execute the scheduled task.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ResetType' => [ - 'title' => '重置类型。', - 'description' => 'The reset option.'."\n", - 'type' => 'string', - 'example' => 'RESET_TYPE_SYSTEM', - ], - 'AllowClientSetting' => [ - 'title' => '是否允许客户端设置', - 'description' => 'Indicates whether to allow end users to configure scheduled tasks on clients.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'OperationType' => [ - 'title' => '操作类型', - 'description' => 'The type of the scheduled action.'."\n", - 'type' => 'string', - 'example' => 'Hibernate', - ], - 'ExecutionTime' => [ - 'title' => '执行时间', - 'description' => 'The time when the scheduled task is executed.'."\n", - 'type' => 'string', - 'example' => '2025-01-21T11:37Z', - ], + 'TimerType' => ['description' => 'The task type.', 'type' => 'string', 'title' => '', 'example' => 'TimerBoot'], + 'CronExpression' => ['description' => 'The cron expression for the scheduled task.', 'type' => 'string', 'title' => '', 'example' => '0 30 13 ? * 1-7'], + 'Interval' => ['description' => 'The interval for the scheduled task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '15'], + 'Enforce' => ['description' => 'Indicates whether the task is forcibly executed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'ResetType' => ['description' => 'The reset type.', 'type' => 'string', 'title' => '', 'example' => 'RESET_TYPE_SYSTEM'], + 'AllowClientSetting' => ['description' => 'Indicates whether client-side settings are allowed.', 'type' => 'string', 'title' => '', 'example' => 'false'], + 'OperationType' => ['description' => 'The operation type.', 'type' => 'string', 'title' => '', 'example' => 'Hibernate'], + 'ExecutionTime' => ['description' => 'The execution time.', 'type' => 'string', 'title' => '', 'example' => '2025-01-21T11:37Z'], ], + 'example' => '', ], + 'example' => '', ], 'Clients' => [ - 'title' => '资源支持的客户端类型列表。', - 'description' => 'The client types supported by resources.'."\n", + 'title' => '', + 'description' => 'A list of client types supported by the resource.', 'type' => 'array', 'items' => [ - 'title' => '资源支持的单类客户端类型设置信息。', - 'description' => 'The client type supported by resources.'."\n", + 'title' => '', + 'description' => 'Settings for a single client type supported by the resource.', 'type' => 'object', 'properties' => [ - 'ClientType' => [ - 'title' => '客户端类型。', - 'description' => 'The client type.'."\n", - 'type' => 'string', - 'example' => 'windows', - ], + 'ClientType' => ['description' => 'The client type.', 'type' => 'string', 'title' => '', 'example' => 'windows'], 'Status' => [ - 'title' => '支持状态。', - 'description' => 'The status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* OFF'."\n" - .'* ON'."\n", + 'description' => 'The support status.', + 'enumValueTitles' => ['OFF' => 'disabled', 'ON' => 'enabled'], 'type' => 'string', - 'enumValueTitles' => [ - 'OFF' => '', - 'ON' => '', - ], + 'title' => '', 'example' => 'ON', ], ], + 'example' => '', ], + 'example' => '', ], 'ResourceStatus' => [ - 'title' => '资源状态。', - 'description' => 'The resource status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Unknown: The resource status is unknown.'."\n" - .'* Stopped: The resource is stopped.'."\n" - .'* Failed: The resource failed to be created.'."\n" - .'* Starting: The resource is being started.'."\n" - .'* Rebuilding: The resource is changing.'."\n" - .'* Running: The resource is running.'."\n" - .'* Stopping: The resource is being stopped.'."\n" - .'* FotaUpdating: The image is being updated.'."\n" - .'* Pending: The resource is still being prepared.'."\n" - .'* Deleting: The resource is being deleted.'."\n" - .'* Unavailable: The resource is unavailable.'."\n", - 'type' => 'string', + 'description' => 'The resource status.', 'enumValueTitles' => [ - 'Unknown' => '', - 'Stopped' => '', - 'Failed' => '', - 'Starting' => '', - 'Rebuilding' => '', - 'Running' => '', - 'Stopping' => '', - 'FotaUpdating' => '', - 'Pending' => '', - 'Deleting' => '', - 'Unavailable' => '', + 'Unknown' => 'Unknown', 'Stopped' => 'Stopped', 'Failed' => 'Creation failed', 'Starting' => 'Starting', 'Rebuilding' => 'Rebuilding', 'Running' => 'Running', 'Stopping' => 'Stopping', 'FotaUpdating' => 'Image is being upgraded.', 'Pending' => 'Pending', 'Deleting' => 'Deleting', + 'Unavailable' => 'Unavailable', ], - 'example' => 'Running', - ], - 'LastStartTime' => [ - 'title' => '资源上次启动时间。', - 'description' => 'The time when the resource was last started.'."\n", 'type' => 'string', - 'example' => '2025-01-24T03:12:04Z', + 'title' => '', + 'example' => 'Running', ], + 'LastStartTime' => ['description' => 'The last time the resource was started.', 'type' => 'string', 'title' => '', 'example' => '2025-01-24T03:12:04Z'], 'OrderStatus' => [ - 'title' => '订单状态。', - 'description' => 'The order status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Ceased: Your account has an overdue payment.'."\n" - .'* Released: The order is closed.'."\n" - .'* Expired: The subscription resource has expired.'."\n" - .'* Normal: The order is normal.'."\n", + 'description' => 'The order status.', + 'enumValueTitles' => ['Ceased' => 'Overdue payment for a pay-as-you-go resource.', 'Released' => 'The order is closed.', 'Expired' => 'The subscription resource is stopped due to expiration.', 'Normal' => 'Normal'], 'type' => 'string', - 'enumValueTitles' => [ - 'Ceased' => '', - 'Released' => '', - 'Expired' => '', - 'Normal' => '', - ], + 'title' => '', 'example' => 'Normal', ], 'ManagementStatuses' => [ - 'title' => '管理状态列表。', - 'description' => 'The management status.'."\n", + 'title' => '', + 'description' => 'A list of management statuses.', 'type' => 'array', - 'items' => [ - 'title' => '管理状态', - 'description' => 'The management state.'."\n", - 'type' => 'string', - 'example' => 'NoFlag', - ], + 'items' => ['description' => 'The management status.', 'type' => 'string', 'title' => '', 'example' => 'NoFlag'], + 'example' => '', ], 'ResourceSessionStatus' => [ - 'title' => '会话状态。', - 'description' => 'The session status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Unknown'."\n" - .'* Connected'."\n" - .'* Disconnected'."\n", + 'description' => 'The session status.', + 'enumValueTitles' => ['Unknown' => 'Unknown', 'Connected' => 'Connected', 'Disconnected' => 'Disconnected'], 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => '', - 'Connected' => '', - 'Disconnected' => '', - ], + 'title' => '', 'example' => 'Connected', ], 'Sessions' => [ - 'description' => 'The sessions established between users and resources.'."\n", + 'description' => 'A list of user session information for the resource.', 'type' => 'array', 'items' => [ - 'description' => 'The session established between the user and the resource.'."\n", + 'description' => 'The user session information for the resource.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'title' => '登录资源的用户名。', - 'description' => 'The username used to log on to the resource.'."\n", - 'type' => 'string', - 'example' => 'user001', - ], - 'UserPrincipalName' => [ - 'title' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', - 'description' => 'The User Principal Name (UPN) of the resource-bound user (if applicable). This parameter is returned only when you query the current user\'s sessions.'."\n", - 'type' => 'string', - 'example' => 'benchmark_test@test.shenzhen', - ], - 'ResourceSessionStartTime' => [ - 'title' => '资源会话连接的时间。', - 'description' => 'The timestamp when the resource session was established.'."\n", - 'type' => 'string', - 'example' => '2025-01-22T11:03:36Z', - ], - 'NickName' => [ - 'title' => '用户的昵称。', - 'description' => '用户的昵称。', - 'type' => 'string', - 'example' => 'user-001', - ], + 'UserId' => ['description' => 'The username used to log on to the resource.', 'type' => 'string', 'title' => '', 'example' => 'user001'], + 'UserPrincipalName' => ['description' => 'The User Principal Name (UPN) of the user to whom the resource is bound, if available. This parameter has a value only for the session of the current user who is making the query.', 'type' => 'string', 'title' => '', 'example' => 'benchmark_test@test.shenzhen'], + 'ResourceSessionStartTime' => ['description' => 'The time when the resource session was connected.', 'type' => 'string', 'title' => '', 'example' => '2025-01-22T11:03:36Z'], + 'NickName' => ['title' => '用户的昵称。', 'description' => 'The user\'s nickname.', 'type' => 'string', 'example' => 'user-001'], ], + 'title' => '', + 'example' => '', ], - ], - 'RealDesktopId' => [ - 'title' => '【桌面组】真实桌面ID，当桌面组存在会话时存在。', - 'description' => 'The real ID of the cloud computer (from a share). This parameter is returned only when the cloud computer share has ongoing sessions.'."\n", - 'type' => 'string', - 'example' => 'ecd-0001', - ], - 'UserCustomName' => [ - 'title' => '用户自定义名称。', - 'description' => 'The custom name of the resource.'."\n", - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'RealDesktopId' => ['description' => '\\[Shared cloud desktop] The actual cloud desktop ID. This parameter is returned when a session exists on the shared cloud desktop.', 'type' => 'string', 'title' => '', 'example' => 'ecd-0001'], + 'UserCustomName' => ['description' => 'The custom name defined by the user.', 'type' => 'string', 'example' => 'My cloud desktop', 'title' => ''], 'FotaUpdate' => [ 'title' => '', - 'description' => 'The update info of the cloud computer.'."\n", + 'description' => 'The cloud desktop upgrade information.', 'type' => 'object', 'properties' => [ - 'Project' => [ - 'description' => 'The project name.'."\n", - 'type' => 'string', - 'example' => 'wuying-asp_single_session_desktop_win_x64', - ], - 'Channel' => [ - 'description' => 'The channel.'."\n", - 'type' => 'string', - 'example' => 'aliyun', - ], - 'CurrentAppVersion' => [ - 'description' => 'The current version number of the cloud computer\'s image.'."\n", - 'type' => 'string', - 'example' => '2.7.0-R-20250122.154826', - ], - 'NewAppVersion' => [ - 'description' => 'The target version number of the cloud computer\'s image.'."\n", - 'type' => 'string', - 'example' => '2.7.0-R-20250125.154826', - ], - 'Force' => [ - 'description' => 'Specifies whether to implement a forced update.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReleaseNote' => [ - 'description' => 'The version description of the cloud computer\'s image.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'Size' => [ - 'description' => 'The size of the update package for the cloud computer image. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '474981930', - ], - 'ReleaseNoteEn' => [ - 'title' => '', - 'description' => 'The English release note for the new image version.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'ReleaseNoteJp' => [ - 'description' => 'The Japanese release note for the new image version.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'NewDcdVersion' => [ - 'description' => 'The latest version available for updating the component disk.'."\n", - 'type' => 'string', - 'example' => '2.6.9-R-20250123.153415', - ], + 'Project' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'wuying-asp_single_session_desktop_win_x64', 'title' => ''], + 'Channel' => ['description' => 'The channel.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + 'CurrentAppVersion' => ['description' => 'The current image version of the cloud desktop.', 'type' => 'string', 'example' => '2.7.0-R-20250122.154826', 'title' => ''], + 'NewAppVersion' => ['description' => 'The version to which the cloud desktop can be upgraded.', 'type' => 'string', 'example' => '2.7.0-R-20250125.154826', 'title' => ''], + 'Force' => ['description' => 'Indicates whether the upgrade is mandatory.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ReleaseNote' => ['description' => 'The description of the new version.', 'type' => 'string', 'example' => '新版本', 'title' => ''], + 'Size' => ['description' => 'The size of the upgrade package. Unit: KB.', 'type' => 'string', 'example' => '474981930', 'title' => ''], + 'ReleaseNoteEn' => ['description' => 'The English description of the new version.', 'type' => 'string', 'title' => '', 'example' => 'new version'], + 'ReleaseNoteJp' => ['description' => 'The Japanese description of the new version.', 'type' => 'string', 'example' => '新バージョン', 'title' => ''], + 'NewDcdVersion' => ['description' => 'The version of the component disk to which the cloud desktop can be upgraded.', 'type' => 'string', 'example' => '2.6.9-R-20250123.153415', 'title' => ''], ], + 'example' => '', ], 'OsUpdate' => [ - 'description' => 'The update info of the OS.'."\n", + 'description' => 'The operating system upgrade information.', 'type' => 'object', 'properties' => [ - 'CheckId' => [ - 'description' => 'The ID of the check task.'."\n", - 'type' => 'string', - 'example' => 'wua-1740652957251743***', - ], - 'PackageCount' => [ - 'description' => 'The number of packets.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'CheckId' => ['description' => 'The check ID.', 'type' => 'string', 'example' => 'wua-1740652957251743***', 'title' => ''], + 'PackageCount' => ['description' => 'The number of packages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Packages' => [ - 'description' => 'The patch packages.'."\n", + 'description' => 'A list of patch package information.', 'type' => 'array', 'items' => [ - 'description' => 'The patch package.'."\n", + 'description' => 'The patch package information.', 'type' => 'object', 'properties' => [ - 'Kb' => [ - 'description' => 'The patch number.'."\n", - 'type' => 'string', - 'example' => 'KB2267***', - ], - 'Title' => [ - 'description' => 'The patch title.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Description' => [ - 'description' => 'The patch description.'."\n", - 'type' => 'string', - 'example' => '', - ], + 'Kb' => ['description' => 'The patch number.', 'type' => 'string', 'example' => 'KB2267***', 'title' => ''], + 'Title' => ['description' => 'The patch title.', 'type' => 'string', 'example' => 'Patch for ****.', 'title' => ''], + 'Description' => ['description' => 'The patch description.', 'type' => 'string', 'example' => '安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'KbListString' => [ - 'description' => 'The patch numbers.'."\n", - 'type' => 'string', - 'example' => 'KB2267***', - ], - 'UpdateCatalogUrl' => [ - 'description' => 'The update categorization URL.'."\n", - 'type' => 'string', - 'example' => 'https://catalog.update.microsoft.com/home.aspx', - ], + 'KbListString' => ['description' => 'Information about the list of patch numbers.', 'type' => 'string', 'example' => 'KB2267***', 'title' => ''], + 'UpdateCatalogUrl' => ['description' => 'The update category URL.', 'type' => 'string', 'example' => 'https://catalog.update.microsoft.com/home.aspx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'HasUpgrade' => [ - 'description' => 'Indicates whether an update exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HasUpgrade' => ['description' => 'Indicates whether an update exists.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DesktopDurationList' => [ - 'description' => 'The cloud computer plans.'."\n", + 'description' => 'A list of cloud desktop plan information.', 'type' => 'array', 'items' => [ - 'description' => 'The cloud computer plan.'."\n", + 'description' => 'The cloud desktop plan information.', 'type' => 'object', 'properties' => [ - 'PackageCreationTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the package was created.'."\n", - 'type' => 'string', - 'example' => '2025-01-17T07:01Z', - ], - 'PackageStatus' => [ - 'title' => '状态。', - 'description' => 'The package status.'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'UsedDuration' => [ - 'title' => '已使用时长', - 'description' => 'The subscription duration consumed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16850', - ], - 'PackageExpiredTime' => [ - 'title' => '过期时间', - 'description' => 'The expiration time of the package.'."\n", - 'type' => 'string', - 'example' => '2025-02-17T15:59Z', - ], - 'PackageId' => [ - 'title' => '套餐包ID。', - 'description' => 'The package ID.'."\n", - 'type' => 'string', - 'example' => 'mdp-0bxls4qpi6bl6****', - ], - 'TotalDuration' => [ - 'title' => '总时长', - 'description' => 'The total duration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '432000', - ], + 'PackageCreationTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2025-01-17T07:01Z'], + 'PackageStatus' => ['description' => 'The status.', 'type' => 'string', 'title' => '', 'example' => 'Available'], + 'UsedDuration' => ['description' => 'The used duration.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '16850'], + 'PackageExpiredTime' => ['description' => 'The expiration time.', 'type' => 'string', 'title' => '', 'example' => '2025-02-17T15:59Z'], + 'PackageId' => ['description' => 'The plan ID.', 'type' => 'string', 'title' => '', 'example' => 'mdp-0bxls4qpi6bl6****'], + 'TotalDuration' => ['description' => 'The total duration.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '432000'], 'PackageType' => [ - 'title' => '时长包类型'."\n" - .' * Duration：时长包'."\n" - .' * NORMAL_PACKAGE：付费包（120小时包）'."\n" - .' * POSTPAID_PACKAGE：用于记录后付费额度包（200小时包）'."\n" - .' * FREE_PACKAGE：免费包', - 'description' => 'The package type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* FREE_PACKAGE: a free package.'."\n" - .'* NORMAL_PACKAGE: a paid package (120-hour computing plan).'."\n" - .'* POSTPAID_PACKAGE: a pay-as-you-go package (200-hour computing plan).'."\n" - .'* Duration: an hourly package.'."\n", + 'description' => 'The duration plan type.', + 'enumValueTitles' => ['FREE_PACKAGE' => 'free plan', 'NORMAL_PACKAGE' => 'paid plan (120-hour plan)', 'POSTPAID_PACKAGE' => 'used to record the pay-as-you-go quota plan (200-hour plan)', 'Duration' => 'duration plan'], 'type' => 'string', - 'enumValueTitles' => [ - 'FREE_PACKAGE' => '', - 'NORMAL_PACKAGE' => '', - 'POSTPAID_PACKAGE' => '', - 'Duration' => '', - ], + 'title' => '', 'example' => 'NORMAL_PACKAGE', ], - 'PeriodStartTime' => [ - 'title' => '当月包开始时间', - 'description' => 'The package\'s effective start time for the current month.'."\n", - 'type' => 'string', - 'example' => '2025-01-17T07:01Z', - ], - 'PeriodEndTime' => [ - 'title' => '当月包结束时间', - 'description' => 'The package\'s effective end time for the current month.'."\n", - 'type' => 'string', - 'example' => '2025-02-17T15:59Z', - ], - 'PostPaidLimitFee' => [ - 'title' => '第二阶段包的封顶金额'."\n" - .' * 仅ResourceType为POSTPAID_PACKAG 和 FREE_PACKAGE时会返回', - 'description' => 'The maximum fee for the package in the second phase.'."\n" - ."\n" - .'> This parameter is returned if you set ResourceType to `POSTPAID_PACKAG` or `FREE_PACKAGE`.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '199', - ], - 'OrderInstanceId' => [ - 'title' => '订单实例ID', - 'description' => 'The ID of the instance order.'."\n", - 'type' => 'string', - 'example' => 'mdp-0bxls4qpi6bl6****', - ], + 'PeriodStartTime' => ['description' => 'The start time of the monthly plan.', 'type' => 'string', 'title' => '', 'example' => '2025-01-17T07:01Z'], + 'PeriodEndTime' => ['description' => 'The end time of the monthly plan.', 'type' => 'string', 'title' => '', 'example' => '2025-02-17T15:59Z'], + 'PostPaidLimitFee' => ['description' => 'The capped amount for the second-stage plan.'."\n" + ."\n" + .'> This parameter is returned only when \\`ResourceType\\` is `POSTPAID_PACKAGE` or `FREE_PACKAGE`.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '199'], + 'OrderInstanceId' => ['description' => 'The order instance ID.', 'type' => 'string', 'title' => '', 'example' => 'mdp-0bxls4qpi6bl6****'], 'PackageUsedUpStrategy' => [ - 'title' => '包用尽策略'."\n" - .' * "Postpaid" //用尽扣费'."\n" - .' * "Shutdown" //用尽关机或休眠', - 'description' => 'The policy for the cloud computer status once the monthly package quota is exhausted.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Shutdown: The cloud computer enters the Stopped or Hibernated state.'."\n" - .'* PostPaid: The cloud computer continues providing services that are billed on the pay-as-you-go basis.'."\n", + 'description' => 'The policy for the cloud desktop status after the monthly quota of the plan is used up.', + 'enumValueTitles' => ['Shutdown' => 'Shut down or hibernate.', 'Postpaid' => 'Continue to use and pay on a pay-as-you-go basis.'], 'type' => 'string', - 'enumValueTitles' => [ - 'Shutdown' => '', - 'Postpaid' => '', - ], + 'title' => '', 'example' => 'Postpaid', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ConnectionProperties' => [ - 'title' => '连接属性，JSON格式。', - 'description' => 'The connection attributes in JSON format. The client does not need to process the attributes; they are directly passed to the resource management center when the app resource is created.'."\n", - 'type' => 'string', - 'example' => '{"authMode":"App"}', - ], + 'ConnectionProperties' => ['description' => 'The connection properties, which is a JSON string. The client does not need to parse the content. When an application resource establishes a connection, this string is directly passed to the central resource control.', 'type' => 'string', 'title' => '', 'example' => '{"authMode":"App"}'], 'SupportedActions' => [ - 'title' => '支持的操作类型列表，目前只支持安卓云。', - 'description' => 'The supported actions. This parameter is returned only for cloud computers or phones.'."\n", + 'title' => '', + 'description' => 'A list of supported operation types. Currently, this is supported only for cloud phones and cloud desktops (including shared cloud desktops).', 'type' => 'array', 'items' => [ - 'title' => '操作类型。', - 'description' => 'The support action.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* WakeUp: wakes up cloud computers or cloud phones.'."\n" - .'* Hibernate: hibernates cloud computers or cloud phones.'."\n" - .'* Start: starts cloud computers or cloud phones.'."\n" - .'* Stop: stops cloud computers or cloud phones.'."\n" - .'* Restart: restarts cloud computers or cloud phones.'."\n", + 'description' => 'The operation type.', + 'enumValueTitles' => ['WakeUp' => 'Wake up', 'Hibernate' => 'Hibernate', 'Start' => 'Start', 'Stop' => 'Stop', 'Restart' => 'Restart'], 'type' => 'string', - 'enumValueTitles' => [ - 'WakeUp' => '', - 'Hibernate' => '', - 'Start' => '', - 'Stop' => '', - 'Restart' => '', - ], + 'title' => '', 'example' => 'Start', ], + 'example' => '', ], + 'SupportAgentIm' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'AgentImUrl' => ['type' => 'string', 'example' => 'https://wuying.aliyun.com/OpenIM/chat?desktopId=ecd-xxxxx', 'description' => '', 'title' => ''], ], + 'example' => '', ], + 'example' => '', ], - 'RankVersion' => [ - 'title' => '排序数据版本号。', - 'description' => 'The version number of the ranking data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1732869815062', - ], - 'TotalCount' => [ - 'title' => '总数。', - 'description' => '总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'MaxResults' => [ - 'title' => '返回最大数量。', - 'description' => '返回最大数量。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', + 'RankVersion' => ['description' => 'The version number of the sorting data.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1732869815062'], + 'TotalCount' => ['title' => '总数。', 'description' => 'The total number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'MaxResults' => ['title' => '返回最大数量。', 'description' => 'The maximum number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'AgentBriefSummary' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => '', 'title' => ''], + 'AgentBriefs' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AgentPlatform' => [ + 'type' => 'string', + 'example' => 'ENTERPRISE_JVS', + 'enum' => ['ENTERPRISE_JVS', 'ENTERPRISE', 'JVS'], + 'description' => '', + 'title' => '', + ], + 'AgentProvider' => [ + 'type' => 'string', + 'example' => 'OpenClaw', + 'enum' => ['OpenClaw', 'JVSCopilot'], + 'description' => '', + 'title' => '', + ], + 'Count' => ['type' => 'integer', 'format' => 'int32', 'example' => '2', 'description' => '', 'title' => ''], + 'AvatarUrl' => ['type' => 'string', 'example' => 'https://abc.com/efg.png', 'description' => '', 'title' => ''], + 'Url' => ['type' => 'string', 'example' => 'https://test.png', 'description' => '', 'title' => ''], + 'DisplayName' => ['type' => 'string', 'example' => 'JVS Claw', 'description' => '', 'title' => ''], + 'SubTitle' => ['type' => 'string', 'example' => '智在进化，快乐养虾', 'description' => '', 'title' => ''], + 'AvatarNoResourceUrl' => ['type' => 'string', 'example' => 'https://xxx.png', 'description' => '', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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\\": false,\\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' => 'DescribeUserResources', - 'description' => 'Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.'."\n", - 'responseParamsDescription' => 'This response parameter is not available for all resources. Ensure you know the fields for each resource.'."\n", - ], - 'UnbindUserDesktop' => [ - 'summary' => 'Unbinds end users from cloud computers.', - 'methods' => [ - 'post', - 'get', + 'description' => 'Before you call this operation, ensure that you understand the resource and product types of Wuying Workspace.', + 'responseParamsDescription' => 'Not all response parameters are available for every resource. Ensure that you know which parameters are returned for each resource type.', + 'changeSet' => [ + ['createdAt' => '2025-09-17T15:04:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-05-07T08:16:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-25T11:42:53.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserResources'], + ], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'EncryptPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'v12307f5e0****', - ], + 'schema' => ['description' => 'The ID of the client. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****', 'title' => ''], ], [ - 'name' => 'ClientType', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'windows', - ], + 'schema' => ['description' => 'The directory ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing+dir-131196****', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '58f96f67-7944-4f97-9342-****', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-beijing+dir-131196****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '3b053331-dc98-43d8-b247-****', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****', 'title' => ''], ], [ - 'name' => 'UserDesktopId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ud-sdfs****', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****', 'title' => ''], ], [ - 'name' => 'Force', + 'name' => 'Password', 'in' => 'query', + 'schema' => ['description' => 'The password that you want to encrypt.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Ab123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable forced unbinding.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* true: Even when end users connect to cloud computers, the forced unbinding is still enforced.'."\n" - .'* false: Forced unbinding is only enforced when end users are disconnected from cloud computers.'."\n", - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EncryptedPassword' => ['description' => 'The encrypted password.'."\n", 'type' => 'string', 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****', 'title' => ''], ], - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], ], + 'title' => 'EncryptPassword', + 'summary' => 'Encrypts a password.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPassword'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]', + ], + 'GetCloudDriveServiceMountToken' => [ + 'summary' => 'Obtain the logon credential for Enterprise File Gateway.', + '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' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'Logon credential.', 'type' => 'string', 'required' => false, 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****', 'title' => ''], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => false, 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****', 'title' => ''], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID generated by the client.', 'type' => 'string', 'required' => false, 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****', 'title' => ''], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => ['description' => 'Office Network ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-7186763****', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -2838,235 +2024,166 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D5B7CF35-E078-5EBF-A010-****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****'], + 'Token' => [ + 'description' => 'The tokens.'."\n", + 'type' => 'object', + 'properties' => [ + 'Token' => ['description' => 'The token.'."\n", 'type' => 'string', 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****', 'title' => ''], + 'ExpiredAfter' => ['description' => 'Expiration Time.', 'type' => 'string', 'example' => '2022-10-10T04:41:35Z', 'title' => ''], + 'UsedSize' => ['description' => 'Used capacity. Unit: GiB.', 'type' => 'integer', 'format' => 'int64', 'example' => '605089', 'title' => ''], + 'TotalSize' => ['description' => 'The total capacity of the enterprise drive. Unit: GiB'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6050416754750', 'title' => ''], + 'DomainId' => ['description' => 'Enterprise File Gateway domain name.', 'type' => 'string', 'example' => 'h****', 'title' => ''], + 'Status' => [ + 'description' => 'Current status of the Enterprise File Gateway user.', + 'type' => 'string', + 'enumValueTitles' => ['disabled' => '', 'enabled' => ''], + 'example' => 'enabled', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - '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' => 'Obtain the logon credential for Enterprise File Gateway', + 'changeSet' => [ + ['createdAt' => '2022-10-25T14:53:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-17T02:07:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-29T05:50:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCloudDriveServiceMountToken'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]', - 'title' => 'UnbindUserDesktop', + 'ramActions' => [], ], 'GetConnectionTicket' => [ - 'summary' => 'Retrieves the credential that is used to connect to a cloud computer.', - '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' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [](t2223508.xdita#)to get a list of regions that Elastic Desktop Service (EDS) supports.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The session ID. Call GetLoginToken to obtain this ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'The logon credential. Call GetLoginToken to obtain this credential.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cloud computer connection task.\\'."\n" - .'The first time you call the GetConnectionTicket operation, you do not need to configure this parameter. When you call the GetConnectionTicket operation later, set this parameter to the value of the `TaskId` parameter returned from the previous invocation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', - ], + 'schema' => ['description' => 'The ID of the cloud computer connection task.<br>Do not specify this parameter in your first call. For subsequent calls, set this parameter to the `TaskId` returned from the previous call.<br>', 'type' => 'string', 'required' => false, 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', 'title' => ''], ], [ 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud compute ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => 'The cloud computer ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-gx2x1dhsmucyy****', 'title' => ''], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => 'The client operating system.', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => 'The client version.', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756', 'title' => ''], ], [ 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the client.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* html5: web client'."\n" - .'* Linux: self-developed hardware terminal'."\n" - .'* android: Android client'."\n" - .'* windows: Windows client'."\n" - .'* ios: iOS client'."\n" - .'* macos: macOS client'."\n", + 'description' => 'The client type.', + 'enumValueTitles' => ['html5' => 'Web client', 'linux' => 'Alibaba Cloud Workspace-developed hardware terminal', 'android' => 'Android client', 'windows' => 'Windows client', 'ios' => 'iOS client', 'macos' => 'macOS client'], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'html5' => '', - 'linux' => '', - 'android' => '', - 'windows' => '', - 'ios' => '', - 'macos' => '', - ], 'example' => 'windows', + 'title' => '', ], ], [ 'name' => 'CommandContent', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '乐播需求，获取Tickek成功后自动在session里启动乐播应用。', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "startApplication": {'."\n" - .' "startApplicationList": ['."\n" - .' {'."\n" - .' "sessionName": "",'."\n" - .' "appList": ['."\n" - .' {'."\n" - .' "appPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe",'."\n" - .' "appParameter": "www.example.com www.example1.com"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - 'maxLength' => 1024000, - ], + 'schema' => ['description' => 'This parameter lets you configure a custom user-mode application. After a ticket is obtained, the application is automatically run.'."\n" + ."\n" + .'- appPath: A string that specifies the path of the application startup file. For example, `"C:\\Program Files (x86)\\000\\000.exe"`. Note: Use double backslashes (\\) as separators.'."\n" + ."\n" + .'- appParameter: A string that specifies the startup parameters of the application. For example, `"meetingid 000 meetingname aaa"`. Note: Use spaces to separate parameters.', 'type' => 'string', 'required' => false, 'maxLength' => 1024000, 'title' => '', '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" + .'}'], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', - ], + 'schema' => ['description' => 'The unique identifier of the client. If you use a Alibaba Cloud Workspace client, find this parameter in the **About** dialog box on the logon screen.', 'type' => 'string', 'required' => false, 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags. You can specify 1 to 20 tags.'."\n", + 'description' => 'A list of tags. You can include 1 to 20 tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'A tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. If you specify the `Tag` parameter, you must also specify the `Key` parameter. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun` and contain only spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value. You can specify an empty string as a tag value. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The tag key. If you specify `Tag`, `Key` is required. The key cannot exceed 128 characters in length. It cannot start with `aliyun` or `acs:`, contain `http://` or `https://`, or consist of only spaces.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value. The value can be an empty string. It can be up to 128 characters in length. It cannot start with `acs:` or contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'AccessType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'TicketBlackList', @@ -3074,1136 +2191,723 @@ 'style' => 'repeatList', 'schema' => [ 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], 'TaskStatus' => [ - 'description' => '', + 'description' => 'The task status.', + 'enumValueTitles' => ['FAILED' => 'The task failed.', 'RUNNING' => 'The task is running.', 'FINISHED' => 'The task is complete.'], 'type' => 'string', - 'enumValueTitles' => [ - 'FAILED' => '', - 'RUNNING' => '', - 'FINISHED' => '', - ], 'example' => 'FINISHED', + 'title' => '', ], - 'Ticket' => [ - 'description' => 'The credentials for connecting to the cloud computer.'."\n", - 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - 'TaskId' => [ - 'description' => 'The ID of the task to connect to the cloud computer.'."\n", - 'type' => 'string', - 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da', - ], - 'TaskCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', - ], - 'TaskMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', - ], - 'P2PToken' => [ - 'type' => 'string', - ], - 'DesktopId' => [ - 'type' => 'string', - ], + 'Ticket' => ['description' => 'The connection ticket for the cloud computer.', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the cloud computer connection task.', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da', 'title' => ''], + 'TaskCode' => ['description' => 'The ticket used to connect to the user instance. Before you use the ticket, decode its content from Base64, save it as an .ica file, and then open the file. The following code provides a Python example:'."\n" + ."\n" + .'```'."\n" + .'import base64'."\n" + .'response = {'."\n" + .' "Ticket": "W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********",'."\n" + .' "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",'."\n" + .'}'."\n" + .'f = open (\'xxx.ica\', \'w\')'."\n" + .'out = base64.b64decode(response[\'Ticket\'])'."\n" + .'f.write(out)'."\n" + .'f.close()'."\n" + .'```', 'type' => 'string', 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', 'title' => ''], + 'TaskMessage' => ['description' => 'The ID of the cloud computer connection task.', 'type' => 'string', 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', 'title' => ''], + 'P2PToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DesktopId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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' => 'A time out error occurred when connecting to this cloud computer because the memory usage of it is too high. The app consuming the most memory is %s. Please reconnect or restart the cloud computer. If the issue persists, please contact your IT administrator.'], + ['errorCode' => 'DesktopCpuHighLoad%s', 'errorMessage' => 'The specified desktop cpu high load.', 'description' => 'The CPU usage of this cloud computer is too high, causing the connection to time out. The application with the highest CPU usage is% s. Please reconnect or restart the cloud computer. If the connection failure still occurs, contact your IT administrator.'], + ['errorCode' => 'InvalidClientIp.Policy', 'errorMessage' => 'Client ip %s is not in white list.', 'description' => 'The IT administrator has set an IP whitelist policy that prevents you from connecting to this cloud computer under your current IP environment (%s). Please contact the IT administrator.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c63862da\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"P2PToken\\": \\"\\",\\n \\"DesktopId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetConnectionTicketResponse>\\n <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>\\n <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TaskStatus>Finished</TaskStatus>\\n</GetConnectionTicketResponse>","errorExample":""}]', - 'title' => 'GetConnectionTicket', - 'description' => 'The first time you call this operation, the system returns a task ID in the `TaskID` parameter. Use the task ID indicated in the `TaskID` parameter to continue calling this operation until the value of the `TaskStatus` parameter becomes `FINISHED` or `FAILED`. When `TaskStatus` becomes `FINISHED`, the value of the `Ticket` parameter is the ticket that is used to connect the client to the cloud computer.'."\n", + 'title' => 'Obtain the cloud PC connection credential', + 'summary' => 'Obtains a connection ticket for a cloud computer.', + 'description' => 'The first time you call this operation, it returns a `TaskID`. You can use this `TaskID` to call the operation again until `TaskStatus` changes to `FINISHED` or `FAILED`. If `TaskStatus` is `FINISHED`, the `Ticket` value is the connection ticket that the client uses to connect to the cloud computer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartDesktops' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-10-17T09:12:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-11-24T01:49:36.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2022-05-19T02:44:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConnectionTicket'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + ], + 'GetLoginToken' => [ + 'summary' => 'Gets a logon token.', + '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' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [](t2223508.xdita#)to get a list of regions that Elastic Desktop Service (EDS) is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client). The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'The unique ID that is generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The office network ID. This parameter is the same as `OfficeSiteId`. We recommend that you use `OfficeSiteId` instead. You cannot specify both `DirectoryId` and `OfficeSiteId`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-885351****', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-885351****', 'title' => ''], ], [ - 'name' => 'ClientOS', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The operating system (OS) of the device that run the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => 'The logon session ID.'."\n" + ."\n" + .'- If you have not bound a virtual multi-factor authentication (MFA) device or enabled two-factor authentication for the client, skip `SessionId`.'."\n" + ."\n" + .'- If a virtual MFA device is bound or two-factor authentication is enabled for the client, specify `SessionId` in the logon authentication stage that follows the `ADPassword` stage. Get this `SessionId` from the response of the `GetLoginToken` request made during the initial password verification (the `ADPassword` stage).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ - 'name' => 'ClientVersion', + 'name' => 'CurrentStage', 'in' => 'query', - 'schema' => [ - 'description' => 'The client version. If you use a WUYING client, you can click **About** on the client logon page to view the version of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => ' 2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => 'The current stage of logon authentication. The stages are sequential:'."\n" + ."\n" + .'- `ADPassword`: Verifies user information. Specify this value for password-based authentication that uses a convenience account or an Active Directory (AD) account.'."\n" + ."\n" + .'- `MFABind`: Binds a virtual MFA device.'."\n" + ."\n" + .'- `MFAVerify`: Verifies the security code that is generated by the virtual MFA device.'."\n" + ."\n" + .'- `TokenVerify`: Performs two-factor authentication for the client.'."\n" + ."\n" + .'- `ChangePassword`: Changes the user password.'."\n" + ."\n" + .'- `KeepAliveVerify`: Exchanges a valid \\`KeepAliveToken\\` for a \\`LoginToken\\`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ADPassword', 'title' => ''], ], [ - 'name' => 'DesktopId', + 'name' => 'EndUserId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-cg27ufmapab08****', - ], - 'required' => true, - 'example' => 'ecd-cg27ufmapab08****', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The username of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****', - ], + 'schema' => ['description' => 'The password of the convenience user or AD user. This parameter is required when `CurrentStage` is set to `ADPassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Password1234', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'OldPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The UUID of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '71F6A700735E74A61161A53F0C47****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameter.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","errorExample":""}]', - 'title' => 'StartDesktops', - 'summary' => 'Start cloud computers.', - 'description' => 'The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopDesktops' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], + 'schema' => ['description' => 'The old password. This parameter is required when `CurrentStage` is set to `ChangePassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'OldPassword', 'title' => ''], ], - ], - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'NewPassword', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The new password. This parameter is required when `CurrentStage` is set to `ChangePassword`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'NewPassword', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'AuthenticationCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'The security code that is generated by the virtual MFA device. This parameter is required when `CurrentStage` is set to `MFAVerify`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '47****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The operating system of the device that runs the client.', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'The client version. If you use an Alibaba Cloud Workspace client, find this parameter in the **About** dialog box on the client logon interface.', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756', 'title' => ''], ], [ - 'name' => 'ClientOS', + 'name' => 'TokenCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => 'If you enabled two-factor authentication for the client in the Elastic Desktop Service console and a logon threat is detected for the current user, a verification code for two-factor authentication is sent to the end user\'s email address. This parameter is required when `CurrentStage` is set to `TokenVerify`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '63****', 'title' => ''], ], [ - 'name' => 'ClientVersion', + 'name' => 'KeepAlive', 'in' => 'query', 'schema' => [ - 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n", - 'type' => 'string', + 'description' => 'Specifies whether to stay logged on.', + 'enumValueTitles' => ['null' => 'Does not stay logged on. \\[Default value]', 'true' => 'Stays logged on.', 'false' => 'Does not stay logged on.'], + 'type' => 'boolean', 'required' => false, - 'example' => '2.1.0-R-20210731.151756', + 'example' => 'false', + 'title' => '', ], ], [ - 'name' => 'DesktopId', + 'name' => 'KeepAliveToken', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u**** ', - ], - 'required' => true, - 'example' => 'ecd-7w78ozhjcwa3u**** ', - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The token used to stay logged on. After a user successfully logs on and enables the stay logged on feature, the API returns a `KeepAliveToken`. Within the validity period of the `KeepAliveToken`, call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify` to exchange the `KeepAliveToken` for a logon token (\\`LoginToken\\`). This parameter is required when `CurrentStage` is set to `KeepAliveVerify`.', 'type' => 'string', 'required' => false, 'example' => 'hide', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '6ce412a8-399f-49f9-9518-66ee028a****', - ], + 'schema' => ['description' => 'The unique identifier of the client. If you use an Alibaba Cloud Workspace client, find this parameter in the **About** dialog box on the client logon interface.', 'type' => 'string', 'required' => false, 'example' => 'C78CA9E99315687575DD2844C1F3****', 'title' => ''], ], [ - 'name' => 'SessionToken', + 'name' => 'ClientType', 'in' => 'query', 'schema' => [ - 'description' => 'The logon token.'."\n", + 'description' => 'The type of the Alibaba Cloud Workspace software client.', + 'enumValueTitles' => ['HTML5' => 'Web client', 'WINDOWS' => 'Windows client', 'MACOS' => 'macOS client', 'IOS' => 'iOS client', 'ANDROID' => 'Android client'], 'type' => 'string', 'required' => false, - 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', + 'example' => 'WINDOWS', + 'title' => '', ], ], [ - 'name' => 'OsUpdate', + 'name' => 'AvailableFeatures', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'boolean', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Uuid', + 'name' => 'ClientName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response elements.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + 'Email' => ['description' => 'The user\'s email address. It is returned with the LoginToken after a successful login.'."\n" + ."\n" + .'- For a convenience user, this is the email address that was set when the convenience user was created.'."\n" + ."\n" + .'- For an AD user, the format is `username@AD domain name`.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'Secret' => ['description' => 'The key used to bind a virtual MFA device. This parameter is used in the `MFABind` stage.'."\n" + ."\n" + .'> For more information about the authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'EndUserId' => ['description' => 'The username of the convenience account or AD user.', 'type' => 'string', 'example' => 'alice', 'title' => ''], + 'LoginToken' => ['description' => 'The logon token.', 'type' => 'string', 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], + 'NextStage' => ['description' => 'The expected next stage. For example, if an administrator enables MFA in the Elastic Desktop Service console, this parameter returns `MFAVerify` after the username and password are authenticated (after the `ADPassword` stage). This indicates that MFA is required.'."\n" + ."\n" + .'> For more information about the authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => 'MFAVerify', 'title' => ''], + 'QrCodePng' => ['description' => 'The QR code of the key used to bind a virtual MFA device. The value is Base64-encoded. This parameter can be empty and is used in the `MFABind` stage.'."\n" + ."\n" + .'> For more information about the authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******', 'title' => ''], + 'Label' => ['description' => 'The properties of the convenience user. If the user is an AD user, this parameter is empty.', 'type' => 'string', 'example' => 'test:wuying', 'title' => ''], + 'SessionId' => ['description' => 'The session ID. This parameter is returned only when you call `GetLoginToken` for the first time in the same session. If multiple authentications are required, pass this parameter in subsequent stages.'."\n" + ."\n" + .'> For more information about the authentication stages, see the description of the `CurrentStage` request parameter.', 'type' => 'string', 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****', 'title' => ''], + 'Phone' => ['description' => 'The mobile phone number of the convenience user. If the user is an AD user, this parameter is empty.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], + 'TenantId' => ['description' => 'The Alibaba Cloud account ID. This is used for hardware client identification.', 'type' => 'integer', 'format' => 'int64', 'example' => '166353906220****', 'title' => ''], + 'KeepAliveToken' => ['description' => 'The token used to stay logged on. After a user successfully logs on and enables the stay logged on feature, the API returns a `KeepAliveToken`. If the stay logged on feature is not enabled, this parameter is empty.', 'type' => 'string', 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW', 'title' => ''], + 'Industry' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => 'edu', 'title' => ''], + 'Props' => [ + 'description' => '> This is an internal parameter and is not available to the public.', + 'type' => 'object', + 'additionalProperties' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WindowDisplayMode' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => 'mode', 'title' => ''], + 'RiskVerifyInfo' => [ + 'description' => 'Information about logon threat detection.', + 'type' => 'object', + 'properties' => [ + 'Email' => ['description' => 'When identity verification is triggered, this email address is used for verification.', 'type' => 'string', 'example' => 'user@example.com', 'title' => ''], + 'LastLockDuration' => ['description' => 'The time when the account was locked.', 'type' => 'integer', 'format' => 'int64', 'example' => '1713749778', 'title' => ''], + 'Locked' => [ + 'description' => 'Indicates whether the account is locked.', + 'enumValueTitles' => ['true' => 'Yes', 'false' => 'No'], + 'type' => 'string', + 'example' => 'true', + 'title' => '', + ], + 'Phone' => ['description' => 'When identity verification is triggered, this mobile phone number is used for verification.', 'type' => 'string', 'example' => '1381111****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Reason' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'PasswordStrategy' => [ + 'description' => '> This is an internal parameter and is not available to the public.', + 'type' => 'object', + 'properties' => [ + 'TenantPasswordLength' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'TenantAlternativeChars' => [ + 'description' => '> This is an internal parameter and is not available to the public.', + 'type' => 'array', + 'items' => ['description' => '> This is an internal parameter and is not available to the public.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'NickName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'WyId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","errorExample":""}]', - 'title' => 'StopDesktops', - 'summary' => 'Stops cloud computers.', - 'description' => 'The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.'."\n", + 'title' => 'GetLoginToken', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-08-22T02:52:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-30T12:42:46.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-08T08:24:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-04T02:15:58.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-23T02:39:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-10T13:31:31.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-13T10:33:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-13T10:33:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-07T06:16:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T02:51:57.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-08-19T02:51:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginToken'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], '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' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID. Call [DescribeRegions](~~196646~~) to list regions that support WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'A unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'Login token.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', - ], + 'schema' => ['description' => 'Operating system of the device running the client.', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => 'Client version. If you use the WUYING Workspace client, find this value in the **About** dialog box on the client login screen.', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756', 'title' => ''], ], [ 'name' => 'DesktopId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", + 'description' => 'A list of 1 to 20 cloud computer IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the cloud computer.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-7w78ozhjcwa3u****', - ], + 'items' => ['description' => 'The cloud desktop ID.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u****', 'title' => ''], 'required' => true, 'example' => 'ecd-7w78ozhjcwa3u**** ', 'maxItems' => 100, + 'title' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], + 'schema' => ['description' => 'Ensures idempotence. Generate a unique value on your client for each request. ClientToken supports only ASCII characters and must be no longer than 64 characters. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****', 'title' => ''], ], [ 'name' => 'SessionToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', - ], + 'schema' => ['description' => 'Specifies the logon credentials.', 'type' => 'string', 'required' => false, 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', 'title' => ''], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The UUID of the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '91761ED27169E2FC564F29388E2D****', - ], + 'schema' => ['description' => 'Unique identifier of the client.', 'type' => 'string', 'required' => false, 'example' => '91761ED27169E2FC564F29388E2D****', 'title' => ''], ], [ 'name' => 'OsUpdate', 'in' => 'query', - 'schema' => [ - 'type' => 'boolean', - ], + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'Response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RebootDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</RebootDesktopsResponse>","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => 'RebootDesktops', - 'summary' => 'Restart cloud computers.', + 'summary' => 'You can restart one or more cloud desktops.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ReportSessionStatus' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-18T03:52:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-25T06:05:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-18T06:48:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => 'Request parameters changed'], ], - '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' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The Region ID. You can invoke [DescribeRegions](~~196646~~) to obtain the list of Regions supported by WUYING Workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-bp167fcodoa90ixn****', - ], + 'schema' => ['description' => 'A unique ID generated by the client, such as a UUID. This parameter is non-sensitive and does not require encryption.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'DirectoryId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'schema' => ['description' => '> This parameter is not available for use.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', 'title' => ''], ], [ - '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' => 'The office network ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-shanghai+dir-238191****', 'title' => ''], ], [ - 'name' => 'SessionChangeTime', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1642909143781', - ], + 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'liming', - ], + 'schema' => ['description' => 'The username.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice', 'title' => ''], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => ['description' => 'The logon credential.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'A collection of return information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], + 'LoginToken' => ['description' => 'The logon credential.', 'type' => 'string', 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]', - 'title' => 'ReportSessionStatus', - 'summary' => 'Reports session status.', - ], - 'ApproveFotaUpdate' => [ - 'summary' => 'Enables OTA updates for cloud computers.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","type":"json"}]', + 'title' => 'Purge Logon Credential', + 'summary' => 'Purge the logon credential.', + 'description' => 'The validity period of a logon credential (LoginToken) is 8 hours. If the end user does not log off from the client within 8 hours, the client must purge the logon credential.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-12-14T01:59:16.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + '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' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd4452bd7-88df-4b90-a409-806da674****', - ], + 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-bp167fcodoa90ixn****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '4771b873-c757-4893-973c-7f5beejh****', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'SessionStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The logon token.'."\n", + 'description' => 'Session status.', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-138dsptkrt00u****', - ], - ], - [ - 'name' => 'AppVersion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application version.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0.0.1-D-20220513.14****', + 'enumValueTitles' => [ + 'SessionLogOff' => '', 'DesktopTimerDisconnection' => '', 'SessionReboot' => '', 'DesktopTimerShutdown' => '', 'SessionLock' => '', 'SessionShutdown' => '', 'SessionUnLock' => '', 'DesktopTimerReboot' => '', 'ConsoleConnect' => '', 'SessionLogOn' => '', + 'SessionPopup' => '', 'SessionDisconnect' => '', 'ConsoleDisconnect' => '', + ], + 'example' => 'SessionLogOn', + 'title' => '', ], ], [ - 'name' => 'Uuid', + 'name' => 'SessionChangeTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the client. To view the unique identifier of an Alibaba Cloud Workspace client, go to the client logon page and click on "About."'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '28c80e90-f71e-4c23-93d6-1225329c****', - ], + 'schema' => ['description' => 'Duration of the session change.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1642909143781', 'title' => ''], ], [ - 'name' => 'TargetStatus', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The state of the cloud computer after the OTA update.'."\n" - ."\n" - .'> This parameter is not publicly available. After the OTA update is complete, the state of the cloud computer changes to `RUNNING`.'."\n" - ."\n" - .'* Set the value to running.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'running' => '', - ], - 'example' => 'running', - ], + 'schema' => ['description' => 'End user.', 'type' => 'string', 'required' => false, 'example' => 'liming', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Returns a collection of information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', - 'title' => 'ApproveFotaUpdate', - ], - 'DescribeSnapshots' => [ - 'summary' => 'Queries the snapshots that are created based on a cloud computer and the details of the snapshots.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]', + 'title' => 'Report session status', + 'summary' => 'Report session status.', + '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' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DesktopId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-gx2x1dhsmucyy****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SnapshotId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The snapshot ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 's-2ze81owrnv9pity4****', - ], + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '95e41934-383e-4c9f-824f-3b93b19b****', 'title' => ''], ], [ - 'name' => 'MaxResults', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou+dir-899235****', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****', - ], + 'schema' => ['description' => 'The email address of the user.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'a***@example.edu', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'phone', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****', - ], + 'schema' => ['description' => 'The phone number of the user.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '138****1111', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.'."\n", - 'type' => 'string', - 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', - ], - 'Snapshots' => [ - 'description' => 'The snapshots.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CreationTime' => [ - 'description' => 'The time when the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", - 'type' => 'string', - 'example' => '2020-12-20T14:52:28Z', - ], - 'Status' => [ - 'description' => 'The snapshot status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PROGRESSING: The snapshot is being created.'."\n" - .'* FAILED: The snapshot failed to be created.'."\n" - .'* ACCOMPLISHED: The snapshot is created.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'PROGRESSING' => '', - 'FAILED' => '', - 'ACCOMPLISHED' => '', - ], - 'example' => 'ACCOMPLISHED', - ], - 'SnapshotType' => [ - 'description' => 'The snapshot type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AUTO: an automatic snapshot.'."\n" - .'* USER: a manual snapshot.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AUTO' => '', - 'USER' => '', - ], - 'example' => 'USER', - ], - 'SnapshotName' => [ - 'description' => 'The snapshot name.'."\n", - 'type' => 'string', - 'example' => 'testSnapshotName', - ], - 'Progress' => [ - 'description' => 'The progress of creating the cloud computer.'."\n", - 'type' => 'string', - 'example' => '100%', - ], - 'Description' => [ - 'description' => 'The snapshot description.'."\n", - 'type' => 'string', - 'example' => 'testDescription', - ], - 'SnapshotId' => [ - 'description' => 'The snapshot ID.'."\n", - 'type' => 'string', - 'example' => 's-2zeipxmnhej803x7****', - ], - 'RemainTime' => [ - 'description' => 'The remaining time required to complete snapshot creation. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SourceDiskSize' => [ - 'description' => 'The size of the source disk. Unit: GiB.'."\n", - 'type' => 'string', - 'example' => '150', - ], - 'SourceDiskType' => [ - 'description' => 'The type of the source disk.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SYSTEM: a system disk.'."\n" - .'* DATA: a data disk.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SYSTEM' => '', - 'DATA' => '', - ], - 'example' => 'SYSTEM', - ], - 'DesktopId' => [ - 'description' => 'The ID of the cloud computer to which the snapshot belongs.'."\n", - 'type' => 'string', - 'example' => 'ecd-g03l3tlm8djoj****', - ], - 'RestorePointId' => [ - 'description' => 'The ID of the restore point.'."\n", - 'type' => 'string', - 'example' => 'rp-btgmaa20wkcju****', - ], - 'RestorePointName' => [ - 'description' => 'The name of the restore point.'."\n", - 'type' => 'string', - 'example' => 'Data Disk Backup'."\n", - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeSnapshots', + 'title' => 'ResetPassword', + 'summary' => 'Resets a password.', + 'changeSet' => [ + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetPassword'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]', ], 'ResetSnapshot' => [ 'summary' => 'Restores the data of a disk from a snapshot.', - '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' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SnapshotId', 'in' => 'query', - 'schema' => [ - 'description' => 'The snapshot ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 's-2zeipxmnhej803x7****', - ], + 'schema' => ['description' => 'The snapshot ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 's-2zeipxmnhej803x7****', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****', - ], + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****', 'title' => ''], ], [ 'name' => 'DesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud computer ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecd-e964cr92klwqb****', - ], + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-e964cr92klwqb****', 'title' => ''], ], [ 'name' => 'StopDesktop', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to stop the cloud computer.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Specifies whether to stop the cloud computer.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -4211,268 +2915,79 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', 'title' => 'ResetSnapshot', - ], - 'GetCloudDriveServiceMountToken' => [ - 'summary' => 'Retrieves the logon tokens for enterprise drives.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'changeSet' => [ + ['createdAt' => '2025-01-15T01:27:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-30T09:25:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-18T00:29:27.000Z', 'description' => 'OpenAPI offline'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-7186763****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****', - ], - 'Token' => [ - 'description' => 'The tokens.'."\n", - 'type' => 'object', - 'properties' => [ - 'Token' => [ - 'description' => 'The token.'."\n", - 'type' => 'string', - 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****', - ], - 'ExpiredAfter' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2022-10-10T04:41:35Z', - ], - 'UsedSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '605089', - ], - 'TotalSize' => [ - 'description' => 'The total capacity of the enterprise drive. Unit: GiB'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6050416754750', - ], - 'DomainId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'h****', - ], - 'Status' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'disabled' => '', - 'enabled' => '', - ], - 'example' => 'enabled', - ], - ], - ], - ], - ], + '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' => 'GetCloudDriveServiceMountToken', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', ], - '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' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou+dir-2925105532', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-227468****', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'EndUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****', - ], + 'schema' => ['description' => 'The username of the account.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'alice', 'title' => ''], ], [ - 'name' => 'CredentialType', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the logon credential that you want to clear.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* MfaPasscode: the multi-factor verification code.'."\n" - .'* FingerPrint: the fingerprint.'."\n" - .'* Password: the password.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [ - 'MfaPasscode' => '', - 'FingerPrint' => '', - 'Password' => '', - ], - 'example' => 'Password', - ], + 'schema' => ['description' => 'The operating system on which the client runs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ - 'name' => 'Credential', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The credential.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456789cyG', - ], + 'schema' => ['description' => 'The client version. If you use an Alibaba Cloud Workspace client, you can view the client version in the "About" dialog box on the client logon page.'."\n", 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756', 'title' => ''], ], [ - 'name' => 'EncryptedKey', + 'name' => 'TokenCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the key that you want to encrypt.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'drjfs****', - ], + 'schema' => ['description' => 'If two-factor authentication is enabled for clients in the Elastic Desktop Service (EDS) Enterprise console, the system will send a verification code to the user\'s email address if it detects that the current logged-on user is at risk. This parameter is required if you set `CurrentStage` to `TokenVerify`.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '63****', 'title' => ''], ], ], 'responses' => [ @@ -4480,1202 +2995,485 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n", 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]', - 'title' => 'VerifyCredential', - 'summary' => 'Validates credentials to lock on-premises sessions on clients.', - ], - 'GetLoginToken' => [ - 'summary' => 'Obtains logon credentials.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'SendTokenCode', + 'summary' => 'Sends a logon verification code.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendTokenCode'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]', + ], + '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' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by EDS.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], - ], - [ - 'name' => 'DirectoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-885351****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-885351****', - ], + 'schema' => ['description' => 'The unique ID generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '347431a9-90f6-448e-82c4-42bc84a9****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the session.'."\n" - ."\n" - .'* If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.'."\n" - .'* If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], - ], - [ - 'name' => 'CurrentStage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The logon authentication stage. Valid values:'."\n" - ."\n" - .'* `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.'."\n" - .'* `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`'."\n" - .'* `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`'."\n" - .'* `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).'."\n" - .'* `ChangePassword`: the stage to change the password of the user.'."\n" - .'* `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ADPassword', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'alice', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Password1234', - ], - ], - [ - 'name' => 'OldPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'OldPassword', - ], - ], - [ - 'name' => 'NewPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'NewPassword', - ], - ], - [ - 'name' => 'AuthenticationCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '47****', - ], - ], - [ - 'name' => 'ClientOS', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.', - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.1**** x64', - ], + 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****', 'title' => ''], ], [ - 'name' => 'ClientVersion', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.1****', - ], + 'schema' => ['description' => 'Logon credential.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****', 'title' => ''], ], [ - 'name' => 'TokenCode', + 'name' => 'FingerPrintTemplate', 'in' => 'query', - 'schema' => [ - 'description' => 'If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '63****', - ], + 'schema' => ['description' => 'Fingerprint template.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'goG3gG8AAABhujtscn', 'title' => ''], ], [ - 'name' => 'KeepAlive', + 'name' => 'EncryptedFingerPrintTemplate', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to keep the user logged on to the client. '."\n" - .'Valid values:'."\n" - .'* null: Default value. Do not keep the user logged on to the client.'."\n" - .'* true: Keep the user logged on to the client.'."\n" - .'* false: Do not keep the user logged on to the client.', - 'type' => 'boolean', - 'required' => false, - 'enumValueTitles' => [ - 'null' => '', - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], + 'schema' => ['description' => 'The encrypted fingerprint template.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAAAAAAAAAA', 'title' => ''], ], [ - 'name' => 'KeepAliveToken', + 'name' => 'EncryptedKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.', - 'type' => 'string', - 'required' => false, - 'example' => 'hide', - ], + 'schema' => ['description' => 'Encryption key.', 'type' => 'string', 'required' => false, 'example' => 'drjfspchj', 'title' => ''], ], [ - 'name' => 'Uuid', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'C78CA9E99315687575DD2844C1F3****', - ], + 'schema' => ['description' => 'Password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'As53328794', 'title' => ''], ], [ - 'name' => 'ClientType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of Alibaba Cloud Workspace clients.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* HTML5: web client.'."\n" - ."\n" - .'* WINDOWS: Windows client.'."\n" - ."\n" - .'* MACOS: macOS client.'."\n" - ."\n" - .'* IOS: iOS client.'."\n" - ."\n" - .'* ANDROID: Android client.', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'HTML5' => 'HTML5', - 'WINDOWS' => 'WINDOWS', - 'MACOS' => 'MACOS', - 'IOS' => 'IOS', - 'ANDROID' => 'ANDROID', - ], - 'example' => 'Windows', - ], - ], - [ - 'name' => 'AvailableFeatures', + 'name' => 'Description', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - ], - ], + 'schema' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'testDescription', 'title' => ''], ], [ - 'name' => 'ClientName', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Ensure request idempotence. Generate a parameter value from your client to ensure its uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '123e4567-e89b-12d3-a456-42665544****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Email' => [ - 'description' => 'The email address of the user. The system returns the email address in the return value of the LoginToken parameter after the user logs on to the client.'."\n" - ."\n" - .'* For a convenience user, the return value is the email address specified when the administrator creates the convenience user.'."\n" - .'* For an AD user, the return value is in the following format: `Username@Name of the AD domain`.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'Secret' => [ - 'description' => 'The key that is generated when you bind the virtual MFA device. This parameter is required when the CurrentStage parameter is set to `MFABind`.'."\n" - ."\n" - .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", - 'type' => 'string', - 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'EndUserId' => [ - 'description' => 'The account of the convenience user or the AD user.'."\n", - 'type' => 'string', - 'example' => 'alice', - ], - 'LoginToken' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - 'NextStage' => [ - 'description' => 'The next stage that is expected to enter. For example, an administrator enables MFA in the EDS console. When an end user enters the password, that is, the end user completes the `ADPassword` stage, this parameter returns `MFAVerify`. This indicates that MFA is required.'."\n" - ."\n" - .'> For more information about the authentication stages, see the `CurrentStage` parameter.', - 'type' => 'string', - 'example' => 'MFAVerify', - ], - 'QrCodePng' => [ - 'description' => 'The QR code that is generated when the virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty. This parameter is required only when the CurrentStage parameter is set to `MFABind`.'."\n" - ."\n" - .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", - 'type' => 'string', - 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******', - ], - 'Label' => [ - 'description' => 'The attribute of the convenience user. For an AD user, null is returned.'."\n", - 'type' => 'string', - 'example' => 'test:sample', - ], - 'SessionId' => [ - 'description' => 'The ID of the session. The ID is returned the first time you call the `GetLoginToken` operation in the session. If MFA is required, you must specify this parameter in subsequent stages.'."\n" - ."\n" - .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", - 'type' => 'string', - 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****', - ], - 'Phone' => [ - 'description' => 'Enter the mobile number of the convenience user. For an AD user, null is returned.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'TenantId' => [ - 'description' => 'The ID of the Alibaba Cloud account. The ID is used for hardware client authentication.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '166353906220****', - ], - 'KeepAliveToken' => [ - 'description' => 'The token used to keep the user logged on. After the user logs on to the client and select the Keep Logon option, `KeepAliveToken` is returned when you call the operation. If the user does not select the Keep Logon option, null is returned.'."\n", - 'type' => 'string', - 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW', - ], - 'Industry' => [ - 'description' => '> This is a parameter only for internal use.'."\n", - 'type' => 'string', - 'example' => 'edu', - ], - 'Props' => [ - 'description' => '> This is a parameter only for internal use.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => '> This is a parameter only for internal use.'."\n", - 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}', - ], - ], - 'WindowDisplayMode' => [ - 'description' => '> This is a parameter only for internal use.'."\n", - 'type' => 'string', - 'example' => 'mode', - ], - 'RiskVerifyInfo' => [ - 'description' => 'Risk identification information regarding the signin process.', - 'type' => 'object', - 'properties' => [ - 'Email' => [ - 'description' => 'The email used for authentication.', - 'type' => 'string', - 'example' => 'user@example.com', - ], - 'LastLockDuration' => [ - 'description' => 'The duration of the lock.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1713749778', - ], - 'Locked' => [ - 'description' => 'Whether the account is locked or not.', - 'type' => 'string', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Phone' => [ - 'description' => 'The mobile number used for authentication.', - 'type' => 'string', - 'example' => '1388888****', - ], - ], - ], - 'Reason' => [ - 'description' => '> This is a parameter only for internal use.', - 'type' => 'string', - 'example' => 'null', - ], - 'PasswordStrategy' => [ - 'description' => '> This is a parameter only for internal use.', - 'type' => 'object', - 'properties' => [ - 'TenantPasswordLength' => [ - 'description' => '> This is a parameter only for internal use.', - 'type' => 'string', - 'example' => 'null', - ], - 'TenantAlternativeChars' => [ - 'description' => '> This is a parameter only for internal use.', - 'type' => 'array', - 'items' => [ - 'description' => '> This is a parameter only for internal use.', - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - 'NickName' => [ - 'type' => 'string', - ], - 'WyId' => [ - 'type' => 'string', - ], + 'Index' => ['description' => 'Index.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****', 'title' => ''], + 'EncryptedPassword' => ['description' => 'Encrypted password.', 'type' => 'string', 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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' => 'GetLoginToken', - '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' => 'SetFingerPrintTemplate', + 'changeSet' => [ + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplate'], + ], ], + 'ramActions' => [], + 'summary' => '', + ], + 'SetFingerPrintTemplateDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'A unique ID that is generated by the client.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****', 'title' => ''], ], [ - 'name' => 'DirectoryId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', - ], + 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'd28520d4-da0b-4a97-981d-683db865****', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-238191****', - ], + 'schema' => ['description' => 'The logon credential.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'Index', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The index.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'alice', - ], + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Finger 1', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'A client-generated, unique token that ensures the idempotence of the request. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'title' => '', 'docRequired' => true, 'required' => true, 'example' => '40401e62-5caf-4508-8de7-bf98af12****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', - ], - 'LoginToken' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshLoginTokenResponse>\\r\\n <RequestId>FE379906-08A4-5893-9C18-77C32566D944</RequestId>\\r\\n</RefreshLoginTokenResponse>","errorExample":""}]', - 'title' => 'RefreshLoginToken', - 'summary' => 'Refreshes a logon token.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SendTokenCode' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]', + 'title' => 'SetFingerPrintTemplateDescription', + 'changeSet' => [ + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-08-18T07:11:40.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetFingerPrintTemplateDescription'], + ], ], + 'ramActions' => [], + 'summary' => '', + ], + 'StartDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client). The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-2925105532', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ - 'name' => 'SessionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', - ], + 'schema' => ['description' => 'The operating system (OS) of the device that run the client.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ - 'name' => 'EndUserId', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The username of the account.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'alice', - ], + 'schema' => ['description' => 'The client version. If you use a WUYING client, you can click **About** on the client logon page to view the version of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => ' 2.1.0-R-20210731.151756', 'title' => ''], ], [ - 'name' => 'ClientOS', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The operating system on which the client runs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Windows_NT 10.0.18363 x64', + 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecd-cg27ufmapab08****', 'title' => ''], + 'required' => true, + 'example' => 'ecd-cg27ufmapab08****', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'ClientVersion', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The client version. If you use an Alibaba Cloud Workspace client, you can view the client version in the "About" dialog box on the client logon page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2.1.0-R-20210731.151756', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****', 'title' => ''], ], [ - 'name' => 'TokenCode', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'If two-factor authentication is enabled for clients in the Elastic Desktop Service (EDS) Enterprise console, the system will send a verification code to the user\'s email address if it detects that the current logged-on user is at risk. This parameter is required if you set `CurrentStage` to `TokenVerify`.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '63****', - ], + 'schema' => ['description' => 'The UUID of the client.'."\n", 'type' => 'string', 'required' => false, 'example' => '71F6A700735E74A61161A53F0C47****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameter.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n", - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]', - 'title' => 'SendTokenCode', - 'summary' => 'Sends a logon verification code.', - ], - 'ChangePassword' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'StartDesktops', + 'summary' => 'Start cloud computers.', + 'description' => 'The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-25T06:05:27.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDesktops'], + ], ], + 'ramActions' => [], + '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":""}]', + ], + 'StopDesktops' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Call [DescribeRegions](~~196646~~) to get a list of regions where WUYING Workspace is available.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai+dir-227468****', - ], + 'schema' => ['description' => 'A unique ID that the client generates.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'EndUserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'liming', - ], + 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', 'title' => ''], ], [ 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - ], - [ - 'name' => 'OldPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The current password.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '12345678', - ], + 'schema' => ['description' => 'The logon credential.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', 'title' => ''], ], [ - 'name' => 'NewPassword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new password.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '67436290', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****', - ], - 'LoginToken' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]', - 'title' => 'ChangePassword', - 'summary' => 'Changes the password of a user account.', - ], - 'ResetPassword' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', + 'name' => 'ClientOS', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The operating system of the device where the client runs.', 'type' => 'string', 'required' => false, 'example' => 'Windows_NT 10.0.18363 x64', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'ClientVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '95e41934-383e-4c9f-824f-3b93b19b****', - ], + 'schema' => ['description' => 'The client version. If you use the WUYING Workspace client, find this value in the **About** dialog box on the logon screen.', 'type' => 'string', 'required' => false, 'example' => '2.1.0-R-20210731.151756', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'DesktopId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the cloud computers. You can specify from 1 to 20 IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the cloud computer.', 'type' => 'string', 'required' => false, 'example' => 'ecd-7w78ozhjcwa3u**** ', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou+dir-899235****', + 'example' => 'ecd-7w78ozhjcwa3u**** ', + 'maxItems' => 100, + 'title' => '', ], ], [ - 'name' => 'EndUserId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'liming', - ], + 'schema' => ['description' => 'A client token to ensure idempotence. Generate a unique ASCII string for each request. The string must be no more than 64 characters long. For more information, see [How to ensure idempotence](~~25693~~).', 'type' => 'string', 'title' => '', 'required' => false, 'docRequired' => true, 'example' => '6ce412a8-399f-49f9-9518-66ee028a****'], ], [ - 'name' => 'Email', + 'name' => 'SessionToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The email address of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'a***@example.edu', - ], + 'schema' => ['description' => 'The logon credential.', 'type' => 'string', 'required' => false, 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', 'title' => ''], ], [ - 'name' => 'phone', + 'name' => 'OsUpdate', 'in' => 'query', - 'schema' => [ - 'description' => 'The phone number of the user.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1827912****', - ], + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'Returns a collection of messages.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]', - 'title' => 'ResetPassword', - 'summary' => 'Resets a password.', - ], - 'EncryptPassword' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'StopDesktops', + 'summary' => 'Stops one or more cloud computers.', + 'description' => 'You can stop only cloud computers that are in the Running state. After you call this operation, their state changes to Stopped.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-19T12:13:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-18T03:52:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-18T06:48:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-08-19T08:13:54.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDesktops'], + ], ], + 'ramActions' => [], + ], + 'UnbindUserDesktop' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], ], ], - 'systemTags' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the client. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'example' => 'v12307f5e0****', 'title' => ''], ], [ - 'name' => 'DirectoryId', + 'name' => 'ClientType', 'in' => 'query', - 'schema' => [ - 'description' => 'The directory ID.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cn-beijing+dir-131196****', - ], + 'schema' => ['description' => 'The client type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'windows', 'title' => ''], ], [ - 'name' => 'OfficeSiteId', + 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-beijing+dir-131196****', - ], + 'schema' => ['description' => 'The client ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '58f96f67-7944-4f97-9342-****', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '3b053331-dc98-43d8-b247-****', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'UserDesktopId', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****', - ], + 'schema' => ['description' => 'The cloud computer ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ud-sdfs****', 'title' => ''], ], [ - 'name' => 'Password', + 'name' => 'Force', 'in' => 'query', 'schema' => [ - 'description' => 'The password that you want to encrypt.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Ab123456', + 'description' => 'Specifies whether to enable forced unbinding.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: Even when end users connect to cloud computers, the forced unbinding is still enforced.'."\n" + .'* false: Forced unbinding is only enforced when end users are disconnected from cloud computers.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'EncryptedPassword' => [ - 'description' => 'The encrypted password.'."\n", - 'type' => 'string', - 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D5B7CF35-E078-5EBF-A010-****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]', - 'title' => 'EncryptPassword', - 'summary' => 'Encrypts a password.', - ], - 'DescribeFingerPrintTemplates' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'Anonymous' => [], - ], - ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '61e39dc6-0450-45f6-a372-2a09e938****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****', - ], + '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' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****', - ], - 'FingerPrintTemplates' => [ - 'description' => 'The fingerprint templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The fingerprint template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Index' => [ - 'description' => 'The index.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreationTime' => [ - 'description' => 'The time when the template was created.'."\n", - 'type' => 'string', - 'example' => '2022-03-13T13:26:29Z', - ], - 'LoginTime' => [ - 'description' => 'The logon time.'."\n", - 'type' => 'string', - 'example' => '2022-03-13T13:26:29Z', - ], - 'EndUserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => 'liming', - ], - 'Description' => [ - 'description' => 'The description of the template.'."\n", - 'type' => 'string', - 'example' => 'Finger 1', - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-074949****', - ], - 'ClientId' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****', - ], - ], - ], - ], - ], - ], + 'title' => 'UnbindUserDesktop', + 'summary' => 'Unbinds end users from cloud computers.', + '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' => 'DescribeFingerPrintTemplates', - 'summary' => 'Queries fingerprint templates.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]', ], - 'SetFingerPrintTemplate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'VerifyCredential' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'Anonymous' => [], @@ -5686,110 +3484,56 @@ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ClientId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '347431a9-90f6-448e-82c4-42bc84a9****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****', - ], + 'schema' => ['description' => 'The client ID. The system generates a unique ID for each client.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****', 'title' => ''], ], [ - 'name' => 'LoginToken', + 'name' => 'OfficeSiteId', 'in' => 'query', - 'schema' => [ - 'description' => 'The logon credentials.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****', - ], + 'schema' => ['description' => 'The office network ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai+dir-227468****', 'title' => ''], ], [ - 'name' => 'FingerPrintTemplate', + 'name' => 'SessionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The fingerprint template.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'goG3gG8AAABhujtscn', - ], + 'schema' => ['description' => 'The session ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****', 'title' => ''], ], [ - 'name' => 'EncryptedFingerPrintTemplate', + 'name' => 'LoginToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The encrypted fingerprint template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AAAAAAAAAAAAAA', - ], + 'schema' => ['description' => 'The logon token.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****', 'title' => ''], ], [ - 'name' => 'EncryptedKey', + 'name' => 'CredentialType', 'in' => 'query', 'schema' => [ - 'description' => 'The encryption key.'."\n", + 'description' => 'The type of the logon credential that you want to clear.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MfaPasscode: the multi-factor verification code.'."\n" + .'* FingerPrint: the fingerprint.'."\n" + .'* Password: the password.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'drjfspchj', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'description' => 'The password that you want to encrypt.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'As53328794', + 'docRequired' => false, + 'enumValueTitles' => ['MfaPasscode' => '', 'FingerPrint' => '', 'Password' => ''], + 'example' => 'Password', + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'Credential', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'testDescription', - ], + 'schema' => ['description' => 'The credential.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456789cyG', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'EncryptedKey', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token to ensure the idempotency of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123e4567-e89b-12d3-a456-42665544****', - ], + 'schema' => ['description' => 'The ID of the key that you want to encrypt.'."\n", 'type' => 'string', 'required' => false, 'example' => 'drjfs****', 'title' => ''], ], ], 'responses' => [ @@ -5797,427 +3541,592 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Index' => [ - 'description' => 'The index.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****', - ], - 'EncryptedPassword' => [ - 'description' => 'The encrypted password.'."\n", - 'type' => 'string', - 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Index\\": 1,\\n \\"RequestId\\": \\"CDE666EA-4FCD-5024-895C-8698E3D3****\\",\\n \\"EncryptedPassword\\": \\"0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==\\"\\n}","type":"json"}]', - 'title' => 'SetFingerPrintTemplate', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]', + 'title' => 'VerifyCredential', + 'summary' => 'Validates credentials to lock on-premises sessions on clients.', + 'changeSet' => [ + ['createdAt' => '2021-10-23T01:17:07.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyCredential'], + ], + ], + 'ramActions' => [], ], - 'SetFingerPrintTemplateDescription' => [ - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-beijing.aliyuncs.com', 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-qingdao.aliyuncs.com', 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-shanghai.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-hongkong.aliyuncs.com', 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-shenzhen.aliyuncs.com', 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-nanjing.aliyuncs.com', 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-northeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-chengdu.aliyuncs.com', 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-guangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-1.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-5.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-6.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', 'vpc' => 'ecd-shenzhen-center.vpc-proxy.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.ap-southeast-7.aliyuncs.com', 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ecd.cn-hangzhou.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.eu-west-1.aliyuncs.com', 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.us-west-1.aliyuncs.com', 'endpoint' => 'ecd.us-west-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'ecd.eu-central-1.aliyuncs.com', 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ecd.me-east-1.aliyuncs.com', 'endpoint' => 'ecd.me-east-1.aliyuncs.com', 'vpc' => 'ecd-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'ecd.me-central-1.aliyuncs.com', 'endpoint' => 'ecd.me-central-1.aliyuncs.com', 'vpc' => 'ecd.vpc-proxy.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'ecd-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'ecd-intl.vpc-proxy.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'App.Authing', 'message' => 'App is authing.', 'http_code' => 400, 'description' => 'The app is being set to be visible, please try again later.'], + ['code' => 'AuthorizeFailed', 'message' => 'Authorize failed, please check your EndUserId and Password.', 'http_code' => 400, 'description' => 'Invalid username or password.'], + ['code' => 'Benefit.NotExist', 'message' => 'The specified benefit is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Benefit.StockInsufficient', 'message' => 'The specified benefit is out of stock.', 'http_code' => 400, 'description' => ''], + ['code' => 'Channel.NotExist', 'message' => 'The specified channel is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Channel.TokenInvalid', 'message' => 'The channel service request token is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ChooseClusterError.ZoneId', 'message' => 'Cannot choose zone, please try other zone.', 'http_code' => 400, 'description' => 'The property of the resource zone does not match. Check whether the target office network supports the zone to which the resource belongs.'], + ['code' => 'DeletedBundleStatus', 'message' => 'The specified bundle status is deleted.', 'http_code' => 400, 'description' => 'The specified template has been deleted'], + ['code' => 'DesktopCpuHighLoad%s', 'message' => 'The specified desktop cpu high load.', 'http_code' => 400, 'description' => 'The CPU usage of this cloud computer is too high, causing the connection to time out. The application with the highest CPU usage is% s. Please reconnect or restart the cloud computer. If the connection failure still occurs, contact your IT administrator.'], + ['code' => 'DesktopMemoryHighLoad%s', 'message' => 'The specified desktop memory high load.', 'http_code' => 400, 'description' => 'A time out error occurred when connecting to this cloud computer because the memory usage of it is too high. The app consuming the most memory is %s. Please reconnect or restart the cloud computer. If the issue persists, please contact your IT administrator.'], + ['code' => 'ExistedFingerPrintTemplate', 'message' => 'The fingerprint is already registered as %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExistedHostname', 'message' => 'The specified hostname is existed on the domain.', 'http_code' => 400, 'description' => 'The specified hostname already exists in the current workspace'], + ['code' => 'ExportDesktop.UnknowError', 'message' => 'Failed to export desktop list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => ''], + ['code' => 'ExportDesktopGroup.UnknowError', 'message' => 'Failed to export desktop group list. Please try again. If the problem still exists, submit a ticket.', 'http_code' => 400, 'description' => ''], + ['code' => 'FengyuTestCode1.%s', 'message' => 'FengyuTestMsg1.%s.', 'http_code' => 400, 'description' => 'Feng Yu Test Dynamic Error Description 1, Dynamic Error Message (%s)'], + ['code' => 'FengyuTestCode2', 'message' => 'FengyuTestMsg2.', 'http_code' => 400, 'description' => 'Feng Yu tests Chinese'], + ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'User does not have permission to operate on the specified resource'], + ['code' => 'FOTAVersion.NotSupported', 'message' => 'Desktop version does not support this function, please upgrade.', 'http_code' => 400, 'description' => 'The current desktop version does not support this feature. Update the version.'], + ['code' => 'HostnameCannotCustomizeForLinux', 'message' => 'Customizing hostname is not supported for Linux desktop.', 'http_code' => 400, 'description' => 'The custom hostname feature does not support Linux desktops'], + ['code' => 'IncorrectDirectoryStatus', 'message' => 'Only registered directory can create desktop.', 'http_code' => 400, 'description' => 'Workspace status error, only desktop creation with registered workspace is supported'], + ['code' => 'IncorrectDirectoryType', 'message' => 'The protocol type of directory and desktop do not match.', 'http_code' => 400, 'description' => 'The protocol types of the specified workspace and the target desktop do not match, please check'], + ['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidAmount', 'message' => 'The specified Amount is not a valid value.', 'http_code' => 400, 'description' => 'The specified quantity is illegal'], + ['code' => 'InvalidAmount.NotTimesOfUsers', 'message' => 'The specified Amount is notmatch EndUserId size.', 'http_code' => 400, 'description' => 'The number of desktops specified is not equal to the number of users to be assigned, please re-specify'], + ['code' => 'InvalidClientIp.Policy', 'message' => 'Client ip %s is not in white list.', 'http_code' => 400, 'description' => 'The IT administrator has set an IP whitelist policy that prevents you from connecting to this cloud computer under your current IP environment (%s). Please contact the IT administrator.'], + ['code' => 'InvalidDesktopBundle.NotFound', 'message' => 'The specified param BundleId is not found.', 'http_code' => 400, 'description' => 'Specified BundleId not found'], + ['code' => 'InvalidDirectoryId.NotFound', 'message' => 'The specified param DirectoryId is not found.', 'http_code' => 400, 'description' => 'Unable to find workspace ID, please check workspace'], + ['code' => 'InvalidDirectoryType.NotSupported', 'message' => 'The specified DirectoryType is not supported.', 'http_code' => 400, 'description' => 'Specified'], + ['code' => 'InvalidEncryptionEnabled.Invalid', 'message' => 'The parameter VolumeEncryptionEnabled is invalid.', 'http_code' => 400, 'description' => 'When specifying the encryption key, you need to turn on the disk encryption function.'], + ['code' => 'InvalidEncryptionKey.Missing', 'message' => 'Parameter VolumeEncryptionKey is missing.', 'http_code' => 400, 'description' => 'When the disk encryption function is enabled, the encryption key cannot be empty.'], + ['code' => 'InvalidEncryptionKey.NotAuthorized', 'message' => 'Eds service cannot access the given VolumeEncryptionKey.', 'http_code' => 400, 'description' => 'Unable to access unauthorized encryption keys'], + ['code' => 'InvalidEncryptionKey.NotFound', 'message' => 'The specified VolumeEncryptionKey is not found.', 'http_code' => 400, 'description' => 'The specified encryption key could not be found'], + ['code' => 'InvalidFingerPrintTemplate', 'message' => 'The fingerprint template is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidFingerPrintTemplateIndex', 'message' => 'The index of the fingerprint template is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidImageStatus.NotValid', 'message' => 'The specified image status is not valid.', 'http_code' => 400, 'description' => 'The status of the specified image is unavailable and cannot be created.'], + ['code' => 'InvalidImageVersion.NotSupported', 'message' => 'The specified image version is no longer supported.', 'http_code' => 400, 'description' => 'The specified image version is no longer supported. Please select another image.'], + ['code' => 'InvalidMemberIp.DesktopAmount', 'message' => 'The desktop amount need to be 1.', 'http_code' => 400, 'description' => 'When you specify an IP to create a desktop, the number of desktops can only be 1'], + ['code' => 'InvalidOssObjectPath.NotFound', 'message' => 'Cannot parse input oss object path. eg: http://bucket/object.vhd.', 'http_code' => 400, 'description' => 'It is detected that the uploaded image file is not available, please ensure that the correct custom image is uploaded to the specified OSS bucket address.'], + ['code' => 'InvalidParameter.ResourceId', 'message' => 'The specified parameter ResourceId is invalid.', 'http_code' => 400, 'description' => 'The specified parameter ResourceId is invalid.'], + ['code' => 'InvalidParameterError', 'message' => 'Cannot query with end user id and include assigned user.', 'http_code' => 400, 'description' => 'Querying unassigned user and end user ID at the same time is not supported.'], + ['code' => 'InvalidPolicyGroup.Status', 'message' => 'The target policy group is being created. Please try again later.', 'http_code' => 400, 'description' => ''], + ['code' => 'LockedUser', 'message' => 'User is locked.', 'http_code' => 400, 'description' => ''], + ['code' => 'NetworkSpace.DependencyViolation', 'message' => 'networkSpace dependency violation.', 'http_code' => 400, 'description' => 'Resources exist in the current office network and cannot be deleted directly.'], + ['code' => 'NetworkSpace.VpcInfoExist', 'message' => 'vpc info already exist.', 'http_code' => 400, 'description' => 'Office network already exists for the corresponding VPC'], + ['code' => 'NoStock.ZoneInvalid', 'message' => 'The requested resource is sold out in the specified zone.', 'http_code' => 400, 'description' => 'The specified resource is out of stock in the selected Availability Zone.'], + ['code' => 'OperationTooFrequent', 'message' => 'The operation is too frequent, please try again later.', 'http_code' => 400, 'description' => 'Operation is too frequent, please try again later'], + ['code' => 'Order.Unpaid', 'message' => 'You have unpaid orders, please pay such orders before placing a new order.', 'http_code' => 403, 'description' => ''], + ['code' => 'ParamError.NoDesktopGroupId', 'message' => 'You must specify desktopGroupId.', 'http_code' => 400, 'description' => ''], + ['code' => 'Protocol.NotAllowed', 'message' => 'Procotol of the image is not allowed.', 'http_code' => 400, 'description' => 'The protocol type of the image is not supported. Check the image ID.'], + ['code' => 'RedeemCode.QuantityExceeded', 'message' => 'The number of redeem codes obtained at a time is out of the valid range.', 'http_code' => 400, 'description' => ''], + ['code' => 'RESOURCE_GROUP_ALREADY_BOUND_APP_RULE', 'message' => 'Resource group already bound app rule.', 'http_code' => 400, 'description' => 'The resource group to which the cloud computer belongs is binding/unbinding application control rules.'], + ['code' => 'RISK.RISK_CONTROL_REJECTION', 'message' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.', 'http_code' => 400, 'description' => 'In order to protect the security of your account, the order was suspended, please contact customer service for details.'], + ['code' => 'SALES_SERVICE_ERROR_INFORMATION', 'message' => 'Your information is incomplete. Complete your information before the operation.', 'http_code' => 400, 'description' => 'Your information is incomplete. Please complete all required fields here(超链接：https://myaccount.alibabacloud.com/user_info.htm?callback=#/userinfo ) before proceeding.'], + ['code' => 'StartApplicationFail', 'message' => 'The application start fail.', 'http_code' => 400, 'description' => 'Failed to start, please go to the "start" menu of win system to open shadowless housekeeper'], + ['code' => 'StartApplicationGuestNoApp', 'message' => 'The application no start app.', 'http_code' => 400, 'description' => 'Please go to shadowless application center to download shadowless butler'], + ['code' => 'StartApplicationGuestOffline', 'message' => 'The application guest offline.', 'http_code' => 400, 'description' => 'Desktop exception, please go to the "start" menu of win system to open shadowless housekeeper'], + ['code' => 'StartApplicationGuestTimeout', 'message' => 'The application guest timeout.', 'http_code' => 400, 'description' => 'The call timed out, please go to the "start" menu of win system to open shadowless housekeeper.'], + ['code' => 'Throttling.FingerPrintTemplateSet', 'message' => 'The previous fingerprint template setting is not completed yet.', 'http_code' => 400, 'description' => ''], + ['code' => 'TooManyFingerPrintTemplateForDevice', 'message' => 'The maximum number of fingerprint templates that any user can save on the current device is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'TooManyFingerPrintTemplateForUser', 'message' => 'The maximum number of fingerprint templates that you can save in the current environment is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'TransitRouterService.TrNotExistInRegion', 'message' => 'The transit router need create in current region.', 'http_code' => 400, 'description' => 'There is no transit router in the current region in the cloud enterprise network, please go to the cloud enterprise network console to create a new router.'], + ['code' => 'UnavailableDesktop', 'message' => 'Authentication failure.', 'http_code' => 400, 'description' => 'Authentication failed, unable to connect.'], + ['code' => 'DesktopCanOnlyAssignedToOneUser', 'message' => 'The desktop can only assigned to one user.', 'http_code' => 400, 'description' => 'Forced connection is not allowed when multiple users are assigned to the cloud computer'], + ['code' => 'GET_APP_RULE_LOCK_FAILED', 'message' => 'Get app rule lock failed.', 'http_code' => 400, 'description' => 'The operation is too frequent, please try again later.'], + ['code' => 'INSUFFICIENT_QUOTA', 'message' => 'Insufficient quota.', 'http_code' => 400, 'description' => 'Insufficient user quota'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeOfficeSites'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-10-24T07:30:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetConnectionTicket'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2025-10-17T09:12:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RebootDesktops'], + ['description' => 'Request parameters changed', 'api' => 'StopDesktops'], ], - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'd28520d4-da0b-4a97-981d-683db865****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****', - ], - ], - [ - 'name' => 'Index', - 'in' => 'query', - 'schema' => [ - 'description' => 'The index.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Finger 1', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], - ], + 'createdAt' => '2025-03-18T03:52:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ApproveFotaUpdate'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****', - ], - ], - ], - ], + 'createdAt' => '2025-02-26T08:11:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeUserResources'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]', - 'title' => 'SetFingerPrintTemplateDescription', + 'createdAt' => '2025-02-25T11:43:07.000Z', + 'description' => '', ], - 'DeleteFingerPrintTemplate' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeSnapshots'], + ['description' => 'Request parameters changed', 'api' => 'ResetSnapshot'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2025-01-15T01:27:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'GetConnectionTicket'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2024-11-24T01:49:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeGlobalDesktops'], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****', - ], - ], - [ - 'name' => 'SessionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The session ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '6df06330-3b75-4768-b334-41a73a64****', - ], - ], - [ - 'name' => 'LoginToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The logon token.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****', - ], - ], - [ - 'name' => 'Index', - 'in' => 'query', - 'schema' => [ - 'description' => 'The index.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '4', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the value, but you ensure sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '40401e62-5caf-4508-8de7-bf98af12****', - ], - ], + 'createdAt' => '2024-11-09T02:21:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ResetSnapshot'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****', - ], - ], - ], - ], + 'createdAt' => '2024-10-30T09:25:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteFingerPrintTemplate', + 'createdAt' => '2024-09-27T07:36:48.000Z', + 'description' => '', ], - 'IsKeepAlive' => [ - 'summary' => 'Verifies whether the client\'s logon session is still active.', - 'methods' => [ - 'post', - 'get', + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2024-08-13T06:27:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetLoginToken'], ], - 'security' => [ - [ - 'Anonymous' => [], - ], + 'createdAt' => '2024-06-04T02:16:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RebootDesktops'], + ['description' => 'Request parameters changed', 'api' => 'StartDesktops'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ClientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', - ], - ], - [ - 'name' => 'OfficeSiteId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou+dir-885351****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], + 'createdAt' => '2024-04-25T06:05:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetLoginToken'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'."\n", - ], - 'OfficeSiteId' => [ - 'description' => 'The office network ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou+dir-885351****'."\n", - ], - 'TenantId' => [ - 'description' => 'The unique ID (UID) of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '141631846826****', - ], - 'IsKeepAlive' => [ - 'description' => 'Identifies whether the user should remain logged on to the client.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2024-04-23T02:40:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', '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' => 'IsKeepAlive', + 'createdAt' => '2024-04-10T13:31:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-12-13T06:22:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-12-11T04:08:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ApproveFotaUpdate'], + ], + 'createdAt' => '2023-09-21T08:18:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-08-02T09:43:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RebootDesktops'], + ['description' => 'Request parameters changed', 'api' => 'StopDesktops'], + ], + 'createdAt' => '2023-05-18T06:48:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-05-18T06:08:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ApproveFotaUpdate'], + ], + 'createdAt' => '2023-03-24T08:22:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2023-03-24T08:20:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeOfficeSites'], + ], + 'createdAt' => '2023-01-09T11:54:49.000Z', + 'description' => '匿名接口返回私网网关地址', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-12-26T02:25:44.000Z', + 'description' => '返回续费活动通知', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'Request parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-11-29T11:36:18.000Z', + 'description' => '查询桌面接口增加orderby字段，支持按分配时间排序', ], - ], - 'endpoints' => [ [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UnbindUserDesktop'], + ], + 'createdAt' => '2022-11-02T14:29:58.000Z', + 'description' => '增加入参：是否强制解绑，默认不强制', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-10-27T10:48:58.000Z', + 'description' => '增加返回值realDesktopId', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-10-25T14:54:13.000Z', + 'description' => '新增status字段，标志用户当前是否被禁用', ], [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-10-18T15:11:17.000Z', + 'description' => '桌面查询全局搜索接口增加fota查询字段', ], [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ['description' => 'OpenAPI offline', 'api' => 'ModifyEndUserAttribute'], + ], + 'createdAt' => '2022-10-17T02:12:02.000Z', + 'description' => '新增功能：1.端侧用户可以自定义自己拥有的桌面名称；2.自定义桌面名称将会在端侧展示', ], [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetLoginToken'], + ['description' => 'Response parameters changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-09-13T10:33:37.000Z', + 'description' => '内部参数调用', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-08-17T02:10:31.000Z', + 'description' => '无影云盘支持登录AD账户登录', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-07-07T06:16:44.000Z', + 'description' => '隐藏不对外的参数', ], [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeGlobalDesktops'], + ], + 'createdAt' => '2022-06-22T12:51:50.000Z', + 'description' => '增加字段供企业标识符使用', ], [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-06-10T05:54:18.000Z', + 'description' => '匿名接口增加桌面私网IP透出', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeDesktopSearchFields'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeGlobalBundles'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeGlobalDesktops'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeGlobalDesktopTypes'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeGlobalOfficeSites'], + ], + 'createdAt' => '2022-06-06T03:17:33.000Z', + 'description' => 'Meta搜索服务接口', ], [ - 'regionId' => 'cn-nanjing', - 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetConnectionTicket'], + ], + 'createdAt' => '2022-05-26T08:24:41.000Z', + 'description' => 'DoAfterGetTicketParam因为命名规范要求更改成ComandContent', ], [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-05-13T04:04:21.000Z', + 'description' => '修改文档必填参数', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateInternetPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeDirectoryInternetPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'SetStudentsDesktopGroupPolicy'], + ], + 'createdAt' => '2022-04-29T08:17:38.000Z', + 'description' => '【少年云】新增学生桌面组黑白名单配置', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ResetPassword'], + ], + 'createdAt' => '2022-04-27T09:07:17.000Z', + 'description' => '客户端忘记密码去掉邮件必填的限制', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-04-25T08:57:10.000Z', + 'description' => '去除无用参数', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteFingerPrintTemplate'], + ['description' => 'Request parameters changed', 'api' => 'RebootDesktops'], + ['description' => 'Request parameters changed', 'api' => 'ResetPassword'], + ['description' => 'Request parameters changed', 'api' => 'SetFingerPrintTemplate'], + ['description' => 'Request parameters changed', 'api' => 'SetFingerPrintTemplateDescription'], + ['description' => 'Request parameters changed', 'api' => 'StartDesktops'], + ], + 'createdAt' => '2022-04-13T08:46:21.000Z', + 'description' => '增加clientToken字段，支持幂等调用。', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'ecd.us-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetCloudDriveServiceMountToken'], + ], + 'createdAt' => '2022-03-29T08:28:02.000Z', + 'description' => '客户端支持访问pds', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ApproveFotaUpdate'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-03-21T13:00:36.000Z', + 'description' => '支持镜像升级API', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StopDesktops'], + ], + 'createdAt' => '2022-03-17T08:44:28.000Z', + 'description' => '修改stopDesktops接口，增加clientToken字段，支持幂等。', ], [ - 'regionId' => 'me-central-1', - 'endpoint' => 'ecd.me-central-1.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeOfficeSiteInternetStatus'], + ['description' => 'OpenAPI offline', 'api' => 'SetOfficeSiteInternetStatus'], + ], + 'createdAt' => '2022-03-14T10:49:36.000Z', + 'description' => '增加查询桌面组网络状态和修改桌面组网络状态。', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-02-16T03:21:48.000Z', + 'description' => '客户端匿名接口GetLoginToken增加sso相关信息修改', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'BatchGetLiteConnectionTicket'], + ], + 'createdAt' => '2022-01-19T15:24:34.000Z', + 'description' => 'lite版getConnectionTicket接口支持客户端重连', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'ecd.me-east-1.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2022-01-13T08:09:33.000Z', + 'description' => '客户端匿名接口增加clientType', ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2022-01-11T08:11:27.000Z', + 'description' => '增加gpu显存参数', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ChangePassword'], + ['description' => 'Response parameters changed', 'api' => 'RefreshLoginToken'], + ], + 'createdAt' => '2021-12-14T04:01:48.000Z', + 'description' => 'RefreshLoginToken和ChangePassword返回LoginToken', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeDesktops'], + ], + 'createdAt' => '2021-12-08T05:40:52.000Z', + 'description' => 'DescribeDesktops返回参数增加GpuCount', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DescribeSnapshots'], + ['description' => 'OpenAPI offline', 'api' => 'ResetSnapshot'], + ], + 'createdAt' => '2021-11-18T05:40:11.000Z', + 'description' => '增加客户端快照接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetLoginToken'], + ['description' => 'Request parameters changed', 'api' => 'SetFingerPrintTemplate'], + ['description' => 'Request parameters changed', 'api' => 'VerifyCredential'], + ], + 'createdAt' => '2021-10-23T01:17:39.000Z', + 'description' => '指纹数据加密传输', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetLoginToken'], + ['description' => 'OpenAPI offline', 'api' => 'IsKeepAlive'], + ], + 'createdAt' => '2021-09-10T12:50:31.000Z', + 'description' => '增加保持登录参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'GetLoginToken'], + ], + 'createdAt' => '2021-08-19T02:52:32.000Z', + 'description' => 'GetLoginToken新增参数支持指纹登录', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteFingerPrintTemplate'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeFingerPrintTemplates'], + ['description' => 'OpenAPI offline', 'api' => 'SetFingerPrintTemplate'], + ['description' => 'OpenAPI offline', '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' => 'Elastic Desktop Service', + 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'], + 'ramLevel' => 'SERVICE', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], ], ]; |