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 | 6223 |
1 files changed, 6223 insertions, 0 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 new file mode 100644 index 0000000..2463802 --- /dev/null +++ b/data/en_us/ecd/2020-10-02/api-docs.php @@ -0,0 +1,6223 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'ecd', + 'version' => '2020-10-02', + ], + 'directories' => [ + [ + 'id' => 203311, + 'title' => 'Cloud resource management', + 'type' => 'directory', + 'children' => [ + 'DescribeRegions', + 'DescribeDirectories', + 'DescribeOfficeSites', + 'DescribeGlobalDesktops', + 'DescribeUserResources', + 'UnbindUserDesktop', + 'GetConnectionTicket', + 'StartDesktops', + 'StopDesktops', + 'RebootDesktops', + 'ReportSessionStatus', + 'ApproveFotaUpdate', + 'DescribeSnapshots', + 'ResetSnapshot', + 'GetCloudDriveServiceMountToken', + 'VerifyCredential', + ], + ], + [ + 'id' => 203310, + 'title' => 'User logon', + 'type' => 'directory', + 'children' => [ + 'GetLoginToken', + 'RefreshLoginToken', + 'SendTokenCode', + 'ChangePassword', + 'ResetPassword', + 'EncryptPassword', + 'DescribeFingerPrintTemplates', + 'SetFingerPrintTemplate', + 'SetFingerPrintTemplateDescription', + 'DeleteFingerPrintTemplate', + 'IsKeepAlive', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DescribeRegions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ac4a73ad-789a-449a-a88f-d18571d6****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'Regions' => [ + 'description' => 'The regions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The region.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => [ + 'description' => 'The region endpoint.'."\n", + 'type' => 'string', + 'example' => 'ecd.cn-hangzhou.aliyuncs.com', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionEndpoint\\": \\"ecd.cn-hangzhou.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeRegions', + ], + 'DescribeDirectories' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', + ], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The directory IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The directory ID, which is the same as the office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F369A091-002F-49C8-AD55-02A77629****', + ], + 'Directories' => [ + 'description' => 'The directories.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The directory.'."\n", + 'type' => 'object', + 'properties' => [ + 'DirectoryType' => [ + 'description' => 'The directory type.'."\n", + 'type' => 'string', + 'example' => 'AD_CONNECTOR', + ], + 'SsoServiceUrl' => [ + 'description' => 'The URL of the SSO service.'."\n", + 'type' => 'string', + 'example' => 'https://eds-cn-shanghai-67726****', + ], + 'DesktopAccessType' => [ + 'description' => 'The connection method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* VPC: End users connect to cloud computers over an enterprise virtual private cloud (VPC).'."\n" + .'* INTERNET: End users connect to cloud computers over the Internet.'."\n" + .'* ANY: End users connect to cloud computers over the Internet or an enterprise VPC.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'VPC连接' => '', + 'INTERNET' => '', + 'ANY' => '', + ], + 'example' => 'INTERNET', + ], + 'DirectoryId' => [ + 'description' => 'The directory ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-gx2x1dhsmu52rd****', + ], + 'ProviderId' => [ + 'description' => 'The provider ID.'."\n", + 'type' => 'string', + 'example' => '26842', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F369A091-002F-49C8-AD55-02A77629****\\",\\n \\"Directories\\": [\\n {\\n \\"DirectoryType\\": \\"AD_CONNECTOR\\",\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67726****\\",\\n \\"DesktopAccessType\\": \\"INTERNET\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-gx2x1dhsmu52rd****\\",\\n \\"ProviderId\\": \\"26842\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeDirectories', + 'summary' => 'Queries directory details.', + ], + 'DescribeOfficeSites' => [ + 'summary' => 'Queries office networks.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-363353****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'title' => 'uuid', + 'description' => 'uuid'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ASDASD', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'OfficeSites' => [ + 'description' => 'The office networks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the office network.'."\n", + 'type' => 'object', + 'properties' => [ + 'SsoServiceUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://eds-cn-shanghai-67****', + ], + 'DesktopAccessType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'INTERNET' => '', + 'VPC' => '', + 'Any' => '', + ], + 'example' => 'VPC', + ], + 'DesktopVpcEndpoint' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com', + ], + 'OfficeSiteType' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'ad_connector' => '', + 'simple' => '', + ], + 'example' => 'SIMPLE', + ], + 'ProviderId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '268****', + ], + 'OfficeSiteId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-363353****', + ], + 'BizType' => [ + 'title' => 'biztype', + 'description' => 'biztype'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'ENTERPRISE', + ], + 'AliUid' => [ + 'title' => 'aliuid', + 'description' => 'aliuid'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '125552', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"OfficeSites\\": [\\n {\\n \\"SsoServiceUrl\\": \\"https://eds-cn-shanghai-67****\\",\\n \\"DesktopAccessType\\": \\"VPC\\",\\n \\"DesktopVpcEndpoint\\": \\"http://ep-bp1s2vmbj55r5rzc****.epsrv-bp1pcfhpwvlpny01****.cn-hangzhou.privatelink.aliyuncs.com\\",\\n \\"OfficeSiteType\\": \\"SIMPLE\\",\\n \\"ProviderId\\": \\"268****\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"BizType\\": 0,\\n \\"AliUid\\": 125552\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeOfficeSites', + ], + 'DescribeGlobalDesktops' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '121369', + 'abilityTreeNodes' => [ + 'FEATUREgwsENR35V', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* cn-shanghai: China (Shanghai)'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'enumValueTitles' => [ + 'cn-shanghai' => '', + ], + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network IDs.'."\n" + ."\n" + .'> This parameter is about to be disabled. Use `OfficeSiteId`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou+dir-880841****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network IDs.'."\n" + ."\n" + .'> `DirectoryId` the parameter is about to be retired, use this field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-880841****', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique ID generated by the client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c213150d-7ac3-432c-b749-6e1e090b****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID. You can call the GetLoginToken operation to query the value of the SessionId parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '5c456a41-1e65-4e72-ab4d-5dcfff52****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token. You can call the GetLoginToken operation to obtain the token. You can also call the UpdateToken operation to obtain the token RefreshLoginToken. Response parameter: LoginToken.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v147c9114a180489f89691663893169****', + ], + ], + [ + 'name' => 'DesktopStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer status.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Stopped'."\n" + .'* Starting.'."\n" + .'* Rebuilding'."\n" + .'* Running:.'."\n" + .'* Stopping:.'."\n" + .'* Expired'."\n" + .'* Deleted'."\n" + .'* Pending: The resource is still being prepared.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Stopped' => '', + 'Starting' => '', + 'Rebuilding' => '', + 'Running' => '', + 'Stopping' => '', + 'Expired' => '', + 'Deleted' => '', + 'Pending' => '', + ], + 'example' => 'Running', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n" + ."\n" + .'* Maximum value: 500.'."\n" + .'* and the default value is 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'eyJkZWZhdWx0IjpbIjk2MjEy****', + ], + ], + [ + 'name' => 'DesktopName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DesktopTest', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The cloud computer ID. You can specify one or more cloud computer IDs. Valid values: 1 to 20.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud computer ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-hkbl45il187d6****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'SearchRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud computers in specific regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'DesktopAccessType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The method that is used to connect cloud computers that reside in the office network from WUYING clients.'."\n" + ."\n" + .'> The VPC connection method depends on Alibaba Cloud PrivateLink. You can use PrivateLink for free. If you set this parameter to VPC or Any, the system automatically enables PrivateLink.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* INTERNET (default): End users connect to cloud computers from clients over the Internet.'."\n" + .'* VPC: End users connect to cloud computers from clients over a virtual private cloud (VPC).'."\n" + .'* Any: End users connect to cloud computers from clients over the Internet or a VPC.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INTERNET' => '', + 'VPC' => '', + 'Any' => '', + ], + 'example' => 'INTERNET', + ], + ], + [ + 'name' => 'QueryFotaUpdate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to query information about the image update.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'WithoutLatency', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to query real-time cloud computer information. The cloud computer status information in the current interface has a delay of 1 to 3 seconds. If you need accurate information, set this value to `true`.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field used for sorting. If you do not specify this option, the system is sorted in descending order of creation time.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AssignTime: sort by allocation time.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AssignTime' => '', + ], + 'example' => 'AssignTime', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ASC (default): the ascending order.'."\n" + .'* DESC: the descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '', + 'DESC' => '', + ], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword. Fuzzy search is supported for cloud computer IDs, cloud computer names, and end user custom cloud computer names.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd', + ], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the region where the office network resides. This parameter is left empty when you log on with an organization ID.'."\n" + ."\n" + .'* This parameter is required when you log on by using the office network ID.'."\n" + .'* If you log on by using an organization ID, this parameter can be left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'The token used to start the next query. If NextToken is empty, it indicates that there is no next query.'."\n", + 'type' => 'string', + 'example' => 'eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '4686A731-D601-548C-83E2-4CB6371E****', + ], + 'Desktops' => [ + 'description' => 'The details about the cloud computer.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details about the cloud computer.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the cloud computer was created.'."\n", + 'type' => 'string', + 'example' => '2020-11-06T08:28Z', + ], + 'ChargeType' => [ + 'description' => 'The billing method of the cloud computer pool.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* PostPaid: pay-as-you-go'."\n" + .'* PrePaid: subscription'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PostPaid' => '', + 'PrePaid' => '', + ], + 'example' => 'PostPaid', + ], + 'DesktopName' => [ + 'description' => 'The cloud computer name.'."\n", + 'type' => 'string', + 'example' => 'testDesktopName', + ], + 'HostName' => [ + 'description' => 'The hostname of the cloud desktop.'."\n", + 'type' => 'string', + 'example' => 'testName', + ], + 'DesktopGroupId' => [ + 'description' => 'The ID of the cloud computer share.'."\n", + 'type' => 'string', + 'example' => 'dg-3uiojcc0j4kh7****', + ], + 'DesktopId' => [ + 'description' => 'The cloud compute ID.'."\n", + 'type' => 'string', + 'example' => 'ecd-gx2x1dhsmucyy****', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'LastStartTime' => [ + 'description' => 'The time when the cloud desktop was last started.'."\n", + 'type' => 'string', + 'example' => '2021-07-13T15:59Z', + ], + 'Cpu' => [ + 'description' => 'The number of vCPUs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'EndUserId' => [ + 'description' => 'The names of end users.'."\n", + 'type' => 'string', + 'example' => 'User1', + ], + 'ExpiredTime' => [ + 'description' => 'The expiration time of the cloud computer.'."\n" + ."\n" + .'* For a cloud computer that is a package year or month, the return value is meaningful.'."\n" + .'* For pay-as-you-go cloud computers, the `2099-12-31T15:59Z` is returned.'."\n", + 'type' => 'string', + 'example' => '2021-12-31T15:59Z', + ], + 'DesktopStatus' => [ + 'description' => 'The cloud computer status.'."\n", + 'type' => 'string', + 'example' => 'Running', + ], + 'DesktopType' => [ + 'description' => 'The cloud computer type.'."\n", + 'type' => 'string', + 'example' => 'ecd.basic.large', + ], + 'ConnectionStatus' => [ + 'description' => 'The state of the endpoint connection.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Connected'."\n" + .'* Disconnecting'."\n" + .'* Pending.'."\n" + .'* Connecting.'."\n" + .'* Disconnected.'."\n" + .'* Deleting'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Connected' => '', + 'Disconnecting' => '', + 'Pending' => '', + 'Connecting' => '', + 'Disconnected' => '', + 'Deleting' => '', + ], + 'example' => 'Disconnected', + ], + 'Memory' => [ + 'description' => 'The memory of the cloud computer. Unit: MiB.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4096', + ], + 'ImageId' => [ + 'description' => 'The image ID.'."\n", + 'type' => 'string', + 'example' => 'm-4zfb6zj728hhr****', + ], + 'DirectoryId' => [ + 'description' => 'The network ID of the office. Same as `OfficeSiteId`.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37**** ', + ], + 'Disks' => [ + 'description' => 'The disks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the disk.'."\n", + 'type' => 'object', + 'properties' => [ + 'DiskType' => [ + 'description' => 'The disk type.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* SYSTEM: a system disk.'."\n" + .'* DATA: a data disk.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SYSTEM' => '', + 'DATA' => '', + ], + 'example' => 'SYSTEM', + ], + 'DiskId' => [ + 'description' => 'The disk ID.'."\n", + 'type' => 'string', + 'example' => 'd-jedbpr4sl9l37****', + ], + 'DiskSize' => [ + 'description' => 'The disk size. Unit: GiB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + ], + ], + ], + 'OsType' => [ + 'description' => 'The operating system.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Linux'."\n" + .'* Windows'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux', + 'Windows' => 'Windows', + ], + 'example' => 'Windows', + ], + 'Sessions' => [ + 'description' => 'The list of session information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the session.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndUserId' => [ + 'description' => 'End user information.'."\n", + 'type' => 'string', + 'example' => 'User1', + ], + 'EstablishmentTime' => [ + 'description' => 'The time when the session was created.'."\n", + 'type' => 'string', + 'example' => '2021-03-07T08:23Z', + ], + ], + ], + ], + 'PolicyGroupId' => [ + 'description' => 'The cloud computer policy ID.'."\n", + 'type' => 'string', + 'example' => 'pg-9cktlowtxfl6****', + ], + 'EndUserIds' => [ + 'description' => 'The list of end user.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The names of end users.'."\n", + 'type' => 'string', + 'example' => 'User1', + ], + ], + 'GpuMemory' => [ + 'description' => 'The GPU memory size. For GPU-accelerated cloud computers, this return value is significant. Unit: MB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2048', + ], + 'FotaUpdate' => [ + 'description' => 'The information about image update.'."\n", + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => 'The name of the project.'."\n", + 'type' => 'string', + 'example' => 'testProject', + ], + 'Channel' => [ + 'description' => 'Subscription Channel'."\n", + 'type' => 'string', + 'example' => 'Enterprise', + ], + 'CurrentAppVersion' => [ + 'description' => 'The current version number of the cloud computer.'."\n", + 'type' => 'string', + 'example' => '0.0.0-D-20220102.xxxx', + ], + 'NewAppVersion' => [ + 'description' => 'The version number of the application after the update.'."\n", + 'type' => 'string', + 'example' => '0.0.0-R-20220307.xxxx', + ], + 'Force' => [ + 'description' => 'Whether to force upgrade.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ReleaseNote' => [ + 'description' => 'The description of the version that can be upgraded.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Size' => [ + 'description' => 'The size of the update package for the cloud computer image. Unit: MiB.'."\n", + 'type' => 'string', + 'example' => '100', + ], + 'ReleaseNoteEn' => [ + 'description' => 'The English release note for the new image version.'."\n", + 'type' => 'string', + 'example' => 'Release note', + ], + 'ReleaseNoteJp' => [ + 'description' => 'The Japanese release note for the new image version.'."\n", + 'type' => 'string', + 'example' => 'リリースノート', + ], + 'NewDcdVersion' => [ + 'type' => 'string', + ], + ], + ], + 'ProtocolType' => [ + 'description' => 'The type of the protocol.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* High-definition Experience (HDX)'."\n" + .'* ASP'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'HDX' => '', + 'ASP' => '', + ], + 'example' => 'ASP', + ], + 'OfficeSiteId' => [ + 'description' => 'The IDs of the office networks.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-363353****', + ], + 'NetworkInterfaceIp' => [ + 'description' => 'The IP address of the ENI.'."\n", + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + 'UserCustomName' => [ + 'description' => 'The custom cloud computer name.'."\n", + 'type' => 'string', + 'example' => 'testDesktop', + ], + 'ManagementFlags' => [ + 'description' => 'The list of cloud computer status.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The management status of the cloud computer.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* UNDER_MAINTENANCE: in maintenance mode.'."\n" + .'* MIGRATING.'."\n" + .'* ASSIGNING: in the assigned user.'."\n" + .'* MIGRATING_PROTOCOL .'."\n" + .'* NO_FLAG: stateless.'."\n" + .'* ENTER_MAINTENANCE: in maintenance mode.'."\n" + .'* UPDATING.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'UNDER_MAINTENANCE' => '', + 'MIGRATING' => '', + 'ASSIGNING' => '', + 'MIGRATING_PROTOCOL' => '', + 'NO_FLAG' => '', + 'ENTER_MAINTENANCE' => '', + 'UPDATING' => '', + ], + 'example' => 'UPDATING', + ], + ], + 'LocalName' => [ + 'description' => 'The region name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'RealDesktopId' => [ + 'description' => 'If a shared cloud computer is assigned a real cloud computer, the ID of the cloud computer is displayed.'."\n", + 'type' => 'string', + 'example' => 'ecd-gx2x1dhsm****', + ], + 'DesktopTimers' => [ + 'description' => 'The cloud computer timer object.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimerType' => [ + 'description' => 'The type of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* NoOperationDisconnect: scheduled disconnection upon inactivity.'."\n" + .'* NoConnectShutdown: connectionless shutdown.'."\n" + .'* TimerBoot: scheduled start.'."\n" + .'* TimerReset: scheduled reset.'."\n" + .'* NoOperationShutdown: scheduled shutdown upon inactivity.'."\n" + .'* TimerShutdown: Stops the cloud computers on schedule.'."\n" + .'* NoOperationReboot: scheduled restart upon inactivity.'."\n" + .'* TimerReboot: scheduled restart.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'NoOperationDisconnect' => '', + 'NoConnectShutdown' => '', + 'TimerBoot' => '', + 'TimerReset' => '', + 'NoOperationShutdown' => '', + 'TimerShutdown' => '', + 'NoOperationReboot' => '', + 'TimerReboot' => '', + ], + 'example' => 'NoConnectShutdown', + ], + 'CronExpression' => [ + 'description' => 'The CRON expression for the scheduled task.'."\n" + ."\n" + .'For example, a `0 0 4 1/1 * ?` indicates that the operation is executed every day from 4:00 a.m. on the first day of each month.'."\n", + 'type' => 'string', + 'example' => '0 0 0 ? * 1', + ], + 'Interval' => [ + 'description' => 'The interval at which the monitoring data was queried. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'Enforce' => [ + 'description' => 'Indicates whether to forcibly execute the scheduled task. To `true` indicates that cloud computer and connection status detection are ignored, and scheduled tasks are forcibly executed.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResetType' => [ + 'description' => 'For a reset task, you must set the reset type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RESET_TYPE_SYSTEM: resets the system disk.'."\n" + .'* RESET_TYPE_USER_DISK: resets the data disk.'."\n" + .'* RESET_TYPE_BOTH: resets the system disk and data disk.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RESET_TYPE_SYSTEM' => '', + 'RESET_TYPE_USER_DISK' => '', + 'RESET_TYPE_BOTH' => '', + ], + 'example' => 'RESET_TYPE_BOTH', + ], + 'AllowClientSetting' => [ + 'description' => 'Whether to allow clients to set policies.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OperationType' => [ + 'description' => 'The type of the scheduled task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* HIBERNATE'."\n" + .'* SHUTDOWN'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'HIBERNATE' => '', + 'SHUTDOWN' => '', + ], + 'example' => 'SHUTDOWN', + ], + 'ExecutionTime' => [ + 'description' => 'The task duration.'."\n", + 'type' => 'string', + 'example' => '2021-12-31T15:59Z', + ], + ], + 'description' => '', + ], + ], + 'Clients' => [ + 'description' => 'The information about the supported clients.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the supported clients.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the client.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* OFF: does not allow logon.'."\n" + .'* ON: allows logon.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'OFF' => '', + 'ON' => '', + ], + 'example' => 'ON', + ], + 'ClientType' => [ + 'description' => 'The client type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* html5: the web client.'."\n" + .'* android: the Android client.'."\n" + .'* linux: Linux client.'."\n" + .'* ios: the iOS client.'."\n" + .'* windows: the Windows client.'."\n" + .'* macos: the macOS client.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'html5' => '', + 'android' => '', + 'linux' => '', + 'ios' => '', + 'windows' => '', + 'macos' => '', + ], + 'example' => 'windows', + ], + ], + ], + ], + 'SupportHibernation' => [ + 'description' => 'Indicates whether hibernation is supported.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: supported'."\n" + .'* false: not supported'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'HibernationBeta' => [ + 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SessionType' => [ + 'description' => 'The type of the session.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* SINGLE_SESSION'."\n" + .'* MULTIPLE_SESSION'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SINGLE_SESSION' => '', + 'MULTIPLE_SESSION' => '', + ], + 'example' => 'SINGLE_SESSION', + ], + 'Platform' => [ + 'description' => 'The OS platform.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* Ubuntu'."\n" + .'* UOS'."\n" + .'* CentOS'."\n" + .'* Windows Server 2019'."\n" + .'* Windows Server 2016'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Ubuntu' => 'Ubuntu', + 'UOS' => 'UOS', + 'CentOS' => 'CentOS', + 'Windows Server 2019' => 'Windows Server 2019', + 'Windows Server 2016' => 'Windows Server 2016', + ], + 'example' => 'Ubuntu', + ], + 'Os' => [ + 'description' => 'OS Type'."\n", + 'type' => 'string', + 'example' => 'Windows', + ], + 'RegionLocation' => [ + 'type' => 'string', + ], + 'OsDescription' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"eyJkZWZhdWx0IjpbIjIwMjItMDgtMTdUM****\\",\\n \\"RequestId\\": \\"4686A731-D601-548C-83E2-4CB6371E****\\",\\n \\"Desktops\\": [\\n {\\n \\"CreationTime\\": \\"2020-11-06T08:28Z\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"DesktopName\\": \\"testDesktopName\\",\\n \\"HostName\\": \\"testName\\",\\n \\"DesktopGroupId\\": \\"dg-3uiojcc0j4kh7****\\",\\n \\"DesktopId\\": \\"ecd-gx2x1dhsmucyy****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"LastStartTime\\": \\"2021-07-13T15:59Z\\",\\n \\"Cpu\\": 2,\\n \\"EndUserId\\": \\"alice\\",\\n \\"ExpiredTime\\": \\"2021-12-31T15:59Z\\",\\n \\"DesktopStatus\\": \\"Running\\",\\n \\"DesktopType\\": \\"ecd.basic.large\\",\\n \\"ConnectionStatus\\": \\"Disconnected\\",\\n \\"Memory\\": 4096,\\n \\"ImageId\\": \\"m-4zfb6zj728hhr****\\",\\n \\"DirectoryId\\": \\"cn-hangzhou+dir-jedbpr4sl9l37****\\\\t\\",\\n \\"Disks\\": [\\n {\\n \\"DiskType\\": \\"SYSTEM\\",\\n \\"DiskId\\": \\"d-jedbpr4sl9l37****\\",\\n \\"DiskSize\\": 80\\n }\\n ],\\n \\"OsType\\": \\"Windows\\",\\n \\"Sessions\\": [\\n {\\n \\"EndUserId\\": \\"alice\\",\\n \\"EstablishmentTime\\": \\"2021-03-07T08:23Z\\"\\n }\\n ],\\n \\"PolicyGroupId\\": \\"pg-9cktlowtxfl6****\\",\\n \\"EndUserIds\\": [\\n \\"alice\\"\\n ],\\n \\"GpuMemory\\": 2048,\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"testProject\\",\\n \\"Channel\\": \\"Enterprise\\",\\n \\"CurrentAppVersion\\": \\"0.0.0-D-20220102.xxxx\\",\\n \\"NewAppVersion\\": \\"0.0.0-R-20220307.xxxx\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"测试升级包03-07\\",\\n \\"Size\\": \\"100\\",\\n \\"ReleaseNoteEn\\": \\"Release note\\",\\n \\"ReleaseNoteJp\\": \\"リリースノート\\",\\n \\"NewDcdVersion\\": \\"\\"\\n },\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-363353****\\",\\n \\"NetworkInterfaceIp\\": \\"192.168.XX.XX\\",\\n \\"UserCustomName\\": \\"testDesktop\\",\\n \\"ManagementFlags\\": [\\n \\"UPDATING\\"\\n ],\\n \\"LocalName\\": \\"华东2（上海）\\",\\n \\"RealDesktopId\\": \\"ecd-gx2x1dhsm****\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"NoConnectShutdown\\",\\n \\"CronExpression\\": \\"0 0 0 ? * 1\\",\\n \\"Interval\\": 60,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_BOTH\\",\\n \\"AllowClientSetting\\": true,\\n \\"OperationType\\": \\"SHUTDOWN\\",\\n \\"ExecutionTime\\": \\"2021-12-31T15:59Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"Status\\": \\"ON\\",\\n \\"ClientType\\": \\"windows\\"\\n }\\n ],\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": true,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"Platform\\": \\"Ubuntu\\",\\n \\"Os\\": \\"Windows\\",\\n \\"RegionLocation\\": \\"\\",\\n \\"OsDescription\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeGlobalDesktops', + 'summary' => 'Queries the details of cloud computers. Currently, only the region corresponding to the Chinese mainland can be queried (excluding: Nanjing-local region-shutting down).', + 'description' => '* This API is a centralized domain name. The endpoint is in the China (Shanghai) region. You cannot call this API operation in other regions.'."\n" + .'* The cloud computer status information in this interface has a delay of 1 to 3 seconds from the actual value.'."\n", + ], + 'DescribeUserResources' => [ + 'summary' => 'Queries user resources.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169949', + 'abilityTreeNodes' => [ + 'FEATUREgwsENR35V', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client. This parameter is non-sensitive and does not need encryption.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '54c17e1d-2d72-4b87-aa33-25f3b3f2****', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* html5: the web client.'."\n" + .'* android: the Android client.'."\n" + .'* windows: the Windows client.'."\n" + .'* ios: the iOS client.'."\n" + .'* macos: the macOS client.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'html5' => '', + 'android' => '', + 'windows' => '', + 'ios' => '', + 'macos' => '', + ], + 'example' => 'windows', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端版本', + 'description' => 'The client version.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '7.6.0-R-20241112.222305', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token. You can call the `GetLoginToken` or `RefreshLoginToken` operation to retrieve the logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID. You can call the `GetLoginToken` operation to retrieve the session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'LoginRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '登录的地域ID，用于工作区ID登录场景。', + 'description' => 'The ID of the region where end users log on to clients. This parameter applies to office network ID-based logons. For organization ID-based logons, you can leave this parameter empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SearchRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the searched region. You can specify this parameter to filter cloud resources in specific regions.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'OfficeSiteIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '工作区ID列表。', + 'description' => 'The office network IDs. This parameter is required for logons by using enterprise Active Directory (AD) accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '工作区ID。', + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-5440****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源类型列表，为空则查询所有资源类型。'."\n" + .'可选范围：'."\n" + .'云桌面：Desktop'."\n" + .'桌面组：DesktopGroup'."\n" + .'云应用：App '."\n" + .'云盘：CloudDrive', + 'description' => 'The resource types. If you leave this parameter empty, resources of all supported types will be queried.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源类型', + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" + .'* Desktop: cloud computers.'."\n" + .'* DesktopGroup: cloud computer shares.'."\n" + .'* CloudDrive: enterprise drives.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'App' => '', + 'Desktop' => '', + 'DesktopGroup' => '', + 'CloudDrive' => '', + ], + 'example' => 'Desktop', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ProductTypes', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '产品类型列表，为空则查询所有产品类型。'."\n" + .'可选范围：'."\n" + .'CloudApp：云应用'."\n" + .'CloudBrowser：云浏览器'."\n" + ."\0".'AndroidCloud：云手机'."\n" + .'CloudDesktop：云电脑'."\n" + .'ImageBuilder：VHD Builder'."\n" + .'ImageValidate：VHD 验证', + 'description' => 'The service types. If you leave this parameter empty, services of all supported types will be queried.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '产品类型', + 'description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" + .'* CloudApp: App Streaming.'."\n" + .'* CloudBrowser: Cloud Browser.'."\n" + .'* AndroidCloud: Cloud Phone.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CloudDesktop' => '', + 'CloudApp' => '', + 'CloudBrowser' => '', + 'AndroidCloud' => '', + ], + 'example' => 'CloudApp', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ResourceIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源ID列表。'."\n" + .'可设置0~100个。', + 'description' => 'The resource IDs. You can specify up to 100 resource IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源ID', + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-00001', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceName', + 'in' => 'query', + 'schema' => [ + 'title' => '资源名称，支持模糊搜索。', + 'description' => 'The resource name. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'ProtocolType', + 'in' => 'query', + 'schema' => [ + 'title' => '协议类型。该参数仅用于过滤云桌面。支持范围：'."\n" + .'- HDX(HDX协议)'."\n" + .'- ASP(阿里巴巴自研ASP协议 [推荐])', + 'description' => 'The protocol type. You can specify this parameter to filter cloud computers.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* HDX: High-definition Experience (HDX).'."\n" + .'* ASP: Adaptive Streaming Protocol (ASP).'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'HDX' => '', + 'ASP' => '', + ], + 'example' => 'ASP', + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'title' => '接入类型，不传表示两种都显示。'."\n" + .'取值范围：'."\n" + .'互联网：INTERNET'."\n" + .'专线：VPC', + 'description' => 'The access type. If you leave this parameter empty, both types will be displayed.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* INTERNET: access over the Internet.'."\n" + .'* VPC: access over an enterprise virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INTERNET' => '', + 'VPC' => '', + ], + 'example' => 'INTERNET', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端语言。', + 'description' => 'The client language.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* en_US: English.'."\n" + .'* zh_CN: Simplified Chinese.'."\n" + .'* ja_JP: Japanese.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en_US' => '', + 'zh_CN' => '', + 'ja_JP' => '', + ], + 'example' => 'zh-CN', + ], + ], + [ + 'name' => 'CategoryType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源一级类目。', + 'description' => 'The level-1 resource category.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源二级类目', + 'description' => 'The level-2 resource category.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'QueryFotaUpdate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to return the image version information of cloud computers.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'RefreshFotaUpdate', + 'in' => 'query', + 'schema' => [ + 'title' => '是否实时刷新OTA信息。', + 'description' => 'Specifies whether to refresh over-the-air (OTA) information in real time.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting field. If you do not specify this parameter, resources are sorted by creation time by default.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CreateTime: the time when resources are created.'."\n" + .'* AssignTime: the time when resources are assigned.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CreateTime' => '', + 'AssignTime' => '', + ], + 'example' => 'AssignTime', + ], + ], + [ + 'name' => 'SortType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sorting method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ASC (default): the ascending order.'."\n" + .'* DESC: the descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ASC' => '', + 'DESC' => '', + ], + 'example' => 'ASC', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 500.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '500', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'caeba0bbb2be03f84eb48b699f0a4883', + ], + ], + [ + 'name' => 'AutoRefresh', + 'in' => 'query', + 'schema' => [ + 'title' => '是否主动刷新。主动刷新按钮则为true，定时刷新则为false。', + 'description' => 'Specifies whether to enable the immediate refresh feature.'."\n" + ."\n" + .'> To ensure the operation response speed, we recommend that you set the value to `false`.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* false'."\n" + .'* true'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'false' => '', + 'true' => '', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'title' => '客户端场景，用于标识排序。', + 'description' => 'The client usage scenario. Set the value to `desktop`.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* desktop: cloud computers.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'desktop' => '', + ], + 'example' => 'desktop', + ], + ], + [ + 'name' => 'DualCenterForward', + 'in' => 'query', + 'schema' => [ + 'title' => '是否双中心转发。', + 'description' => 'Specifies whether to enable geo-redundant forwarding. Set the value to `false`.'."\n" + ."\n" + .'Valid value:'."\n" + ."\n" + .'* false: disables geo-redundant forwarding.'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'enumValueTitles' => [ + 'false' => '', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'QueryDesktopTimers', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询云电脑定时任务信息，默认为true。', + 'description' => '是否查询云电脑定时任务信息，默认为true。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是，默认值', + 'false' => '否', + ], + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + 'name' => 'QueryDesktopDurationList', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询云桌面套餐包信息，默认为true。', + 'description' => '是否查询云桌面套餐包信息，默认为true。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '是，默认值', + 'false' => '否', + ], + 'example' => 'true', + 'default' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'QueryFailedResourceTypes' => [ + 'title' => '查询失败的资源类型列表。取值范围：'."\n" + .'CloudDesktop：云桌面（含云电脑和云电脑池）'."\n" + .'CloudApp：云应用'."\n" + .'CloudDrive：云盘', + 'description' => 'The resource types that failed to be queried.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The resource type that failed to be queried.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" + .'* CloudApp: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" + .'* CloudDrive: enterprise drives.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'CloudDesktop' => '', + 'CloudApp' => '', + 'CloudDrive' => '', + ], + 'example' => 'CloudDesktop', + ], + 'enumValueTitles' => [], + ], + 'Resources' => [ + 'title' => '资源详细信息列表。', + 'description' => 'The resources.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源详细信息', + 'description' => 'The resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '194101959****', + ], + 'ResourceType' => [ + 'title' => '资源类型。取值范围：'."\n" + .'云桌面：Desktop'."\n" + .'桌面组：DesktopGroup'."\n" + .'云应用：App '."\n" + .'云盘：CloudDrive', + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* App: cloud apps including App Streaming, Cloud Phone, and Cloud Browser.'."\n" + .'* Desktop: cloud computers.'."\n" + .'* DesktopGroup: cloud computer shares.'."\n" + .'* CloudDrive: enterprise drives.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'App' => '', + 'Desktop' => '', + 'DesktopGroup' => '', + 'CloudDrive' => '', + ], + 'example' => 'Desktop', + ], + 'RegionId' => [ + 'title' => '地域ID。', + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RegionLocation' => [ + 'title' => '地域位置。', + 'description' => 'The geographical location.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Mainland: regions in the Chinese mainland.'."\n" + .'* Overseas: regions outside the Chinese mainland, including China (Hong Kong).'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Mainland' => '', + 'Overseas' => '', + ], + 'example' => 'Mainland', + ], + 'ResourceGroupId' => [ + 'title' => '资源组ID。', + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'dg-0****', + ], + 'ResourceId' => [ + 'title' => '资源ID。', + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'ecd-d19tya8zi4****', + ], + 'ResourceLevel' => [ + 'title' => '资源级别。'."\n" + .'取值范围：'."\n" + .'中心：Center'."\n" + .'单元：Region', + 'description' => 'The resource level.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Center: a centralized resource.'."\n" + .'* Region: a unit resource.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Center' => '', + 'Region' => '', + ], + 'example' => 'Center', + ], + 'CenterResourceId' => [ + 'title' => '中心化资源ID。', + 'description' => 'The ID of the centralized resource.'."\n", + 'type' => 'string', + 'example' => 'ecds-0****', + ], + 'ResourceName' => [ + 'title' => '资源名称。', + 'description' => 'The resource name.'."\n", + 'type' => 'string', + 'example' => 'testName01', + ], + 'CreateTime' => [ + 'title' => '资源创建时间。', + 'description' => 'The time when the resource was created.'."\n", + 'type' => 'string', + 'example' => '2024-12-11T07:12:12Z', + ], + 'ProductType' => [ + 'title' => '产品类型。'."\n" + .'CloudDesktop - 云桌面'."\n" + .'CloudApp - 云应用'."\n" + .'AndroidCloud - 安卓云', + 'description' => 'The service type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CloudDesktop: regular cloud computers or cloud computer shares.'."\n" + .'* CloudApp: App Streaming'."\n" + .'* CloudBrowser: Cloud Browser.'."\n" + .'* AndroidCloud: Cloud Phone.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'CloudDesktop' => '', + 'CloudApp' => '', + 'CloudBrowser' => '', + 'AndroidCloud' => '', + ], + 'example' => 'AndroidCloud', + ], + 'OfficeSiteId' => [ + 'title' => '工作区ID。', + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai+dir-3367****', + ], + 'AccessType' => [ + 'title' => '接入类型。'."\n" + .'取值范围：'."\n" + .'- INTERNET(互联网)'."\n" + .'- VPC(企业专网)'."\n" + .'- ANY(互联网和企业专网均可以)', + 'description' => 'The access type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* INTERNET: access over the Internet.'."\n" + .'* VPC: access over an enterprise VPC.'."\n" + .'* ANY: access over the Internet or an enterprise VPC.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'INTERNET' => '', + 'VPC' => '', + 'ANY' => '', + ], + 'example' => 'INTERNET', + ], + 'ProtocolType' => [ + 'title' => '协议类型。取值范围：'."\n" + .'- HDX(HDX协议)'."\n" + .'- ASP(阿里巴巴自研ASP协议)', + 'description' => 'The protocol type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* HDX'."\n" + .'* ASP'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'HDX' => '', + 'ASP' => '', + ], + 'example' => 'ASP', + ], + 'OsType' => [ + 'title' => '操作系统类型。取值范围：'."\n" + .'-Windows'."\n" + .'-Linux'."\n" + .'-Android', + 'description' => 'The OS type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Linux'."\n" + .'* Windows'."\n" + .'* Android'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Linux' => 'Linux', + 'Windows' => 'Windows', + 'Android' => 'Android', + ], + 'example' => 'Windows', + ], + 'Os' => [ + 'title' => '操作系统平台信息。', + 'description' => 'The OS platform.'."\n", + 'type' => 'string', + 'example' => 'Windows Server 2022', + ], + 'OsDescription' => [ + 'title' => '操作系统平台描述信息。', + 'description' => 'The description of the OS platform.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'SupportHibernation' => [ + 'title' => '是否支持休眠。', + 'description' => 'Indicates whether hibernation is supported.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'HibernationBeta' => [ + 'description' => 'Indicates whether this is a beta version of the hibernation feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + 'SessionType' => [ + 'title' => '会话类型。SINGLE_SESSION代表单会话，MULTIPLE_SESSION代表多会话。', + 'description' => 'The session type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SINGLE_SESSION'."\n" + .'* MULTIPLE_SESSION'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SINGLE_SESSION' => '', + 'MULTIPLE_SESSION' => '', + ], + 'example' => 'SINGLE_SESSION', + ], + 'ChargeType' => [ + 'title' => '计费方式。取值范围：'."\n" + .'- PostPaid(按量付费 [默认值])'."\n" + .'- PrePaid(包年包月)', + 'description' => 'The billing method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Postpaid (default): pay-as-you-go.'."\n" + .'* PrePaid: subscription.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PostPaid' => '', + 'PrePaid' => '', + ], + 'example' => 'PrePaid', + ], + 'SubPayType' => [ + 'title' => '子计费方式。取值范围：'."\n" + .'- monthPackage(按月预付费模块)'."\n" + .'- PrePaid(时长包)', + 'description' => 'The sub-billing method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* monthPackage: monthly subscription.'."\n" + .'* PrePaid: hourly plans.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'monthPackage' => '', + 'PrePaid' => '', + ], + 'example' => 'PrePaid', + ], + 'ExpiredTime' => [ + 'title' => '包年包月付费类型资源的到期时间。', + 'description' => 'The expiration time of the subscription resource.'."\n", + 'type' => 'string', + 'example' => '2025-02-22T16:00:00Z', + ], + 'AuthMode' => [ + 'title' => '云应用授权模式。取值范围：'."\n" + .'App：应用授权'."\n" + .'Session：会话授权'."\n" + .'AppInstanceGroup：交付组授权'."\n", + 'description' => 'The authorization mode of the cloud app.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* App: authorizes access to apps.'."\n" + .'* AppInstanceGroup: authorizes access to delivery groups.'."\n" + .'* Session: authorizes access to sessions.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'App' => '', + 'AppInstanceGroup' => '', + 'Session' => '', + ], + 'example' => 'App', + ], + 'AppId' => [ + 'title' => '应用ID。', + 'description' => 'The app ID. This parameter is for apps only.'."\n", + 'type' => 'string', + 'example' => 'app-0001', + ], + 'Version' => [ + 'title' => '资源版本。', + 'description' => 'The resource version. This parameter is for apps only.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'CategoryType' => [ + 'title' => '资源一级类目。', + 'description' => 'The level-1 resource category. This parameter is for apps only.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CategoryId' => [ + 'description' => 'The level-2 resource category. This parameter is for apps only.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Icon' => [ + 'title' => '资源图标链接。', + 'description' => 'The resource icon. This parameter is for apps only.'."\n", + 'type' => 'string', + 'example' => 'http://example.com/icon.png', + ], + 'ThemeColor' => [ + 'title' => '资源主题颜色。', + 'description' => 'The theme color of the resource. This parameter is for apps only.'."\n", + 'type' => 'string', + 'example' => '#FFFFFF', + ], + 'CdsName' => [ + 'title' => '网盘名称。', + 'description' => 'The drive name. This parameter is for enterprise drives only.'."\n", + 'type' => 'string', + 'example' => 'cn-shanghai+cds-695277****', + ], + 'ExternalDomainId' => [ + 'title' => '外部Domain ID。', + 'description' => 'The ID of the external domain. This parameter is for enterprise drives only.'."\n", + 'type' => 'string', + 'example' => 'stg114510', + ], + 'ExternalUserId' => [ + 'title' => '外部用户ID。', + 'description' => 'The ID of the external user. This parameter is for enterprise drives only.'."\n", + 'type' => 'string', + 'example' => 'test001', + ], + 'GlobalStatus' => [ + 'title' => '是否支持跨地域访问。', + 'description' => 'Indicates whether cross-region access is supported. This parameter is for enterprise drives only.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'LocalName' => [ + 'title' => '地域名称。', + 'description' => 'The region name.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'DesktopTimers' => [ + 'title' => '桌面定时任务设置列表。', + 'description' => 'The scheduled tasks for cloud computers.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '桌面定时任务设置。', + 'description' => 'The scheduled task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TimerType' => [ + 'title' => '任务类型。', + 'description' => 'The task type.'."\n", + 'type' => 'string', + 'example' => 'TimerBoot', + ], + 'CronExpression' => [ + 'title' => '定时任务的Cron表达式。', + 'description' => 'The cron expression specified in the scheduled task.'."\n", + 'type' => 'string', + 'example' => '0 30 13 ? * 1-7', + ], + 'Interval' => [ + 'title' => '定时任务间隔时间。', + 'description' => 'The interval at which the scheduled task is executed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '15', + ], + 'Enforce' => [ + 'title' => '是否强制执行。', + 'description' => 'Indicates whether to forcibly execute the scheduled task.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ResetType' => [ + 'title' => '重置类型。', + 'description' => 'The reset option.'."\n", + 'type' => 'string', + 'example' => 'RESET_TYPE_SYSTEM', + ], + 'AllowClientSetting' => [ + 'title' => '是否允许客户端设置', + 'description' => 'Indicates whether to allow end users to configure scheduled tasks on clients.'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'OperationType' => [ + 'title' => '操作类型', + 'description' => 'The type of the scheduled action.'."\n", + 'type' => 'string', + 'example' => 'Hibernate', + ], + 'ExecutionTime' => [ + 'title' => '执行时间', + 'description' => 'The time when the scheduled task is executed.'."\n", + 'type' => 'string', + 'example' => '2025-01-21T11:37Z', + ], + ], + ], + ], + 'Clients' => [ + 'title' => '资源支持的客户端类型列表。', + 'description' => 'The client types supported by resources.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '资源支持的单类客户端类型设置信息。', + 'description' => 'The client type supported by resources.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClientType' => [ + 'title' => '客户端类型。', + 'description' => 'The client type.'."\n", + 'type' => 'string', + 'example' => 'windows', + ], + 'Status' => [ + 'title' => '支持状态。', + 'description' => 'The status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* OFF'."\n" + .'* ON'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'OFF' => '', + 'ON' => '', + ], + 'example' => 'ON', + ], + ], + ], + ], + 'ResourceStatus' => [ + 'title' => '资源状态。', + 'description' => 'The resource status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Unknown: The resource status is unknown.'."\n" + .'* Stopped: The resource is stopped.'."\n" + .'* Failed: The resource failed to be created.'."\n" + .'* Starting: The resource is being started.'."\n" + .'* Rebuilding: The resource is changing.'."\n" + .'* Running: The resource is running.'."\n" + .'* Stopping: The resource is being stopped.'."\n" + .'* FotaUpdating: The image is being updated.'."\n" + .'* Pending: The resource is still being prepared.'."\n" + .'* Deleting: The resource is being deleted.'."\n" + .'* Unavailable: The resource is unavailable.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Unknown' => '', + 'Stopped' => '', + 'Failed' => '', + 'Starting' => '', + 'Rebuilding' => '', + 'Running' => '', + 'Stopping' => '', + 'FotaUpdating' => '', + 'Pending' => '', + 'Deleting' => '', + 'Unavailable' => '', + ], + 'example' => 'Running', + ], + 'LastStartTime' => [ + 'title' => '资源上次启动时间。', + 'description' => 'The time when the resource was last started.'."\n", + 'type' => 'string', + 'example' => '2025-01-24T03:12:04Z', + ], + 'OrderStatus' => [ + 'title' => '订单状态。', + 'description' => 'The order status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Ceased: Your account has an overdue payment.'."\n" + .'* Released: The order is closed.'."\n" + .'* Expired: The subscription resource has expired.'."\n" + .'* Normal: The order is normal.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Ceased' => '', + 'Released' => '', + 'Expired' => '', + 'Normal' => '', + ], + 'example' => 'Normal', + ], + 'ManagementStatuses' => [ + 'title' => '管理状态列表。', + 'description' => 'The management status.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '管理状态', + 'description' => 'The management state.'."\n", + 'type' => 'string', + 'example' => 'NoFlag', + ], + ], + 'ResourceSessionStatus' => [ + 'title' => '会话状态。', + 'description' => 'The session status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Unknown'."\n" + .'* Connected'."\n" + .'* Disconnected'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Unknown' => '', + 'Connected' => '', + 'Disconnected' => '', + ], + 'example' => 'Connected', + ], + 'Sessions' => [ + 'description' => 'The sessions established between users and resources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The session established between the user and the resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'UserId' => [ + 'title' => '登录资源的用户名。', + 'description' => 'The username used to log on to the resource.'."\n", + 'type' => 'string', + 'example' => 'user001', + ], + 'UserPrincipalName' => [ + 'title' => '绑定资源的用户的UPN（如果有），只有当前查询用户的Session该值才可能有值。', + 'description' => 'The User Principal Name (UPN) of the resource-bound user (if applicable). This parameter is returned only when you query the current user\'s sessions.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ResourceSessionStartTime' => [ + 'title' => '资源会话连接的时间。', + 'description' => 'The timestamp when the resource session was established.'."\n", + 'type' => 'string', + 'example' => '2025-01-22T11:03:36Z', + ], + 'NickName' => [ + 'title' => '用户的昵称。', + 'description' => '用户的昵称。', + 'type' => 'string', + 'example' => 'user-001', + ], + ], + ], + ], + 'RealDesktopId' => [ + 'title' => '【桌面组】真实桌面ID，当桌面组存在会话时存在。', + 'description' => 'The real ID of the cloud computer (from a share). This parameter is returned only when the cloud computer share has ongoing sessions.'."\n", + 'type' => 'string', + 'example' => 'ecd-0001', + ], + 'UserCustomName' => [ + 'title' => '用户自定义名称。', + 'description' => 'The custom name of the resource.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'FotaUpdate' => [ + 'title' => '', + 'description' => 'The update info of the cloud computer.'."\n", + 'type' => 'object', + 'properties' => [ + 'Project' => [ + 'description' => 'The project name.'."\n", + 'type' => 'string', + 'example' => 'wuying-asp_single_session_desktop_win_x64', + ], + 'Channel' => [ + 'description' => 'The channel.'."\n", + 'type' => 'string', + 'example' => 'aliyun', + ], + 'CurrentAppVersion' => [ + 'description' => 'The current version number of the cloud computer\'s image.'."\n", + 'type' => 'string', + 'example' => '2.7.0-R-20250122.154826', + ], + 'NewAppVersion' => [ + 'description' => 'The target version number of the cloud computer\'s image.'."\n", + 'type' => 'string', + 'example' => '2.7.0-R-20250125.154826', + ], + 'Force' => [ + 'description' => 'Specifies whether to implement a forced update.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ReleaseNote' => [ + 'description' => 'The version description of the cloud computer\'s image.'."\n", + 'type' => 'string', + 'example' => 'up', + ], + 'Size' => [ + 'description' => 'The size of the update package for the cloud computer image. Unit: KB.'."\n", + 'type' => 'string', + 'example' => '474981930', + ], + 'ReleaseNoteEn' => [ + 'title' => '', + 'description' => 'The English release note for the new image version.'."\n", + 'type' => 'string', + 'example' => 'up', + ], + 'ReleaseNoteJp' => [ + 'description' => 'The Japanese release note for the new image version.'."\n", + 'type' => 'string', + 'example' => 'up', + ], + 'NewDcdVersion' => [ + 'description' => 'The latest version available for updating the component disk.'."\n", + 'type' => 'string', + 'example' => '2.6.9-R-20250123.153415', + ], + ], + ], + 'OsUpdate' => [ + 'description' => 'The update info of the OS.'."\n", + 'type' => 'object', + 'properties' => [ + 'CheckId' => [ + 'description' => 'The ID of the check task.'."\n", + 'type' => 'string', + 'example' => 'wua-1740652957251743***', + ], + 'PackageCount' => [ + 'description' => 'The number of packets.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Packages' => [ + 'description' => 'The patch packages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The patch package.'."\n", + 'type' => 'object', + 'properties' => [ + 'Kb' => [ + 'description' => 'The patch number.'."\n", + 'type' => 'string', + 'example' => 'KB2267***', + ], + 'Title' => [ + 'description' => 'The patch title.'."\n", + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => 'The patch description.'."\n", + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'KbListString' => [ + 'description' => 'The patch numbers.'."\n", + 'type' => 'string', + 'example' => 'KB2267***', + ], + 'UpdateCatalogUrl' => [ + 'description' => 'The update categorization URL.'."\n", + 'type' => 'string', + 'example' => 'https://catalog.update.microsoft.com/home.aspx', + ], + ], + ], + 'HasUpgrade' => [ + 'description' => 'Indicates whether an update exists.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'DesktopDurationList' => [ + 'description' => 'The cloud computer plans.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cloud computer plan.'."\n", + 'type' => 'object', + 'properties' => [ + 'PackageCreationTime' => [ + 'title' => '创建时间', + 'description' => 'The time when the package was created.'."\n", + 'type' => 'string', + 'example' => '2025-01-17T07:01Z', + ], + 'PackageStatus' => [ + 'title' => '状态。', + 'description' => 'The package status.'."\n", + 'type' => 'string', + 'example' => 'Available', + ], + 'UsedDuration' => [ + 'title' => '已使用时长', + 'description' => 'The subscription duration consumed.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16850', + ], + 'PackageExpiredTime' => [ + 'title' => '过期时间', + 'description' => 'The expiration time of the package.'."\n", + 'type' => 'string', + 'example' => '2025-02-17T15:59Z', + ], + 'PackageId' => [ + 'title' => '套餐包ID。', + 'description' => 'The package ID.'."\n", + 'type' => 'string', + 'example' => 'mdp-0bxls4qpi6bl6****', + ], + 'TotalDuration' => [ + 'title' => '总时长', + 'description' => 'The total duration.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '432000', + ], + 'PackageType' => [ + 'title' => '时长包类型'."\n" + .' * Duration：时长包'."\n" + .' * NORMAL_PACKAGE：付费包（120小时包）'."\n" + .' * POSTPAID_PACKAGE：用于记录后付费额度包（200小时包）'."\n" + .' * FREE_PACKAGE：免费包', + 'description' => 'The package type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* FREE_PACKAGE: a free package.'."\n" + .'* NORMAL_PACKAGE: a paid package (120-hour computing plan).'."\n" + .'* POSTPAID_PACKAGE: a pay-as-you-go package (200-hour computing plan).'."\n" + .'* Duration: an hourly package.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'FREE_PACKAGE' => '', + 'NORMAL_PACKAGE' => '', + 'POSTPAID_PACKAGE' => '', + 'Duration' => '', + ], + 'example' => 'NORMAL_PACKAGE', + ], + 'PeriodStartTime' => [ + 'title' => '当月包开始时间', + 'description' => 'The package\'s effective start time for the current month.'."\n", + 'type' => 'string', + 'example' => '2025-01-17T07:01Z', + ], + 'PeriodEndTime' => [ + 'title' => '当月包结束时间', + 'description' => 'The package\'s effective end time for the current month.'."\n", + 'type' => 'string', + 'example' => '2025-02-17T15:59Z', + ], + 'PostPaidLimitFee' => [ + 'title' => '第二阶段包的封顶金额'."\n" + .' * 仅ResourceType为POSTPAID_PACKAG 和 FREE_PACKAGE时会返回', + 'description' => 'The maximum fee for the package in the second phase.'."\n" + ."\n" + .'> This parameter is returned if you set ResourceType to `POSTPAID_PACKAG` or `FREE_PACKAGE`.'."\n", + 'type' => 'number', + 'format' => 'float', + 'example' => '199', + ], + 'OrderInstanceId' => [ + 'title' => '订单实例ID', + 'description' => 'The ID of the instance order.'."\n", + 'type' => 'string', + 'example' => 'mdp-0bxls4qpi6bl6****', + ], + 'PackageUsedUpStrategy' => [ + 'title' => '包用尽策略'."\n" + .' * "Postpaid" //用尽扣费'."\n" + .' * "Shutdown" //用尽关机或休眠', + 'description' => 'The policy for the cloud computer status once the monthly package quota is exhausted.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Shutdown: The cloud computer enters the Stopped or Hibernated state.'."\n" + .'* PostPaid: The cloud computer continues providing services that are billed on the pay-as-you-go basis.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Shutdown' => '', + 'Postpaid' => '', + ], + 'example' => 'Postpaid', + ], + ], + ], + ], + 'ConnectionProperties' => [ + 'title' => '连接属性，JSON格式。', + 'description' => 'The connection attributes in JSON format. The client does not need to process the attributes; they are directly passed to the resource management center when the app resource is created.'."\n", + 'type' => 'string', + 'example' => '{"authMode":"App"}', + ], + 'SupportedActions' => [ + 'title' => '支持的操作类型列表，目前只支持安卓云。', + 'description' => 'The supported actions. This parameter is returned only for cloud computers or phones.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '操作类型。', + 'description' => 'The support action.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* WakeUp: wakes up cloud computers or cloud phones.'."\n" + .'* Hibernate: hibernates cloud computers or cloud phones.'."\n" + .'* Start: starts cloud computers or cloud phones.'."\n" + .'* Stop: stops cloud computers or cloud phones.'."\n" + .'* Restart: restarts cloud computers or cloud phones.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'WakeUp' => '', + 'Hibernate' => '', + 'Start' => '', + 'Stop' => '', + 'Restart' => '', + ], + 'example' => 'Start', + ], + ], + ], + ], + ], + 'RankVersion' => [ + 'title' => '排序数据版本号。', + 'description' => 'The version number of the ranking data.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1732869815062', + ], + 'TotalCount' => [ + 'title' => '总数。', + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'MaxResults' => [ + 'title' => '返回最大数量。', + 'description' => '返回最大数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"QueryFailedResourceTypes\\": [\\n \\"CloudDesktop\\"\\n ],\\n \\"Resources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"Desktop\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"RegionLocation\\": \\"Mainland\\",\\n \\"ResourceGroupId\\": \\"dg-0****\\",\\n \\"ResourceId\\": \\"ecd-d19tya8zi4****\\",\\n \\"ResourceLevel\\": \\"Center\\",\\n \\"CenterResourceId\\": \\"ecds-0****\\",\\n \\"ResourceName\\": \\"testName01\\",\\n \\"CreateTime\\": \\"2024-12-11T07:12:12Z\\",\\n \\"ProductType\\": \\"AndroidCloud\\",\\n \\"OfficeSiteId\\": \\"cn-shanghai+dir-3367****\\",\\n \\"AccessType\\": \\"INTERNET\\",\\n \\"ProtocolType\\": \\"ASP\\",\\n \\"OsType\\": \\"Windows\\",\\n \\"Os\\": \\"Windows Server 2022\\",\\n \\"OsDescription\\": \\"Windows 正版授权\\",\\n \\"SupportHibernation\\": true,\\n \\"HibernationBeta\\": false,\\n \\"SessionType\\": \\"SINGLE_SESSION\\",\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"SubPayType\\": \\"PrePaid\\",\\n \\"ExpiredTime\\": \\"2025-02-22T16:00:00Z\\",\\n \\"AuthMode\\": \\"App\\",\\n \\"AppId\\": \\"app-0001\\",\\n \\"Version\\": \\"资源版本。\\",\\n \\"CategoryType\\": 1,\\n \\"CategoryId\\": 0,\\n \\"Icon\\": \\"http://example.com/icon.png\\",\\n \\"ThemeColor\\": \\"#FFFFFF\\",\\n \\"CdsName\\": \\"cn-shanghai+cds-695277****\\",\\n \\"ExternalDomainId\\": \\"stg114510\\",\\n \\"ExternalUserId\\": \\"test001\\",\\n \\"GlobalStatus\\": true,\\n \\"LocalName\\": \\"华东1（杭州）\\",\\n \\"DesktopTimers\\": [\\n {\\n \\"TimerType\\": \\"TimerBoot\\",\\n \\"CronExpression\\": \\"0 30 13 ? * 1-7\\",\\n \\"Interval\\": 15,\\n \\"Enforce\\": false,\\n \\"ResetType\\": \\"RESET_TYPE_SYSTEM\\",\\n \\"AllowClientSetting\\": \\"false\\",\\n \\"OperationType\\": \\"Hibernate\\",\\n \\"ExecutionTime\\": \\"2025-01-21T11:37Z\\"\\n }\\n ],\\n \\"Clients\\": [\\n {\\n \\"ClientType\\": \\"windows\\",\\n \\"Status\\": \\"ON\\"\\n }\\n ],\\n \\"ResourceStatus\\": \\"Running\\",\\n \\"LastStartTime\\": \\"2025-01-24T03:12:04Z\\",\\n \\"OrderStatus\\": \\"Normal\\",\\n \\"ManagementStatuses\\": [\\n \\"NoFlag\\"\\n ],\\n \\"ResourceSessionStatus\\": \\"Connected\\",\\n \\"Sessions\\": [\\n {\\n \\"UserId\\": \\"user001\\",\\n \\"UserPrincipalName\\": \\"[email protected]\\",\\n \\"ResourceSessionStartTime\\": \\"2025-01-22T11:03:36Z\\",\\n \\"NickName\\": \\"user-001\\"\\n }\\n ],\\n \\"RealDesktopId\\": \\"ecd-0001\\",\\n \\"UserCustomName\\": \\"我的云电脑\\",\\n \\"FotaUpdate\\": {\\n \\"Project\\": \\"wuying-asp_single_session_desktop_win_x64\\",\\n \\"Channel\\": \\"aliyun\\",\\n \\"CurrentAppVersion\\": \\"2.7.0-R-20250122.154826\\",\\n \\"NewAppVersion\\": \\"2.7.0-R-20250125.154826\\",\\n \\"Force\\": false,\\n \\"ReleaseNote\\": \\"新版本\\",\\n \\"Size\\": \\"474981930\\",\\n \\"ReleaseNoteEn\\": \\"new version\\",\\n \\"ReleaseNoteJp\\": \\"新バージョン\\",\\n \\"NewDcdVersion\\": \\"2.6.9-R-20250123.153415\\"\\n },\\n \\"OsUpdate\\": {\\n \\"CheckId\\": \\"wua-1740652957251743***\\",\\n \\"PackageCount\\": 1,\\n \\"Packages\\": [\\n {\\n \\"Kb\\": \\"KB2267***\\",\\n \\"Title\\": \\"用于****的补丁。\\",\\n \\"Description\\": \\"安装此更新可修改用于检测病毒、间谍软件和其他潜在不需要的软件的文件。此项一旦安装，便无法删除。\\"\\n }\\n ],\\n \\"KbListString\\": \\"KB2267***\\",\\n \\"UpdateCatalogUrl\\": \\"https://catalog.update.microsoft.com/home.aspx\\"\\n },\\n \\"HasUpgrade\\": true,\\n \\"DesktopDurationList\\": [\\n {\\n \\"PackageCreationTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PackageStatus\\": \\"Available\\",\\n \\"UsedDuration\\": 16850,\\n \\"PackageExpiredTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PackageId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"TotalDuration\\": 432000,\\n \\"PackageType\\": \\"NORMAL_PACKAGE\\",\\n \\"PeriodStartTime\\": \\"2025-01-17T07:01Z\\",\\n \\"PeriodEndTime\\": \\"2025-02-17T15:59Z\\",\\n \\"PostPaidLimitFee\\": 199,\\n \\"OrderInstanceId\\": \\"mdp-0bxls4qpi6bl6****\\",\\n \\"PackageUsedUpStrategy\\": \\"Postpaid\\"\\n }\\n ],\\n \\"ConnectionProperties\\": \\"{\\\\\\"authMode\\\\\\":\\\\\\"App\\\\\\"}\\",\\n \\"SupportedActions\\": [\\n \\"Start\\"\\n ]\\n }\\n ],\\n \\"RankVersion\\": 1732869815062,\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 100\\n}","type":"json"}]', + 'title' => 'DescribeUserResources', + 'description' => 'Before you call this operation, verify supported resource and service types in Alibaba Cloud Workspace.'."\n", + 'responseParamsDescription' => 'This response parameter is not available for all resources. Ensure you know the fields for each resource.'."\n", + ], + 'UnbindUserDesktop' => [ + 'summary' => 'Unbinds end users from cloud computers.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'v12307f5e0****', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'windows', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '58f96f67-7944-4f97-9342-****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '3b053331-dc98-43d8-b247-****', + ], + ], + [ + 'name' => 'UserDesktopId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ud-sdfs****', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable forced unbinding.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true: Even when end users connect to cloud computers, the forced unbinding is still enforced.'."\n" + .'* false: Forced unbinding is only enforced when end users are disconnected from cloud computers.'."\n", + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5B7CF35-E078-5EBF-A010-****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5B7CF35-E078-5EBF-A010-****\\"\\n}","type":"json"}]', + 'title' => 'UnbindUserDesktop', + ], + 'GetConnectionTicket' => [ + 'summary' => 'Retrieves the credential that is used to connect to a cloud computer.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the cloud computer connection task.\\'."\n" + .'The first time you call the GetConnectionTicket operation, you do not need to configure this parameter. When you call the GetConnectionTicket operation later, set this parameter to the value of the `TaskId` parameter returned from the previous invocation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud compute ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-gx2x1dhsmucyy****', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.18363 x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0-R-20210731.151756', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the client.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* html5: web client'."\n" + .'* Linux: self-developed hardware terminal'."\n" + .'* android: Android client'."\n" + .'* windows: Windows client'."\n" + .'* ios: iOS client'."\n" + .'* macos: macOS client'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'html5' => '', + 'linux' => '', + 'android' => '', + 'windows' => '', + 'ios' => '', + 'macos' => '', + ], + 'example' => 'windows', + ], + ], + [ + 'name' => 'CommandContent', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '乐播需求，获取Tickek成功后自动在session里启动乐播应用。', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "startApplication": {'."\n" + .' "startApplicationList": ['."\n" + .' {'."\n" + .' "sessionName": "",'."\n" + .' "appList": ['."\n" + .' {'."\n" + .' "appPath": "C:\\\\Program Files\\\\Google\\\\Chrome\\\\Application\\\\chrome.exe",'."\n" + .' "appParameter": "www.example.com www.example1.com"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', + 'maxLength' => 1024000, + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '28c80e90-f71e-4c23-93d6-1225329cf949', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tags. You can specify 1 to 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key. If you specify the `Tag` parameter, you must also specify the `Key` parameter. The tag key can be up to 128 characters in length and cannot contain `http://` or `https://`. The tag key cannot start with `acs:` or `aliyun` and contain only spaces.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The tag value. You can specify an empty string as a tag value. A tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 20, + ], + ], + [ + 'name' => 'AccessType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TicketBlackList', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'FAILED' => '', + 'RUNNING' => '', + 'FINISHED' => '', + ], + 'example' => 'FINISHED', + ], + 'Ticket' => [ + 'description' => 'The credentials for connecting to the cloud computer.'."\n", + 'type' => 'string', + 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', + ], + 'TaskId' => [ + 'description' => 'The ID of the task to connect to the cloud computer.'."\n", + 'type' => 'string', + 'example' => '2afbad19-778a-4fc5-9674-1f19c63862da', + ], + 'TaskCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********', + ], + 'TaskMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2afbad19-778a-4fc5-9674-1f19c638****', + ], + 'P2PToken' => [ + 'type' => 'string', + ], + 'DesktopId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DesktopMemoryHighLoad%s', + 'errorMessage' => 'The specified desktop memory high load.', + ], + [ + 'errorCode' => 'DesktopCpuHighLoad%s', + 'errorMessage' => 'The specified desktop cpu high load.', + ], + [ + 'errorCode' => 'InvalidClientIp.Policy', + 'errorMessage' => 'Client ip %s is not in white list.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"TaskStatus\\": \\"FINISHED\\",\\n \\"Ticket\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskId\\": \\"2afbad19-778a-4fc5-9674-1f19c63862da\\",\\n \\"TaskCode\\": \\"W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********\\",\\n \\"TaskMessage\\": \\"2afbad19-778a-4fc5-9674-1f19c638****\\",\\n \\"P2PToken\\": \\"\\",\\n \\"DesktopId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetConnectionTicketResponse>\\n <Ticket>W0VuY29kaW5nXQ0KSW5wdXRFbmNvZGluZz1V********</Ticket>\\n <TaskId>2afbad19-778a-4fc5-9674-1f19c63862da</TaskId>\\n <RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>\\n <TaskStatus>Finished</TaskStatus>\\n</GetConnectionTicketResponse>","errorExample":""}]', + 'title' => 'GetConnectionTicket', + 'description' => 'The first time you call this operation, the system returns a task ID in the `TaskID` parameter. Use the task ID indicated in the `TaskID` parameter to continue calling this operation until the value of the `TaskStatus` parameter becomes `FINISHED` or `FAILED`. When `TaskStatus` becomes `FINISHED`, the value of the `Ticket` parameter is the ticket that is used to connect the client to the cloud computer.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StartDesktops' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client). The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system (OS) of the device that run the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.18363 x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client version. If you use a WUYING client, you can click **About** on the client logon page to view the version of the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => ' 2.1.0-R-20210731.151756', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cloud computer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-cg27ufmapab08****', + ], + 'required' => true, + 'example' => 'ecd-cg27ufmapab08****', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '21e7be12-aa4f-4389-b3e1-82f4a1b5****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '71F6A700735E74A61161A53F0C47****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameter.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StartDesktopsResponse>","errorExample":""}]', + 'title' => 'StartDesktops', + 'summary' => 'Start cloud computers.', + 'description' => 'The cloud computers that you want to start must be in the Stopped state. After you call this operation, the cloud computers enter the Running state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopDesktops' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.18363 x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0-R-20210731.151756', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cloud computer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-7w78ozhjcwa3u**** ', + ], + 'required' => true, + 'example' => 'ecd-7w78ozhjcwa3u**** ', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '6ce412a8-399f-49f9-9518-66ee028a****', + ], + ], + [ + 'name' => 'SessionToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', + ], + ], + [ + 'name' => 'OsUpdate', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</StopDesktopsResponse>","errorExample":""}]', + 'title' => 'StopDesktops', + 'summary' => 'Stops cloud computers.', + 'description' => 'The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped state.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RebootDesktops' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by WUYING Workspace.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.18363 x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client version. If you use a WUYING client, you can view the client version in the **About** dialog box on the client logon page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0-R-20210731.151756', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the cloud computer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-7w78ozhjcwa3u****', + ], + 'required' => true, + 'example' => 'ecd-7w78ozhjcwa3u**** ', + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How do I ensure the idempotence of a request?](~~25693~~)'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '40401e62-5caf-4508-8de7-bf98af12****', + ], + ], + [ + 'name' => 'SessionToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The UUID of the client.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '91761ED27169E2FC564F29388E2D****', + ], + ], + [ + 'name' => 'OsUpdate', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","errorExample":""},{"type":"xml","example":"<RebootDesktopsResponse>\\r\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>\\r\\n</RebootDesktopsResponse>","errorExample":""}]', + 'title' => 'RebootDesktops', + 'summary' => 'Restart cloud computers.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ReportSessionStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i-bp167fcodoa90ixn****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2', + ], + ], + [ + 'name' => 'SessionStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'SessionLogOff' => '', + 'DesktopTimerDisconnection' => '', + 'SessionReboot' => '', + 'DesktopTimerShutdown' => '', + 'SessionLock' => '', + 'SessionShutdown' => '', + 'SessionUnLock' => '', + 'DesktopTimerReboot' => '', + 'ConsoleConnect' => '', + 'SessionLogOn' => '', + 'SessionPopup' => '', + 'SessionDisconnect' => '', + 'ConsoleDisconnect' => '', + ], + 'example' => 'SessionLogOn', + ], + ], + [ + 'name' => 'SessionChangeTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1642909143781', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'liming', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0EE5DE20-25F4-5870-9D56-C259A45B****', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EE5DE20-25F4-5870-9D56-C259A45B****\\"\\n}","type":"json"}]', + 'title' => 'ReportSessionStatus', + 'summary' => 'Reports session status.', + ], + 'ApproveFotaUpdate' => [ + 'summary' => 'Enables OTA updates for cloud computers.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd4452bd7-88df-4b90-a409-806da674****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '4771b873-c757-4893-973c-7f5beejh****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18390c954ce59e2915ef16663205371721e0db9a46179ac89249a203320459523cb54ad08efe324784dd0eba25950****', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-138dsptkrt00u****', + ], + ], + [ + 'name' => 'AppVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The application version.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.0.1-D-20220513.14****', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client. To view the unique identifier of an Alibaba Cloud Workspace client, go to the client logon page and click on "About."'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28c80e90-f71e-4c23-93d6-1225329c****', + ], + ], + [ + 'name' => 'TargetStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the cloud computer after the OTA update.'."\n" + ."\n" + .'> This parameter is not publicly available. After the OTA update is complete, the state of the cloud computer changes to `RUNNING`.'."\n" + ."\n" + .'* Set the value to running.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'running' => '', + ], + 'example' => 'running', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ApproveFotaUpdate', + ], + 'DescribeSnapshots' => [ + 'summary' => 'Queries the snapshots that are created based on a cloud computer and the details of the snapshots.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-gx2x1dhsmucyy****', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The snapshot ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 's-2ze81owrnv9pity4****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '16dad2b6-3c6d-4e4c-b057-78ecb13c****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'a99b9aca-bac5-4da2-819e-400ce98f****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v16abfb945208fc5745061668654680853da4a25202d1a394fcad57bba484e9827ad43ea7d10fb6bf13d44a4adc0e9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => [ + 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '51592A88-0F2C-55E6-AD2C-2AD9C10D****', + ], + 'Snapshots' => [ + 'description' => 'The snapshots.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => 'The time when the snapshot was created. The time follows the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2020-12-20T14:52:28Z', + ], + 'Status' => [ + 'description' => 'The snapshot status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PROGRESSING: The snapshot is being created.'."\n" + .'* FAILED: The snapshot failed to be created.'."\n" + .'* ACCOMPLISHED: The snapshot is created.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PROGRESSING' => '', + 'FAILED' => '', + 'ACCOMPLISHED' => '', + ], + 'example' => 'ACCOMPLISHED', + ], + 'SnapshotType' => [ + 'description' => 'The snapshot type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* AUTO: an automatic snapshot.'."\n" + .'* USER: a manual snapshot.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'AUTO' => '', + 'USER' => '', + ], + 'example' => 'USER', + ], + 'SnapshotName' => [ + 'description' => 'The snapshot name.'."\n", + 'type' => 'string', + 'example' => 'testSnapshotName', + ], + 'Progress' => [ + 'description' => 'The progress of creating the cloud computer.'."\n", + 'type' => 'string', + 'example' => '100%', + ], + 'Description' => [ + 'description' => 'The snapshot description.'."\n", + 'type' => 'string', + 'example' => 'testDescription', + ], + 'SnapshotId' => [ + 'description' => 'The snapshot ID.'."\n", + 'type' => 'string', + 'example' => 's-2zeipxmnhej803x7****', + ], + 'RemainTime' => [ + 'description' => 'The remaining time required to complete snapshot creation. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'SourceDiskSize' => [ + 'description' => 'The size of the source disk. Unit: GiB.'."\n", + 'type' => 'string', + 'example' => '150', + ], + 'SourceDiskType' => [ + 'description' => 'The type of the source disk.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* SYSTEM: a system disk.'."\n" + .'* DATA: a data disk.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'SYSTEM' => '', + 'DATA' => '', + ], + 'example' => 'SYSTEM', + ], + 'DesktopId' => [ + 'description' => 'The ID of the cloud computer to which the snapshot belongs.'."\n", + 'type' => 'string', + 'example' => 'ecd-g03l3tlm8djoj****', + ], + 'RestorePointId' => [ + 'description' => 'The ID of the restore point.'."\n", + 'type' => 'string', + 'example' => 'rp-btgmaa20wkcju****', + ], + 'RestorePointName' => [ + 'description' => 'The name of the restore point.'."\n", + 'type' => 'string', + 'example' => 'Data Disk Backup'."\n", + ], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAV3MpHK1AP0pfERHZN5pu6nmB7qrRFJ8vmttjxPL****\\",\\n \\"RequestId\\": \\"51592A88-0F2C-55E6-AD2C-2AD9C10D****\\",\\n \\"Snapshots\\": [\\n {\\n \\"CreationTime\\": \\"2020-12-20T14:52:28Z\\",\\n \\"Status\\": \\"ACCOMPLISHED\\",\\n \\"SnapshotType\\": \\"USER\\",\\n \\"SnapshotName\\": \\"testSnapshotName\\",\\n \\"Progress\\": \\"100%\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"SnapshotId\\": \\"s-2zeipxmnhej803x7****\\",\\n \\"RemainTime\\": 30,\\n \\"SourceDiskSize\\": \\"150\\",\\n \\"SourceDiskType\\": \\"SYSTEM\\",\\n \\"DesktopId\\": \\"ecd-g03l3tlm8djoj****\\",\\n \\"RestorePointId\\": \\"rp-btgmaa20wkcju****\\",\\n \\"RestorePointName\\": \\"数据盘备份\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeSnapshots', + ], + 'ResetSnapshot' => [ + 'summary' => 'Restores the data of a disk from a snapshot.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SnapshotId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The snapshot ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 's-2zeipxmnhej803x7****', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b9d8ddfd-65d4-4857-9e97-56477d1f****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '05182b8c-bb0d-49d3-963c-ee63a507****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v1fdef51b727aa91d6c881658978508114d3f5680fa99a66b2a631d17d5bb4860cccf1173be24d77d5ef1423c83aea****', + ], + ], + [ + 'name' => 'DesktopId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cloud computer ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ecd-e964cr92klwqb****', + ], + ], + [ + 'name' => 'StopDesktop', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to stop the cloud computer.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\"\\n}","type":"json"}]', + 'title' => 'ResetSnapshot', + ], + 'GetCloudDriveServiceMountToken' => [ + 'summary' => 'Retrieves the logon tokens for enterprise drives.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'v1972cd3446f0e523598916520951742474e6624fcdea6652994d47bc6157d27f7cc900c339db67882j3no4nh5bk3b4****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '14e1fe41-ce9b-491d-aa8c-345jk2n4bk****', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '00e122c3-13fb-4fc3-bc7a-5d9acb89****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-7186763****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'DC27288A-F9E1-5092-9B5B-71C27D15****', + ], + 'Token' => [ + 'description' => 'The tokens.'."\n", + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => 'The token.'."\n", + 'type' => 'string', + 'example' => '7836fa6eced7dc8d54c775k34iu3h4i2kh534f****', + ], + 'ExpiredAfter' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-10-10T04:41:35Z', + ], + 'UsedSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '605089', + ], + 'TotalSize' => [ + 'description' => 'The total capacity of the enterprise drive. Unit: GiB'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6050416754750', + ], + 'DomainId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'h****', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'disabled' => '', + 'enabled' => '', + ], + 'example' => 'enabled', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DC27288A-F9E1-5092-9B5B-71C27D15****\\",\\n \\"Token\\": {\\n \\"Token\\": \\"7836fa6eced7dc8d54c775k34iu3h4i2kh534f****\\",\\n \\"ExpiredAfter\\": \\"2022-10-10T04:41:35Z\\",\\n \\"UsedSize\\": 605089,\\n \\"TotalSize\\": 6050416754750,\\n \\"DomainId\\": \\"h****\\",\\n \\"Status\\": \\"enabled\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetCloudDriveServiceMountToken', + ], + 'VerifyCredential' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'd0b95762-0541-4b53-a0e4-7ed09f39****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai+dir-227468****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'eb17af2e-1dd6-4cc4-a3ee-3a14d0d7****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v1f5772a1c60dbea9fd8e1648567079018086448d234b5bc8e30bec0ba6e80c41c767c4dd0db51e9e5c4e0f111431a****', + ], + ], + [ + 'name' => 'CredentialType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the logon credential that you want to clear.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MfaPasscode: the multi-factor verification code.'."\n" + .'* FingerPrint: the fingerprint.'."\n" + .'* Password: the password.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [ + 'MfaPasscode' => '', + 'FingerPrint' => '', + 'Password' => '', + ], + 'example' => 'Password', + ], + ], + [ + 'name' => 'Credential', + 'in' => 'query', + 'schema' => [ + 'description' => 'The credential.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456789cyG', + ], + ], + [ + 'name' => 'EncryptedKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the key that you want to encrypt.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drjfs****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D5F0BDFB-A229-5F1D-B790-33709D43****', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5F0BDFB-A229-5F1D-B790-33709D43****\\"\\n}","type":"json"}]', + 'title' => 'VerifyCredential', + 'summary' => 'Validates credentials to lock on-premises sessions on clients.', + ], + 'GetLoginToken' => [ + 'summary' => 'Obtains logon credentials.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the regions supported by EDS.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud Workspace client. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID. This parameter has the same meaning as `OfficeSiteId`. We recommend that you replace `DirectoryId` with `OfficeSiteId`. You can specify a value for `DirectoryId` or `OfficeSiteId`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou+dir-885351****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou+dir-885351****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the session.'."\n" + ."\n" + .'* If the virtual multi-factor authentication (MFA) device is not bound or two-factor authentication is not enabled for the client, you do not need to specify a value for `SessionId`.'."\n" + .'* If the virtual MFA device is not bound or two-factor authentication is enabled for the client, you must specify a value for `SessionId` to verify the user identity after you specify a value for `ADPassword`. The value of the `SessionId` parameter is returned only if the CurrentStage parameter is set to `ADPassword` when you call the `GetLoginToken` operation.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'CurrentStage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon authentication stage. Valid values:'."\n" + ."\n" + .'* `ADPassword`: the stage to verify the identity of the Active Directory (AD) user. You must specify the value when the system verifies the identity of a convenience account or an AD account.'."\n" + .'* `MFABind: the stage to bind a virtual multi-factor authentication (MFA) device.`'."\n" + .'* `MFAVerify: the stage to verify the verification code that is generated by the virtual MFA device.`'."\n" + .'* `TokenVerify`: the stage to perform two-factor authentication on an Alibaba Cloud Workspace client (hereinafter referred to as the client).'."\n" + .'* `ChangePassword`: the stage to change the password of the user.'."\n" + .'* `KeepAliveVerify`: the stage to obtain LoginToken if KeepAliveToken is valid.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'ADPassword', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'alice', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the convenience user or the AD user. This parameter is required if you set `CurrentStage` to `ADPassword`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Password1234', + ], + ], + [ + 'name' => 'OldPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'OldPassword', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password. This parameter is required if you set `CurrentStage` to `ChangePassword`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'NewPassword', + ], + ], + [ + 'name' => 'AuthenticationCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The verification code that is generated by the virtual MFA device. This parameter is required if you set `CurrentStage` to `MFAVerify`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '47****', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system (OS) of the device that runs an Alibaba Cloud Workspace client.', + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.1**** x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The version of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0-R-20210731.1****', + ], + ], + [ + 'name' => 'TokenCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'If two-factor authentication is enabled for Alibaba Cloud Workspace terminals in the EDS console and the system detects that the current logon user is exposed to risks, the system sends a verification code to the email address of the user. This parameter is required if you set `CurrentStage` to `TokenVerify`.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '63****', + ], + ], + [ + 'name' => 'KeepAlive', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to keep the user logged on to the client. '."\n" + .'Valid values:'."\n" + .'* null: Default value. Do not keep the user logged on to the client.'."\n" + .'* true: Keep the user logged on to the client.'."\n" + .'* false: Do not keep the user logged on to the client.', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'null' => '', + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'KeepAliveToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token to keep logging on to an Alibaba Cloud Workspace client. When an end user logs on to the Alibaba Cloud Workspace client and select Auto Sign-in, `KeepAliveToken` is returned after you call this operation. Within the valid period of the returned token``, you can call the `GetLoginToken` operation and set `CurrentStage` to `KeepAliveVerify`. Then, you can obtain LoginToken. If you set `CurrentStage` to `KeepAliveVerify`, `KeepAliveToken` is required.', + 'type' => 'string', + 'required' => false, + 'example' => 'hide', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'The unique identifier of the client. When you use an Alibaba Cloud Workspace client, you can view the client version in the **About** dialog box on the client logon page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'C78CA9E99315687575DD2844C1F3****', + ], + ], + [ + 'name' => 'ClientType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of Alibaba Cloud Workspace clients.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* HTML5: web client.'."\n" + ."\n" + .'* WINDOWS: Windows client.'."\n" + ."\n" + .'* MACOS: macOS client.'."\n" + ."\n" + .'* IOS: iOS client.'."\n" + ."\n" + .'* ANDROID: Android client.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'HTML5' => 'HTML5', + 'WINDOWS' => 'WINDOWS', + 'MACOS' => 'MACOS', + 'IOS' => 'IOS', + 'ANDROID' => 'ANDROID', + ], + 'example' => 'Windows', + ], + ], + [ + 'name' => 'AvailableFeatures', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + [ + 'name' => 'ClientName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Email' => [ + 'description' => 'The email address of the user. The system returns the email address in the return value of the LoginToken parameter after the user logs on to the client.'."\n" + ."\n" + .'* For a convenience user, the return value is the email address specified when the administrator creates the convenience user.'."\n" + .'* For an AD user, the return value is in the following format: `Username@Name of the AD domain`.'."\n", + 'type' => 'string', + 'example' => 'alice', + ], + 'Secret' => [ + 'description' => 'The key that is generated when you bind the virtual MFA device. This parameter is required when the CurrentStage parameter is set to `MFABind`.'."\n" + ."\n" + .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", + 'type' => 'string', + 'example' => '5OCLLKKOJU5HPBX66H3QCTWYI7MH****', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'EndUserId' => [ + 'description' => 'The account of the convenience user or the AD user.'."\n", + 'type' => 'string', + 'example' => 'alice', + ], + 'LoginToken' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + 'NextStage' => [ + 'description' => 'The next stage that is expected to enter. For example, an administrator enables MFA in the EDS console. When an end user enters the password, that is, the end user completes the `ADPassword` stage, this parameter returns `MFAVerify`. This indicates that MFA is required.'."\n" + ."\n" + .'> For more information about the authentication stages, see the `CurrentStage` parameter.', + 'type' => 'string', + 'example' => 'MFAVerify', + ], + 'QrCodePng' => [ + 'description' => 'The QR code that is generated when the virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty. This parameter is required only when the CurrentStage parameter is set to `MFABind`.'."\n" + ."\n" + .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", + 'type' => 'string', + 'example' => '5OCLLKKOJU5HPBX66H3QCTWY******', + ], + 'Label' => [ + 'description' => 'The attribute of the convenience user. For an AD user, null is returned.'."\n", + 'type' => 'string', + 'example' => 'test:sample', + ], + 'SessionId' => [ + 'description' => 'The ID of the session. The ID is returned the first time you call the `GetLoginToken` operation in the session. If MFA is required, you must specify this parameter in subsequent stages.'."\n" + ."\n" + .'> For more information about each authentication stage, see the parameter description of the request parameter `CurrentStage`.'."\n", + 'type' => 'string', + 'example' => 'd6ec166d-ab93-4286-bf7f-a18bb929****', + ], + 'Phone' => [ + 'description' => 'Enter the mobile number of the convenience user. For an AD user, null is returned.'."\n", + 'type' => 'string', + 'example' => '1381111****', + ], + 'TenantId' => [ + 'description' => 'The ID of the Alibaba Cloud account. The ID is used for hardware client authentication.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '166353906220****', + ], + 'KeepAliveToken' => [ + 'description' => 'The token used to keep the user logged on. After the user logs on to the client and select the Keep Logon option, `KeepAliveToken` is returned when you call the operation. If the user does not select the Keep Logon option, null is returned.'."\n", + 'type' => 'string', + 'example' => '006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW', + ], + 'Industry' => [ + 'description' => '> This is a parameter only for internal use.'."\n", + 'type' => 'string', + 'example' => 'edu', + ], + 'Props' => [ + 'description' => '> This is a parameter only for internal use.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '> This is a parameter only for internal use.'."\n", + 'example' => '{\'dingUserName\': u\'\\u674e\\u66fc\', \'role\': \'student\'}', + ], + ], + 'WindowDisplayMode' => [ + 'description' => '> This is a parameter only for internal use.'."\n", + 'type' => 'string', + 'example' => 'mode', + ], + 'RiskVerifyInfo' => [ + 'description' => 'Risk identification information regarding the signin process.', + 'type' => 'object', + 'properties' => [ + 'Email' => [ + 'description' => 'The email used for authentication.', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'LastLockDuration' => [ + 'description' => 'The duration of the lock.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1713749778', + ], + 'Locked' => [ + 'description' => 'Whether the account is locked or not.', + 'type' => 'string', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + 'Phone' => [ + 'description' => 'The mobile number used for authentication.', + 'type' => 'string', + 'example' => '1388888****', + ], + ], + ], + 'Reason' => [ + 'description' => '> This is a parameter only for internal use.', + 'type' => 'string', + 'example' => 'null', + ], + 'PasswordStrategy' => [ + 'description' => '> This is a parameter only for internal use.', + 'type' => 'object', + 'properties' => [ + 'TenantPasswordLength' => [ + 'description' => '> This is a parameter only for internal use.', + 'type' => 'string', + 'example' => 'null', + ], + 'TenantAlternativeChars' => [ + 'description' => '> This is a parameter only for internal use.', + 'type' => 'array', + 'items' => [ + 'description' => '> This is a parameter only for internal use.', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + 'NickName' => [ + 'type' => 'string', + ], + 'WyId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"alice\\",\\n \\"Secret\\": \\"5OCLLKKOJU5HPBX66H3QCTWYI7MH****\\",\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\",\\n \\"NextStage\\": \\"MFAVerify\\",\\n \\"QrCodePng\\": \\"5OCLLKKOJU5HPBX66H3QCTWY******\\",\\n \\"Label\\": \\"test:wuying\\",\\n \\"SessionId\\": \\"d6ec166d-ab93-4286-bf7f-a18bb929****\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"TenantId\\": 0,\\n \\"KeepAliveToken\\": \\"006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW\\",\\n \\"Industry\\": \\"edu\\",\\n \\"Props\\": {\\n \\"key\\": \\"{\'dingUserName\': u\'\\\\\\\\u674e\\\\\\\\u66fc\', \'role\': \'student\'}\\"\\n },\\n \\"WindowDisplayMode\\": \\"mode\\",\\n \\"RiskVerifyInfo\\": {\\n \\"Email\\": \\"[email protected]\\",\\n \\"LastLockDuration\\": 1713749778,\\n \\"Locked\\": \\"true\\",\\n \\"Phone\\": \\"1381111****\\"\\n },\\n \\"Reason\\": \\"null\\",\\n \\"PasswordStrategy\\": {\\n \\"TenantPasswordLength\\": \\"null\\",\\n \\"TenantAlternativeChars\\": [\\n \\"null\\"\\n ]\\n },\\n \\"NickName\\": \\"\\",\\n \\"WyId\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<GetLoginTokenResponse>\\n <Email>alice</Email>\\n <Secret>5OCLLKKOJU5HPBX66H3QCTWYI7MH****</Secret>\\n <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5F****</RequestId>\\n <EndUserId>alice</EndUserId>\\n <LoginToken>v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****</LoginToken>\\n <NextStage>MFAVerify</NextStage>\\n <QrCodePng>5OCLLKKOJU5HPBX66H3QCTWY******</QrCodePng>\\n <Label>test:wuying</Label>\\n <SessionId>d6ec166d-ab93-4286-bf7f-a18bb929****</SessionId>\\n <Phone>1381111****</Phone>\\n <KeepAliveToken>006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW</KeepAliveToken>\\n <Industry>edu</Industry>\\n <Props>\\n <key>{\'dingUserName\': u\'\\\\u674e\\\\u66fc\', \'role\': \'student\'}</key>\\n </Props>\\n</GetLoginTokenResponse>","errorExample":""}]', + 'title' => 'GetLoginToken', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'RefreshLoginToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-hangzhou+dir-jedbpr4sl9l37****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-shanghai+dir-238191****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'alice', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****', + ], + 'LoginToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\",\\n \\"LoginToken\\": \\"v1c27bab6c205b2fdfac916434306375722776d6aa89e30b7836d18c95ade9137f0f5ac4325260782184e96ee2b3f0****\\"\\n}","errorExample":""},{"type":"xml","example":"<RefreshLoginTokenResponse>\\r\\n <RequestId>FE379906-08A4-5893-9C18-77C32566D944</RequestId>\\r\\n</RefreshLoginTokenResponse>","errorExample":""}]', + 'title' => 'RefreshLoginToken', + 'summary' => 'Refreshes a logon token.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendTokenCode' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-2925105532', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'v28101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cd45e873-650d-4d70-acb9-f996187a****', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'alice', + ], + ], + [ + 'name' => 'ClientOS', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operating system on which the client runs.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Windows_NT 10.0.18363 x64', + ], + ], + [ + 'name' => 'ClientVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client version. If you use an Alibaba Cloud Workspace client, you can view the client version in the "About" dialog box on the client logon page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2.1.0-R-20210731.151756', + ], + ], + [ + 'name' => 'TokenCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'If two-factor authentication is enabled for clients in the Elastic Desktop Service (EDS) Enterprise console, the system will send a verification code to the user\'s email address if it detects that the current logged-on user is at risk. This parameter is required if you set `CurrentStage` to `TokenVerify`.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '63****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****'."\n", + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\\\n\\"\\n}","type":"json"}]', + 'title' => 'SendTokenCode', + 'summary' => 'Sends a logon verification code.', + ], + 'ChangePassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '42f6645a-9c3c-4772-be2a-cc5f5732****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai+dir-227468****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'liming', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + [ + 'name' => 'OldPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The current password.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12345678', + ], + ], + [ + 'name' => 'NewPassword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new password.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '67436290', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '484256DA-D816-44D2-9D86-B6EE4D5B****', + ], + 'LoginToken' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'example' => 'v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"484256DA-D816-44D2-9D86-B6EE4D5B****\\",\\n \\"LoginToken\\": \\"v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****\\"\\n}","type":"json"}]', + 'title' => 'ChangePassword', + 'summary' => 'Changes the password of a user account.', + ], + 'ResetPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '95e41934-383e-4c9f-824f-3b93b19b****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou+dir-899235****', + ], + ], + [ + 'name' => 'EndUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'liming', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address of the user.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'a***@example.edu', + ], + ], + [ + 'name' => 'phone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the user.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1827912****', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2f00ab32-a473-4c90-9aae-dd8842ae****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A00477A5-167F-56D2-A315-EA77E4BD****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A00477A5-167F-56D2-A315-EA77E4BD****\\"\\n}","type":"json"}]', + 'title' => 'ResetPassword', + 'summary' => 'Resets a password.', + ], + 'EncryptPassword' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the client. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1d40776f-e9cb-4e2b-a8da-308d10e8****', + ], + ], + [ + 'name' => 'DirectoryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The directory ID.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cn-beijing+dir-131196****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-beijing+dir-131196****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'c78e2e52-23d9-4401-a648-e67ac6ff****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v1b16dcff3ab21a6c5ec01652238375511cff5a1db59fd4dc49afb37e2ea7a626af6f38109fd0498b6abd9de1af7743****', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that you want to encrypt.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Ab123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'EncryptedPassword' => [ + 'description' => 'The encrypted password.'."\n", + 'type' => 'string', + 'example' => 'd34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'AF538DA8-FFC6-52DA-8FF8-7B92579F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"EncryptedPassword\\": \\"d34601bc-e6b1-4433-b0cc-8f6c5e52;n4apvGub3OBoj4Grwg==;thhO4UEomJfdvwnwlA==\\",\\n \\"RequestId\\": \\"AF538DA8-FFC6-52DA-8FF8-7B92579F****\\"\\n}","type":"json"}]', + 'title' => 'EncryptPassword', + 'summary' => 'Encrypts a password.', + ], + 'DescribeFingerPrintTemplates' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '61e39dc6-0450-45f6-a372-2a09e938****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'a5062d68-e550-4d09-8288-67c8ba9e****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v189646d6f329e4dfcbf51653542202890570fec26e4f9ee26427c5920fcd93871f017d2190199c4c7d0c0bf00f573****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9C1D3FBE-84E1-5ABB-AD98-2003AC71****', + ], + 'FingerPrintTemplates' => [ + 'description' => 'The fingerprint templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The fingerprint template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The index.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CreationTime' => [ + 'description' => 'The time when the template was created.'."\n", + 'type' => 'string', + 'example' => '2022-03-13T13:26:29Z', + ], + 'LoginTime' => [ + 'description' => 'The logon time.'."\n", + 'type' => 'string', + 'example' => '2022-03-13T13:26:29Z', + ], + 'EndUserId' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => 'liming', + ], + 'Description' => [ + 'description' => 'The description of the template.'."\n", + 'type' => 'string', + 'example' => 'Finger 1', + ], + 'OfficeSiteId' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-074949****', + ], + 'ClientId' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'example' => '2258a3d5-b8f8-4d79-a221-eaecf211****', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C1D3FBE-84E1-5ABB-AD98-2003AC71****\\",\\n \\"FingerPrintTemplates\\": [\\n {\\n \\"Index\\": 1,\\n \\"CreationTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"LoginTime\\": \\"2022-03-13T13:26:29Z\\",\\n \\"EndUserId\\": \\"alice\\",\\n \\"Description\\": \\"Finger 1\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-074949****\\",\\n \\"ClientId\\": \\"2258a3d5-b8f8-4d79-a221-eaecf211****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeFingerPrintTemplates', + 'summary' => 'Queries fingerprint templates.', + ], + 'SetFingerPrintTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '347431a9-90f6-448e-82c4-42bc84a9****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '8b42538a-246e-45a1-95ea-e5c65b09****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon credentials.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v11c73e7af0cb43ff39301651142485099ffb447085d76c4147519dbaa21c3bd90d53045e327c1f525ee6331c52556****', + ], + ], + [ + 'name' => 'FingerPrintTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fingerprint template.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'goG3gG8AAABhujtscn', + ], + ], + [ + 'name' => 'EncryptedFingerPrintTemplate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encrypted fingerprint template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAAAAAAAAAA', + ], + ], + [ + 'name' => 'EncryptedKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The encryption key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'drjfspchj', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password that you want to encrypt.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'As53328794', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the node.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'testDescription', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token to ensure the idempotency of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123e4567-e89b-12d3-a456-42665544****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Index' => [ + 'description' => 'The index.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CDE666EA-4FCD-5024-895C-8698E3D3****', + ], + 'EncryptedPassword' => [ + 'description' => 'The encrypted password.'."\n", + 'type' => 'string', + 'example' => '0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Index\\": 1,\\n \\"RequestId\\": \\"CDE666EA-4FCD-5024-895C-8698E3D3****\\",\\n \\"EncryptedPassword\\": \\"0711abb9-4cf8-41b2-9d0e-b51209468631;da4VFPNxwY3CZegFjOrCNw==;iHp2l9/qGcfD4tWx7jZIZQ==\\"\\n}","type":"json"}]', + 'title' => 'SetFingerPrintTemplate', + ], + 'SetFingerPrintTemplateDescription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0764064c-1609-4d3c-8cb7-ab8d3feg****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'd28520d4-da0b-4a97-981d-683db865****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v14e5a2404c495249f7541646535779667ea0b5d87754b5d2d2a3099bda774f3832e24756ef3e66eb574b1f3e99078****', + ], + ], + [ + 'name' => 'Index', + 'in' => 'query', + 'schema' => [ + 'description' => 'The index.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Finger 1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '40401e62-5caf-4508-8de7-bf98af12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BBD7DFD1-A5DE-51D9-8FD6-3BF54EF4****\\"\\n}","type":"json"}]', + 'title' => 'SetFingerPrintTemplateDescription', + ], + 'DeleteFingerPrintTemplate' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '59e86b39-ccac-4dfa-93d7-1f724052****', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The session ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '6df06330-3b75-4768-b334-41a73a64****', + ], + ], + [ + 'name' => 'LoginToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The logon token.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'v1c0436c721786529914f16516396228454fa6284c9b80f9917f25ebbec2aa30c10343e3f6f9aff64500ce13808aef****', + ], + ], + [ + 'name' => 'Index', + 'in' => 'query', + 'schema' => [ + 'description' => 'The index.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '4', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client token to ensure the idempotence of the request. You can use the client to generate the value, but you ensure sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '40401e62-5caf-4508-8de7-bf98af12****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '134BD0B2-B848-5743-9CE2-C1FD3D5F****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"134BD0B2-B848-5743-9CE2-C1FD3D5F****\\"\\n}","type":"json"}]', + 'title' => 'DeleteFingerPrintTemplate', + ], + 'IsKeepAlive' => [ + 'summary' => 'Verifies whether the client\'s logon session is still active.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID. The system generates a unique ID for each client.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'f4a0dc8e-1702-4728-9a60-95b27a35****', + ], + ], + [ + 'name' => 'OfficeSiteId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou+dir-885351****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. You can call the [DescribeRegions](~~196646~~) operation to query the list of regions where Elastic Desktop Service (EDS) Enterprise is available.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1CBAFFAB-B697-4049-A9B1-67E1FC5F****'."\n", + ], + 'OfficeSiteId' => [ + 'description' => 'The office network ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou+dir-885351****'."\n", + ], + 'TenantId' => [ + 'description' => 'The unique ID (UID) of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '141631846826****', + ], + 'IsKeepAlive' => [ + 'description' => 'Identifies whether the user should remain logged on to the client.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + 'description' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1CBAFFAB-B697-4049-A9B1-67E1FC5F****\\\\n\\",\\n \\"OfficeSiteId\\": \\"cn-hangzhou+dir-885351****\\\\n\\",\\n \\"TenantId\\": \\"141631846826****\\",\\n \\"IsKeepAlive\\": true\\n}","type":"json"}]', + 'title' => 'IsKeepAlive', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'ecd.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'ecd.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'ecd.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'ecd.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'ecd.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'ecd.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'ecd.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'ecd.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'ecd.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'ecd.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'ecd.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'ecd.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'ecd.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'ecd.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'ecd.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'ecd.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'ecd.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'ecd.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'ecd.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'ecd.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'ecd.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'ecd.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'ecd.me-east-1.aliyuncs.com', + ], + ], +]; |